openstack/kolla-ansible
Code Issues Proposed changes

docs: Parameterize kolla-ansible version and branch

Browse Source 
Implement simple global variables system in docs and add global variables
KOLLA_OPENSTACK_RELEASE, KOLLA_ANSIBLE_MAJOR_VERSION  and
KOLLA_BRANCH_NAME.

Closes-Bug: #1844710
Change-Id: I2c131463eaf1c51eb8768f6d90e9697c77a7833b
Signed-off-by: Adrian Andreias <adrian@fleio.com>
This commit is contained in:
Adrian Andreias
2021-10-21 20:40:44 +03:00
parent 0ef7c6ed1c
commit 28b3b83cb2
2 changed files with 41 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -149,19 +149,23 @@ Install Kolla-ansible
Install Kolla-ansible for deployment or evaluation
--------------------------------------------------
For a list of ``kolla-ansible`` versions compatible with each OpenStack release
see `Kolla Ansible release notes
<https://docs.openstack.org/releasenotes/kolla-ansible/>`__.
#. Install kolla-ansible and its dependencies using ``pip``.
If using a virtual environment:
.. code-block:: console
pip install kolla-ansible
pip install 'kolla-ansible == |KOLLA_ANSIBLE_MAJOR_VERSION|.*'
If not using a virtual environment:
.. code-block:: console
sudo pip3 install kolla-ansible
sudo pip3 install 'kolla-ansible == |KOLLA_ANSIBLE_MAJOR_VERSION|.*'
#. Create the ``/etc/kolla`` directory.
@@ -206,8 +210,8 @@ Install Kolla for development
.. code-block:: console
git clone https://github.com/openstack/kolla
git clone https://github.com/openstack/kolla-ansible
git clone --branch |KOLLA_BRANCH_NAME| https://opendev.org/openstack/kolla
git clone --branch |KOLLA_BRANCH_NAME| https://opendev.org/openstack/kolla-ansible
#. Install requirements of ``kolla`` and ``kolla-ansible``: