aboutsummaryrefslogtreecommitdiff
path: root/doc/source/user
diff options
context:
space:
mode:
authorJakub Darmach <jakub@stackhpc.com>2024-12-18 13:27:07 +0100
committerJakub Darmach <jakub@stackhpc.com>2024-12-18 14:31:42 +0100
commit198da94fe094b2b0d90d47c2b42e68a7ffc33c3e (patch)
treecb8feb0960a72c80004c60e0dea4db53764c89fc /doc/source/user
parentcd2a09029b75399d4ef9e08f3b8be4e06c3e4488 (diff)
downloadkolla-ansible-198da94fe094b2b0d90d47c2b42e68a7ffc33c3e.tar.gz
kolla-ansible-198da94fe094b2b0d90d47c2b42e68a7ffc33c3e.zip
Docs update - kolla-ansible cli parameters
With rewrite of kolla-ansible CLI to Python in I9749b320d4f5eeec601a055b597dfa7d8fb97ce2 the order of parameters have to be: `kolla-ansible <action> <arguments>` Change-Id: I1bd4a7f96f77c34fb46ca21f37023dddf73e8f05 Closes-bug: 2087920
Diffstat (limited to 'doc/source/user')
-rw-r--r--doc/source/user/adding-and-removing-hosts.rst18
-rw-r--r--doc/source/user/operating-kolla.rst28
-rw-r--r--doc/source/user/quickstart-development.rst6
-rw-r--r--doc/source/user/quickstart.rst6
4 files changed, 29 insertions, 29 deletions
diff --git a/doc/source/user/adding-and-removing-hosts.rst b/doc/source/user/adding-and-removing-hosts.rst
index 524e3ead3..55dc8c7af 100644
--- a/doc/source/user/adding-and-removing-hosts.rst
+++ b/doc/source/user/adding-and-removing-hosts.rst
@@ -30,21 +30,21 @@ with running ``bootstrap-servers`` on an existing system.
.. code-block:: console
- kolla-ansible -i <inventory> bootstrap-servers [ --limit <limit> ]
+ kolla-ansible bootstrap-servers -i <inventory> [ --limit <limit> ]
Pull down container images to the new hosts. The ``--limit`` argument may be
used and only needs to include the new hosts.
.. code-block:: console
- kolla-ansible -i <inventory> pull [ --limit <limit> ]
+ kolla-ansible pull -i <inventory> [ --limit <limit> ]
Deploy containers to the new hosts. If using a ``--limit`` argument, ensure
that all controllers are included, e.g. via ``--limit control``.
.. code-block:: console
- kolla-ansible -i <inventory> deploy [ --limit <limit> ]
+ kolla-ansible deploy -i <inventory> [ --limit <limit> ]
The new controllers are now deployed. It is recommended to perform testing
of the control plane at this point to verify that the new controllers are
@@ -69,21 +69,21 @@ an existing system.
.. code-block:: console
- kolla-ansible -i <inventory> bootstrap-servers [ --limit <limit> ]
+ kolla-ansible bootstrap-servers -i <inventory> [ --limit <limit> ]
Pull down container images to the new hosts. The ``--limit`` argument may be
used and only needs to include the new hosts.
.. code-block:: console
- kolla-ansible -i <inventory> pull [ --limit <limit> ]
+ kolla-ansible pull -i <inventory> [ --limit <limit> ]
Deploy containers on the new hosts. The ``--limit`` argument may be used and
only needs to include the new hosts.
.. code-block:: console
- kolla-ansible -i <inventory> deploy [ --limit <limit> ]
+ kolla-ansible deploy -i <inventory> [ --limit <limit> ]
The new compute nodes are now deployed. It is recommended to perform
testing of the compute nodes at this point to verify that they are functioning
@@ -145,7 +145,7 @@ Stop all services running on the hosts being removed:
.. code-block:: console
- kolla-ansible -i <inventory> stop --yes-i-really-really-mean-it [ --limit <limit> ]
+ kolla-ansible stop -i <inventory> --yes-i-really-really-mean-it [ --limit <limit> ]
Remove the hosts from the Ansible inventory.
@@ -154,7 +154,7 @@ as MariaDB and RabbitMQ. Use a suitable limit, such as ``--limit control``.
.. code-block:: console
- kolla-ansible -i <inventory> deploy [ --limit <limit> ]
+ kolla-ansible deploy -i <inventory> [ --limit <limit> ]
Perform testing to verify that the remaining cluster hosts are operating
correctly.
@@ -212,7 +212,7 @@ Stop all services running on the hosts being removed:
.. code-block:: console
- kolla-ansible -i <inventory> stop --yes-i-really-really-mean-it [ --limit <limit> ]
+ kolla-ansible stop -i <inventory> --yes-i-really-really-mean-it [ --limit <limit> ]
Remove the hosts from the Ansible inventory.
diff --git a/doc/source/user/operating-kolla.rst b/doc/source/user/operating-kolla.rst
index a54d21eef..4d7a7dc14 100644
--- a/doc/source/user/operating-kolla.rst
+++ b/doc/source/user/operating-kolla.rst
@@ -224,48 +224,48 @@ Kolla Ansible CLI
When running the ``kolla-ansible`` CLI, additional arguments may be passed to
``ansible-playbook`` via the ``EXTRA_OPTS`` environment variable.
-``kolla-ansible -i INVENTORY deploy`` is used to deploy and start all Kolla
+``kolla-ansible deploy -i INVENTORY`` is used to deploy and start all Kolla
containers.
-``kolla-ansible -i INVENTORY destroy`` is used to clean up containers and
+``kolla-ansible destroy -i INVENTORY`` is used to clean up containers and
volumes in the cluster.
-``kolla-ansible -i INVENTORY mariadb_recovery`` is used to recover a
+``kolla-ansible mariadb_recovery -i INVENTORY`` is used to recover a
completely stopped mariadb cluster.
-``kolla-ansible -i INVENTORY prechecks`` is used to check if all requirements
+``kolla-ansible rechecks -i INVENTORY`` is used to check if all requirements
are meet before deploy for each of the OpenStack services.
-``kolla-ansible -i INVENTORY post-deploy`` is used to do post deploy on deploy
+``kolla-ansible post-deploy -i INVENTORY`` is used to do post deploy on deploy
node to get the admin openrc file.
-``kolla-ansible -i INVENTORY pull`` is used to pull all images for containers.
+``kolla-ansible pull -i INVENTORY`` is used to pull all images for containers.
-``kolla-ansible -i INVENTORY reconfigure`` is used to reconfigure OpenStack
+``kolla-ansible reconfigure -i INVENTORY`` is used to reconfigure OpenStack
service.
-``kolla-ansible -i INVENTORY upgrade`` is used to upgrades existing OpenStack
+``kolla-ansible upgrade -i INVENTORY`` is used to upgrades existing OpenStack
Environment.
-``kolla-ansible -i INVENTORY stop`` is used to stop running containers.
+``kolla-ansible stop -i INVENTORY`` is used to stop running containers.
-``kolla-ansible -i INVENTORY deploy-containers`` is used to check and if
+``kolla-ansible deploy-containers -i INVENTORY`` is used to check and if
necessary update containers, without generating configuration.
-``kolla-ansible -i INVENTORY prune-images`` is used to prune orphaned Docker
+``kolla-ansible prune-images -i INVENTORY`` is used to prune orphaned Docker
images on hosts.
-``kolla-ansible -i INVENTORY genconfig`` is used to generate configuration
+``kolla-ansible genconfig -i INVENTORY`` is used to generate configuration
files for enabled OpenStack services, without then restarting the containers so
it is not applied right away.
-``kolla-ansible -i INVENTORY1 -i INVENTORY2 ...`` Multiple inventories can be
+``kolla-ansible ... -i INVENTORY1 -i INVENTORY2`` Multiple inventories can be
specified by passing the ``--inventory`` or ``-i`` command line option multiple
times. This can be useful to share configuration between multiple environments.
Any common configuration can be set in ``INVENTORY1`` and ``INVENTORY2`` can be
used to set environment specific details.
-``kolla-ansible -i INVENTORY gather-facts`` is used to gather Ansible facts,
+``kolla-ansible gather-facts -i INVENTORY`` is used to gather Ansible facts,
for example to populate a fact cache.
Using Hashicorp Vault for password storage
diff --git a/doc/source/user/quickstart-development.rst b/doc/source/user/quickstart-development.rst
index e769ecbb5..795404415 100644
--- a/doc/source/user/quickstart-development.rst
+++ b/doc/source/user/quickstart-development.rst
@@ -301,19 +301,19 @@ accordingly.
.. code-block:: console
cd kolla-ansible/tools
- ./kolla-ansible -i ../../all-in-one bootstrap-servers
+ ./kolla-ansible bootstrap-servers -i ../../all-in-one
#. Do pre-deployment checks for hosts:
.. code-block:: console
- kolla-ansible -i ../../all-in-one prechecks
+ kolla-ansible prechecks -i ../../all-in-one
#. Finally proceed to actual OpenStack deployment:
.. code-block:: console
- kolla-ansible -i ../../all-in-one deploy
+ kolla-ansible deploy -i ../../all-in-one
When this playbook finishes, OpenStack should be up, running and functional!
If error occurs during execution, refer to
diff --git a/doc/source/user/quickstart.rst b/doc/source/user/quickstart.rst
index 513f495c4..462b9f002 100644
--- a/doc/source/user/quickstart.rst
+++ b/doc/source/user/quickstart.rst
@@ -290,19 +290,19 @@ accordingly.
.. code-block:: console
- kolla-ansible -i ./all-in-one bootstrap-servers
+ kolla-ansible bootstrap-servers -i ./all-in-one
#. Do pre-deployment checks for hosts:
.. code-block:: console
- kolla-ansible -i ./all-in-one prechecks
+ kolla-ansible prechecks -i ./all-in-one
#. Finally proceed to actual OpenStack deployment:
.. code-block:: console
- kolla-ansible -i ./all-in-one deploy
+ kolla-ansible deploy -i ./all-in-one
When this playbook finishes, OpenStack should be up, running and functional!
If error occurs during execution, refer to