Quickstart rewrite
- Add the requirements installation step for development - Add step number for some section, to make step more clear - Some format issues fix Change-Id: I78deee5f4ae424eec06876168cbdfdf8d25d6bcc
This commit is contained in:
parent
4c39ea7ecc
commit
e57b4e8c1e
@ -29,8 +29,7 @@ The host machine must satisfy the following minimum requirements:
|
|||||||
Install dependencies
|
Install dependencies
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Make sure the ``pip`` package manager is installed and upgraded to the latest
|
#. Install and upgrad ``pip`` to the latest before proceeding.
|
||||||
before proceeding.
|
|
||||||
|
|
||||||
For CentOS, run:
|
For CentOS, run:
|
||||||
|
|
||||||
@ -52,8 +51,7 @@ For Ubuntu, run:
|
|||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
To build the code with ``pip`` package manager, install the following
|
#. Install the following dependencies:
|
||||||
dependencies:
|
|
||||||
|
|
||||||
For CentOS, run:
|
For CentOS, run:
|
||||||
|
|
||||||
@ -71,18 +69,18 @@ For Ubuntu, run:
|
|||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
Kolla deploys OpenStack using `Ansible <http://www.ansible.com>`__. Install
|
#. Install `Ansible <http://www.ansible.com>`__ from distribution packaging:
|
||||||
Ansible from distribution packaging if the distro packaging has recommended
|
|
||||||
version available.
|
.. note::
|
||||||
|
|
||||||
Some implemented distro versions of Ansible are too old to use distro
|
Some implemented distro versions of Ansible are too old to use distro
|
||||||
packaging. Currently, CentOS and RHEL package Ansible >2.0 which is suitable
|
packaging. Currently, CentOS and RHEL package Ansible >2.0 which is suitable
|
||||||
for use with Kolla. Note that you will need to enable access to the EPEL
|
for use with Kolla. Note that you will need to enable access to the EPEL
|
||||||
repository to install via yum -- to do so, take a look at Fedora's EPEL `docs
|
repository to install via :command:`yum` to do so, take a look at `Fedora's EPEL docs
|
||||||
<https://fedoraproject.org/wiki/EPEL>`__ and `FAQ
|
<https://fedoraproject.org/wiki/EPEL>`__ and `FAQ
|
||||||
<https://fedoraproject.org/wiki/EPEL/FAQ>`__.
|
<https://fedoraproject.org/wiki/EPEL/FAQ>`__.
|
||||||
|
|
||||||
On CentOS or RHEL systems, this can be done using:
|
For CentOS or RHEL, this can be done using:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
@ -90,9 +88,15 @@ On CentOS or RHEL systems, this can be done using:
|
|||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
Many DEB based systems do not meet Kolla's Ansible version requirements. It is
|
For Ubuntu, it can be installed by:
|
||||||
recommended to use pip to install Ansible >2.0. Finally Ansible >2.0 may be
|
|
||||||
installed using:
|
.. code-block:: console
|
||||||
|
|
||||||
|
apt-get install ansible
|
||||||
|
|
||||||
|
.. end
|
||||||
|
|
||||||
|
#. Use ``pip`` to install or upgrade Ansible to latest version:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
@ -104,17 +108,8 @@ installed using:
|
|||||||
|
|
||||||
It is recommended to use virtualenv to install non-system packages.
|
It is recommended to use virtualenv to install non-system packages.
|
||||||
|
|
||||||
If DEB based systems include a version of Ansible that meets Kolla's version
|
#. (optional) Add the following options to ansible configuration file
|
||||||
requirements it can be installed by:
|
``/etc/ansible/ansible.cfg``:
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
apt-get install ansible
|
|
||||||
|
|
||||||
.. end
|
|
||||||
|
|
||||||
It's beneficial to add the following options to ansible
|
|
||||||
configuration file ``/etc/ansible/ansible.cfg``:
|
|
||||||
|
|
||||||
.. path /etc/ansible/ansible.cfg
|
.. path /etc/ansible/ansible.cfg
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
@ -132,7 +127,7 @@ Install Kolla-ansible
|
|||||||
Install Kolla-ansible for deployment or evaluation
|
Install Kolla-ansible for deployment or evaluation
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
|
||||||
Install kolla-ansible and its dependencies using ``pip``.
|
#. Install kolla-ansible and its dependencies using ``pip``.
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
@ -140,7 +135,7 @@ Install kolla-ansible and its dependencies using ``pip``.
|
|||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
Copy ``globals.yml`` and ``passwords.yml`` to ``/etc/kolla`` directory.
|
#. Copy ``globals.yml`` and ``passwords.yml`` to ``/etc/kolla`` directory.
|
||||||
|
|
||||||
For CentOS, run:
|
For CentOS, run:
|
||||||
|
|
||||||
@ -158,7 +153,7 @@ For Ubuntu, run:
|
|||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
Copy the ``all-in-one`` and ``multinode`` inventory files to
|
#. Copy ``all-in-one`` and ``multinode`` inventory files to
|
||||||
the current directory.
|
the current directory.
|
||||||
|
|
||||||
For CentOS, run:
|
For CentOS, run:
|
||||||
@ -180,7 +175,7 @@ For Ubuntu, run:
|
|||||||
Install Kolla for development
|
Install Kolla for development
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
Clone the Kolla and Kolla-Ansible repositories from git.
|
#. Clone ``kolla`` and ``kolla-ansible`` repositories from git.
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
@ -189,18 +184,27 @@ Clone the Kolla and Kolla-Ansible repositories from git.
|
|||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
Kolla-ansible holds the configuration files (``globals.yml`` and
|
#. Install requirements of ``kolla`` and ``kolla-ansible``:
|
||||||
``passwords.yml``) in ``etc/kolla``. Copy the configuration
|
|
||||||
files to ``/etc/kolla`` directory.
|
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
cp -r kolla-ansible/etc/kolla /etc/kolla/
|
pip install -r kolla/requirements.txt
|
||||||
|
pip install -r kolla-ansible/requirements.txt
|
||||||
|
|
||||||
.. end
|
.. end
|
||||||
|
|
||||||
Kolla-ansible holds the inventory files (``all-in-one`` and ``multinode``)
|
#. Copy the configuration files to ``/etc/kolla`` directory.
|
||||||
in ``ansible/inventory``. Copy the inventory files to the current
|
``kolla-ansible`` holds the configuration files ( ``globals.yml`` and
|
||||||
|
``passwords.yml``) in ``etc/kolla``.
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
cp -r kolla-ansible/etc/kolla /etc/kolla
|
||||||
|
|
||||||
|
.. end
|
||||||
|
|
||||||
|
#. Copy the inventory files to the current directory. ``kolla-ansible`` holds
|
||||||
|
inventory files ( ``all-in-one`` and ``multinode``) in the ``ansible/inventory``
|
||||||
directory.
|
directory.
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
@ -223,7 +227,7 @@ files. Difference between them is that the former is ready for deploying
|
|||||||
single node OpenStack on localhost. If you need to use separate host or more
|
single node OpenStack on localhost. If you need to use separate host or more
|
||||||
than one node, edit ``multinode`` inventory:
|
than one node, edit ``multinode`` inventory:
|
||||||
|
|
||||||
Edit the first section of ``multinode`` with connection details of your
|
#. Edit the first section of ``multinode`` with connection details of your
|
||||||
environment, for example:
|
environment, for example:
|
||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
@ -257,7 +261,7 @@ environment, for example:
|
|||||||
To learn more about inventory files, check
|
To learn more about inventory files, check
|
||||||
`Ansible documentation <http://docs.ansible.com/ansible/latest/intro_inventory.html>`_.
|
`Ansible documentation <http://docs.ansible.com/ansible/latest/intro_inventory.html>`_.
|
||||||
|
|
||||||
To confirm that our inventory is correct, run:
|
#. Check whether the configuration of inventory is correct or not, run:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user