From 649abef5a4a9a3a1975a65ff558f681ff3243f26 Mon Sep 17 00:00:00 2001 From: Marek Buch Date: Tue, 29 Apr 2025 08:53:14 +0000 Subject: 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 --- doc/source/user/operating-kolla.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'doc') 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 ~~~~~~~~~~~~~~~ -- cgit v1.2.3