Merge "Fix: Update outdated documentation"

5 files changed, 26 insertions, 23 deletions

diff --git a/doc/source/user/multi-regions.rst b/doc/source/user/multi-regions.rst
index 50040962c..8d4c4043a 100644
--- a/doc/source/user/multi-regions.rst
+++ b/doc/source/user/multi-regions.rst
@@ -29,8 +29,8 @@ Keystone and Horizon are enabled:
 
 .. code-block:: console
 
-   enable_keystone: "yes"
-   enable_horizon: "yes"
+   enable_keystone: true
+   enable_horizon: true
 
 Then, change the value of ``multiple_regions_names`` to add names of other
 regions. In this example, we consider two regions. The current one,
@@ -143,7 +143,7 @@ unnecessary in this region and run ``kolla-ansible``:
 
 .. code-block:: yaml
 
-   enable_keystone: "no"
-   enable_horizon: "no"
+   enable_keystone: false
+   enable_horizon: false
 
 The configuration is the same for any other region.
diff --git a/doc/source/user/operating-kolla.rst b/doc/source/user/operating-kolla.rst
index 8e931997d..44e3ddd88 100644
--- a/doc/source/user/operating-kolla.rst
+++ b/doc/source/user/operating-kolla.rst
@@ -43,7 +43,7 @@ Upgrade procedure
 
 .. note::
 
-   If you have set ``enable_cells`` to ``yes`` then you should read the
+   If you have set ``enable_cells`` to ``true`` then you should read the
    upgrade notes in the :ref:`Nova cells guide<nova-cells-upgrade>`.
 
 Kolla's strategy for upgrades is to never make a mess and to follow consistent
@@ -111,8 +111,7 @@ If performing a skip-level (SLURP) upgrade, update ``ansible`` or
 
    pip3 install --upgrade 'ansible-core>=|ANSIBLE_CORE_VERSION_MIN|,<|ANSIBLE_CORE_VERSION_MAX|.99'
 
-If upgrading to a Yoga release or later, install or upgrade Ansible Galaxy
-dependencies:
+Install or upgrade Ansible Galaxy dependencies:
 
 .. code-block:: console
 
@@ -150,7 +149,7 @@ For example:
 .. code-block:: console
 
    cp /etc/kolla/passwords.yml passwords.yml.old
-   cp kolla-ansible/etc/kolla/passwords.yml passwords.yml.new
+   cp /path/to/venv/share/kolla-ansible/etc/kolla/passwords.yml passwords.yml.new
    kolla-genpwd -p passwords.yml.new
    kolla-mergepwd --old passwords.yml.old --new passwords.yml.new --final /etc/kolla/passwords.yml
 
@@ -316,6 +315,8 @@ Tools
 -----
 
 Kolla ships with several utilities intended to facilitate ease of operation.
+If you installed Kolla Ansible in a virtual environment, these scripts are
+located in ``/path/to/venv/share/kolla-ansible/tools/``.
 
 ``tools/cleanup-containers`` is used to remove deployed containers from the
 system. This can be useful when you want to do a new clean deployment. It will
diff --git a/doc/source/user/quickstart-development.rst b/doc/source/user/quickstart-development.rst
index 6e29a2ad5..f61e972cc 100644
--- a/doc/source/user/quickstart-development.rst
+++ b/doc/source/user/quickstart-development.rst
@@ -98,7 +98,7 @@ Install Kolla-ansible
 
       git clone --branch |KOLLA_BRANCH_NAME| https://opendev.org/openstack/kolla-ansible
 
-#. Install requirements of ``kolla`` and ``kolla-ansible``:
+#. Install ``kolla-ansible`` and its dependencies:
 
    .. code-block:: console
 
@@ -160,8 +160,7 @@ manually or by running random password generator:
 
 .. code-block:: console
 
-   cd kolla-ansible/tools
-   ./generate_passwords.py
+   kolla-genpwd
 
 Kolla globals.yml
 -----------------
@@ -244,7 +243,7 @@ There are a few options that are required to deploy Kolla Ansible:
 
   By default Kolla Ansible provides a bare compute kit, however it does provide
   support for a vast selection of additional services. To enable them, set
-  ``enable_*`` to "yes".
+  ``enable_*`` to ``true``.
 
   Kolla now supports many OpenStack services, there is
   `a list of available services
@@ -283,27 +282,28 @@ need to setup basic host-level dependencies, like docker.
 Kolla Ansible provides a playbook that will install all required services in
 the correct versions.
 
-The following assumes the use of the ``all-in-one`` inventory. If using a
-different inventory, such as ``multinode``, replace the ``-i`` argument
-accordingly.
+The following assumes the use of the ``all-in-one`` inventory in your
+current directory.
+If using a different inventory, such as ``multinode``, replace the ``-i``
+argument accordingly.
 
 #. Bootstrap servers with kolla deploy dependencies:
 
   .. code-block:: console
 
-     kolla-ansible bootstrap-servers -i ../all-in-one
+     kolla-ansible bootstrap-servers -i all-in-one
 
 #. Do pre-deployment checks for hosts:
 
   .. code-block:: console
 
-     kolla-ansible prechecks -i ../all-in-one
+     kolla-ansible prechecks -i all-in-one
 
 #. Finally proceed to actual OpenStack deployment:
 
   .. code-block:: console
 
-     kolla-ansible deploy -i ../all-in-one
+     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 f02401fc2..f2978b95a 100644
--- a/doc/source/user/quickstart.rst
+++ b/doc/source/user/quickstart.rst
@@ -235,11 +235,11 @@ There are a few options that are required to deploy Kolla Ansible:
 
   By default Kolla Ansible provides a bare compute kit, however it does provide
   support for a vast selection of additional services. To enable them, set
-  ``enable_*`` to "yes".
+  ``enable_*`` to ``true``.
 
   Kolla now supports many OpenStack services, there is
   `a list of available services
-  <https://github.com/openstack/kolla-ansible/blob/master/README.rst#openstack-services>`_.
+  <https://opendev.org/openstack/kolla-ansible/src/branch/|KOLLA_BRANCH_NAME|/README.rst#openstack-services>`_.
   For more information about service configuration, Please refer to the
   :kolla-ansible-doc:`Services Reference Guide <reference/index.html>`.
 
diff --git a/doc/source/user/troubleshooting.rst b/doc/source/user/troubleshooting.rst
index 76a9ac604..289b89220 100644
--- a/doc/source/user/troubleshooting.rst
+++ b/doc/source/user/troubleshooting.rst
@@ -48,7 +48,7 @@ Debugging Kolla
 ~~~~~~~~~~~~~~~
 
 The status of containers after deployment can be determined on the deployment
-targets by executing:
+targets by executing (use `podman` instead of `docker` if applicable):
 
 .. code-block:: console
 
@@ -76,8 +76,10 @@ If the stdout logs are needed, please run:
 Note that most of the containers don't log to stdout so the above command will
 provide no information.
 
-To learn more about Docker command line operation please refer to `Docker
-documentation <https://docs.docker.com/reference/>`__.
+To learn more about container engine command line operation, please refer
+to the `Docker
+documentation <https://docs.docker.com/reference/>`__ or the `Podman
+documentation <https://docs.podman.io/en/stable/Commands.html>`__.
 
 The log volume "kolla_logs" is linked to ``/var/log/kolla`` on the host.
 You can find all kolla logs in there.