diff --git a/docs/source/commands/apply.rst b/docs/source/commands/apply.rst new file mode 100644 index 00000000..ab6accd4 --- /dev/null +++ b/docs/source/commands/apply.rst @@ -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. diff --git a/docs/source/commands/index.rst b/docs/source/commands/index.rst new file mode 100644 index 00000000..29dc940e --- /dev/null +++ b/docs/source/commands/index.rst @@ -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 diff --git a/docs/source/commands/tiller.rst b/docs/source/commands/tiller.rst new file mode 100644 index 00000000..5e79cfd3 --- /dev/null +++ b/docs/source/commands/tiller.rst @@ -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. diff --git a/docs/source/commands/validate.rst b/docs/source/commands/validate.rst new file mode 100644 index 00000000..74c51ea4 --- /dev/null +++ b/docs/source/commands/validate.rst @@ -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. diff --git a/docs/source/index.rst b/docs/source/index.rst index 3bc615ea..9400ba78 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,6 +13,7 @@ Welcome to Armada's documentation! readme development/index operations/index + commands/index diff --git a/docs/source/operations/guide-use-armada.rst b/docs/source/operations/guide-use-armada.rst index 73fc16ee..6b3dc0f0 100644 --- a/docs/source/operations/guide-use-armada.rst +++ b/docs/source/operations/guide-use-armada.rst @@ -17,6 +17,12 @@ Armada.yaml `here `_ 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