[docs] how to perform updates

This commit is contained in:
gardlt 2017-07-19 10:28:38 -05:00 committed by Alexis Rivera DeLa Torre
parent 684f533eab
commit d187c839ab
6 changed files with 104 additions and 4 deletions

View File

@ -0,0 +1,33 @@
Armada - Apply
==============
Commands
--------
.. code:: bash
Usage: armada apply FILE
Options:
[-h] [--dry-run] [--debug-logging] [--disable-update-pre]
[--disable-update-post] [--enable-chart-cleanup] [--wait]
[--timeout TIMEOUT]
Synopsis
--------
The apply command will consume an armada manifest which contains group of charts
that it will deploy into the tiller service in your kubernetes cluster.
Executing the ``armada apply`` again on existing armada deployement will start
an update of the armada deployed charts.
``amada apply armada-manifest.yaml [--debug-logging]``
If you remove ``armada/Charts/v1`` from the ``armada/ChartGroups/v1`` in the armada
manifest and exectute an ``armada apply`` with the ``--enable-chart-cleanup`` flag.
Armada will remove undefiend releases with the armada manifest's
``release_prefix`` keyword.

View File

@ -0,0 +1,15 @@
.. Armada documentation master file, created by
sphinx-quickstart on Wed May 3 10:39:15 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Developers Guide
================
.. toctree::
:maxdepth: 2
:caption: Contents:
apply.rst
validate.rst
tiller.rst

View File

@ -0,0 +1,21 @@
Armada - Tiller
==============+
Commands
--------
.. code:: bash
Usage: armada tiller
Options:
[-h] [--status] [--releases]
Synopsis
--------
The tiller command will perform command directly with tiller to check if tiller
in the cluster is running and the list of releases in tiller cluster.

View File

@ -0,0 +1,20 @@
Armada - Validate
=================
Commands
--------
.. code:: bash
Usage: armada validate FILE
Options:
[-h]
Synopsis
--------
The validate commad will take in a armada manifest and will validate if its
correctly defined and comsumable.

View File

@ -13,6 +13,7 @@ Welcome to Armada's documentation!
readme
development/index
operations/index
commands/index

View File

@ -17,6 +17,12 @@ Armada.yaml `here <guide-build-armada-yaml.rst>`_
Usage
-----
.. note::
The apply command performs two main actions: installing and updating define
charts in the armada manifest
1. Pull or Build the Armada Docker Images:
.. code:: bash
@ -53,20 +59,24 @@ Usage
.. code:: bash
docker exec -it armada armada tiller --status
docker exec armada armada tiller --status
4. If tiller is up then we can start deploying our armada yamls
.. code:: bash
docker exec -it armada armada apply /examples/openstack-helm.yaml [ --debug-logging ]
docker exec armada armada apply /examples/openstack-helm.yaml [ --debug-logging ]
5. To upgrade charts just modify the armada yaml or chart code and re-run ``armada
5. Upgrading charts: modify the armada yaml or chart source code and run ``armada
apply`` above
.. code:: bash
docker exec armada armada apply /examples/openstack-helm.yaml [ --debug-logging ]
6. To check deployed releases:
.. code:: bash
docker exec -it armada armada tiller --releases
docker exec armada armada tiller --releases