openstack/kolla-ansible
Code Issues Proposed changes

Docs update - kolla-ansible cli parameters

Browse Source 
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
This commit is contained in:
Jakub Darmach 2024-12-18 13:27:07 +01:00
parent cd2a09029b
commit 198da94fe0
No known key found for this signature in database
GPG Key ID: A234FE88F409DEE5
9 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/admin/mariadb-backup-and-restore.rst
View File

@ -31,7 +31,7 @@ Firstly, enable backups via ``globals.yml``:
Then, kick off a reconfiguration of MariaDB:
``kolla-ansible -i INVENTORY reconfigure -t mariadb``
``kolla-ansible reconfigure -i INVENTORY -t mariadb``
Once that has run successfully, you should then be able to take full and
incremental backups as described below.
@ -41,11 +41,11 @@ Backup Procedure
To perform a full backup, run the following command:
``kolla-ansible -i INVENTORY mariadb_backup``
``kolla-ansible mariadb_backup -i INVENTORY``
Or to perform an incremental backup:
``kolla-ansible -i INVENTORY mariadb_backup --incremental``
``kolla-ansible mariadb_backup -i INVENTORY --incremental``
Kolla doesn't currently manage the scheduling of these backups, so you'll
need to configure an appropriate scheduler (i.e cron) to run these commands
@ -96,7 +96,7 @@ Stop the MariaDB instance on all nodes:
.. code-block:: console
kolla-ansible -i multinode stop -t mariadb --yes-i-really-really-mean-it
kolla-ansible stop -i multinode -t mariadb --yes-i-really-really-mean-it
Delete the old data files (or move them elsewhere), and copy the backup into
place, again on the first node:
@ -127,7 +127,7 @@ pointing to the first node of the cluster:
.. code-block:: console
kolla-ansible -i multinode mariadb_recovery -e mariadb_recover_inventory_name=controller1
kolla-ansible mariadb_recovery -i multinode -e mariadb_recover_inventory_name=controller1
The above procedure is valid also for a disaster recovery scenario. In such
case, first copy MariaDB backup file from the external source into

4
doc/source/admin/password-rotation.rst
View File

@ -237,7 +237,7 @@ RabbitMQ containers and volumes. Because the RabbitMQ containers are destroyed,
.. code-block:: bash
kolla-ansible -i inventory stop
kolla-ansible stop -i inventory
#. On each node running RabbitMQ, destroy its containers and volumes:
@ -251,7 +251,7 @@ RabbitMQ containers and volumes. Because the RabbitMQ containers are destroyed,
.. code-block:: bash
kolla-ansible -i inventory deploy
kolla-ansible deploy -i inventory
Post-redeploy changes
^^^^^^^^^^^^^^^^^^^^^

4
doc/source/admin/tls.rst
View File

@ -72,7 +72,7 @@ using the ``multinode`` inventory:
.. code-block:: console
kolla-ansible -i ~/multinode certificates
kolla-ansible certificates -i ~/multinode
TLS Configuration for internal/external VIP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -352,7 +352,7 @@ configuration file and the inventory file:
.. code-block:: console
kolla-ansible -i multinode certificates
kolla-ansible certificates -i multinode
The ``certificates`` role performs the following actions:

2
doc/source/reference/containers/magnum-guide.rst
View File

@ -56,4 +56,4 @@ To deploy magnum and its dashboard in an existing OpenStack cluster:
.. code-block:: console
kolla-ansible -i <inventory> deploy --tags common,horizon,magnum
kolla-ansible deploy -i <inventory> --tags common,horizon,magnum

4
doc/source/reference/networking/octavia.rst
View File

@ -225,7 +225,7 @@ Deploy Octavia with Kolla Ansible:
.. code-block:: console
kolla-ansible -i <inventory> deploy --tags common,horizon,octavia
kolla-ansible deploy -i <inventory> --tags common,horizon,octavia
Once the installation is completed, you need to :ref:`register an amphora image
in glance <octavia-amphora-image>`.
@ -333,7 +333,7 @@ Now deploy Octavia:
.. code-block:: console
kolla-ansible -i <inventory> deploy --tags common,horizon,octavia
kolla-ansible deploy -i <inventory> --tags common,horizon,octavia
.. _octavia-amphora-image:

18
doc/source/user/adding-and-removing-hosts.rst
View File

@ -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.

28
doc/source/user/operating-kolla.rst
View File

@ -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

6
doc/source/user/quickstart-development.rst
View File

@ -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

6
doc/source/user/quickstart.rst
View File

@ -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