aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarek Buch <marek.buch@tietoevry.com>2025-04-29 08:53:14 +0000
committerMarek Buch <marek.buch@tietoevry.com>2025-05-16 07:59:37 +0000
commit649abef5a4a9a3a1975a65ff558f681ff3243f26 (patch)
tree6e7814ec51237adf7b2f48ef37786356c1470af2 /doc
parentdcafed414532c88b776ebe57743c84e57e330d39 (diff)
downloadkolla-ansible-649abef5a4a9a3a1975a65ff558f681ff3243f26.tar.gz
kolla-ansible-649abef5a4a9a3a1975a65ff558f681ff3243f26.zip
Add documentation for Kolla Ansible CLI command completion
This change adds instructions to the documentation on how to enable shell command completion for the kolla-ansible CLI. It covers all necessary steps. Change-Id: I5cacf29d2fb9c0b473cf858f1c050bc70890cc42 Signed-off-by: Marek Buch <marek.buch@tietoevry.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/source/user/operating-kolla.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/source/user/operating-kolla.rst b/doc/source/user/operating-kolla.rst
index 32973ba4e..04668a68a 100644
--- a/doc/source/user/operating-kolla.rst
+++ b/doc/source/user/operating-kolla.rst
@@ -198,6 +198,36 @@ After this command is complete, the containers will have been recreated from
the new images and all database schema upgrades and similar actions performed
for you.
+
+CLI Command Completion
+~~~~~~~~~~~~~~~~~~~~~~
+
+Kolla Ansible supports shell command completion to make the CLI easier to use.
+
+To enable Bash completion, generate the completion script:
+
+.. code-block:: console
+
+ kolla-ansible complete --shell bash > ~/.kolla_ansible_completion.sh
+
+Then, add the following line to your ``~/.bashrc`` file:
+
+.. code-block:: console
+
+ source ~/.kolla_ansible_completion.sh
+
+Finally, reload your shell configuration:
+
+.. code-block:: console
+
+ source ~/.bashrc
+
+.. note::
+
+ If you're using a shell other than Bash, replace ``--shell bash`` with your shell type,
+ e.g., ``zsh``, and adapt your shell's configuration file accordingly.
+
+
Tips and Tricks
~~~~~~~~~~~~~~~