Browse Source

[devops guide] Update the fuel-devops version number during install

Closes-Bug: #1656708

Change-Id: I2d591dbfb04f65c401f7a6e7158b69e8d1b44915
Backport: newton mitaka
Olena Logvinova 2 years ago
parent
commit
b78d044544
1 changed files with 41 additions and 40 deletions
  1. 41
    40
      devdocs/devops.rst

+ 41
- 40
devdocs/devops.rst View File

@@ -54,66 +54,67 @@ Before using it, please install the following required dependencies:
54 54
 Devops installation in `virtualenv <http://virtualenv.readthedocs.org/en/latest/virtualenv.html>`_
55 55
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56 56
 
57
-1. Install packages needed for building python eggs
57
+#. Install packages needed for building the Python ``eggs``:
58 58
 
59
-.. code-block:: bash
59
+   .. code-block:: bash
60 60
 
61 61
     sudo apt-get install --yes python-virtualenv libpq-dev libgmp-dev pkg-config
62 62
 
63
-2. In case you are using *Ubuntu 12.04* let's update pip and virtualenv,
64
-   otherwise you can skip this step
63
+#. If you use Ubuntu 12.04, update ``pip`` and ``virtualenv``;
64
+   otherwise, you can skip this step:
65 65
 
66
-.. code-block:: bash
66
+   .. code-block:: bash
67 67
 
68 68
     sudo pip install pip virtualenv --upgrade
69 69
     hash -r
70 70
 
71
-3. In oder to store the path where your Python virtualenv will be located
72
-   create your working directory and use the following environment variable. If
73
-   it is not specified, it will use the current working directory:
71
+#. To store the path where your Python virtualenv will be located,
72
+   create your working directory and use the following environment variable.
73
+   If not specified, it will use the current working directory:
74 74
 
75
-.. code-block:: bash
75
+   .. code-block:: bash
76 76
 
77
-     export WORKING_DIR=$HOME/working_dir
78
-     mkdir $HOME/working_dir
77
+    export WORKING_DIR=$HOME/working_dir
78
+    mkdir $HOME/working_dir
79 79
 
80
-4. Create virtualenv for the *devops* project (e.g. ``fuel-devops-venv``).
81
-   Note: the related directory will be used for the ``VENV_PATH`` variable:
80
+#. Create virtualenv for the *devops* project (for example,
81
+   ``fuel-devops-venv``). The related directory will be used for the
82
+   ``VENV_PATH`` variable:
82 83
 
83
-.. code-block:: bash
84
+   .. code-block:: bash
84 85
 
85
-     cd $WORKING_DIR
86
-     sudo apt-get install --yes python-virtualenv
87
-     virtualenv --no-site-packages fuel-devops-venv
86
+    cd $WORKING_DIR
87
+    sudo apt-get install --yes python-virtualenv
88
+    virtualenv --no-site-packages fuel-devops-venv
88 89
 
89
-.. note:: If you want to use different devops versions in the same time, you
90
- can create several different folders for each version, and then activate the
91
- required virtual environment for each case.
90
+   .. note:: If you want to use different devops versions at the same time,
91
+             create several different folders for each version and activate
92
+             the required virtual environment for each version.
92 93
 
93
-    For example::
94
+             For example::
94 95
 
95
-        virtualenv --no-site-packages fuel-devops-venv        # For fuel-devops 2.5.x
96
-        virtualenv --no-site-packages fuel-devops-venv-2.9    # For fuel-devops 2.9.x
96
+              virtualenv --no-site-packages fuel-devops-venv        # For fuel-devops 2.5.x
97
+              virtualenv --no-site-packages fuel-devops-venv-2.9    # For fuel-devops 2.9.x
97 98
 
98
-5. Activate virtualenv and install *devops* package using PyPI.
99
-In order to indentify the latest available versions you would like to install,
100
-visit `fuel-devops <https://github.com/openstack/fuel-devops/tags>`_ repo. For
101
-Fuel 6.0 and earlier, take the latest fuel-devops 2.5.x (e.g.
102
-fuel-devops.git@2.5.6). For Fuel 6.1 and later, use 2.9.x or newer (e.g.
103
-fuel-devops.git@2.9.11):
99
+#. Activate virtualenv and install ``devops`` package using PyPI.
100
+   To identify the latest available versions to install, visit the
101
+   `fuel-devops <https://github.com/openstack/fuel-devops/tags>`_ repository.
102
+   For Fuel 6.0 and earlier, take the latest ``fuel-devops`` 2.5.x (for
103
+   example, ``fuel-devops.git@2.5.6``). For Fuel 6.1 and later, use version
104
+   3.0.x or newer (for example, ``fuel-devops.git@3.0.3``):
104 105
 
105
-.. code-block:: bash
106
+   .. code-block:: bash
106 107
 
107 108
     . fuel-devops-venv/bin/activate
108
-    pip install git+https://github.com/openstack/fuel-devops.git@2.9.11 --upgrade
109
+    pip install git+https://github.com/openstack/fuel-devops.git@<LATEST_RELEASE> --upgrade
109 110
 
110
-setup.py in fuel-devops repository does everything required.
111
+   The ``setup.py`` in the ``fuel-devops`` repository installs and configures
112
+   the ``devops`` package.
111 113
 
112
-.. hint:: You can also use
113
-    `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/>`_
114
-    which can help you manage virtual environments
114
+   .. hint:: You can also use `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/>`_
115
+             that manages virtual environments.
115 116
 
116
-6. Next, follow :ref:`DevOpsConf` section
117
+#. Follow the instructions in the :ref:`DevOpsConf` section.
117 118
 
118 119
 .. _DevOpsConf:
119 120
 
@@ -123,10 +124,10 @@ Configuration
123 124
 Basically *devops* requires that the following system-wide settings are
124 125
 configured:
125 126
 
126
- * Default libvirt storage pool is active (called 'default')
127
- * Current user must have permission to run KVM VMs with libvirt
128
- * PostgreSQL server running with appropriate grants and schema for *devops*
129
- * [Optional] Nested Paging is enabled
127
+* Default libvirt storage pool is active (called 'default')
128
+* Current user has a permission to run KVM VMs with libvirt
129
+* PostgreSQL server running with appropriate grants and schema for *devops*
130
+* (Optional) Nested Paging is enabled
130 131
 
131 132
 Configuring libvirt pool
132 133
 ~~~~~~~~~~~~~~~~~~~~~~~~~

Loading…
Cancel
Save