aboutsummaryrefslogtreecommitdiff
path: root/doc/source/admin
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/admin
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/admin')
-rw-r--r--doc/source/admin/mariadb-backup-and-restore.rst10
-rw-r--r--doc/source/admin/password-rotation.rst4
-rw-r--r--doc/source/admin/tls.rst4
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/source/admin/mariadb-backup-and-restore.rst b/doc/source/admin/mariadb-backup-and-restore.rst
index 14b69fefd..6ebb73d5b 100644
--- a/doc/source/admin/mariadb-backup-and-restore.rst
+++ b/doc/source/admin/mariadb-backup-and-restore.rst
@@ -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
diff --git a/doc/source/admin/password-rotation.rst b/doc/source/admin/password-rotation.rst
index 0e43c6f88..506709975 100644
--- a/doc/source/admin/password-rotation.rst
+++ b/doc/source/admin/password-rotation.rst
@@ -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
^^^^^^^^^^^^^^^^^^^^^
diff --git a/doc/source/admin/tls.rst b/doc/source/admin/tls.rst
index 5a42d0048..64e12311a 100644
--- a/doc/source/admin/tls.rst
+++ b/doc/source/admin/tls.rst
@@ -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: