summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-01-20 17:42:09 +0000
committerGerrit Code Review <review@openstack.org>2017-01-20 17:42:09 +0000
commite908c713780a61af0e3ef61bd8e0a62ba74369b6 (patch)
tree5bf6dd75a920b4f9ab322da5bf3d7b09014810e3
parentcbd7fcc65cc46632455a20d058c0e10025f25289 (diff)
parentb78d0445440480e2e56e95c5970eceb7756c2257 (diff)
Merge "[devops guide] Update the fuel-devops version number during install"
-rw-r--r--devdocs/devops.rst81
1 files changed, 41 insertions, 40 deletions
diff --git a/devdocs/devops.rst b/devdocs/devops.rst
index c40502f..c7a2211 100644
--- a/devdocs/devops.rst
+++ b/devdocs/devops.rst
@@ -54,66 +54,67 @@ Before using it, please install the following required dependencies:
54Devops installation in `virtualenv <http://virtualenv.readthedocs.org/en/latest/virtualenv.html>`_ 54Devops installation in `virtualenv <http://virtualenv.readthedocs.org/en/latest/virtualenv.html>`_
55~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 55~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56 56
571. 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 sudo apt-get install --yes python-virtualenv libpq-dev libgmp-dev pkg-config 61 sudo apt-get install --yes python-virtualenv libpq-dev libgmp-dev pkg-config
62 62
632. In case you are using *Ubuntu 12.04* let's update pip and virtualenv, 63#. If you use Ubuntu 12.04, update ``pip`` and ``virtualenv``;
64 otherwise you can skip this step 64 otherwise, you can skip this step:
65 65
66.. code-block:: bash 66 .. code-block:: bash
67 67
68 sudo pip install pip virtualenv --upgrade 68 sudo pip install pip virtualenv --upgrade
69 hash -r 69 hash -r
70 70
713. In oder to store the path where your Python virtualenv will be located 71#. To store the path where your Python virtualenv will be located,
72 create your working directory and use the following environment variable. If 72 create your working directory and use the following environment variable.
73 it is not specified, it will use the current working directory: 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 77 export WORKING_DIR=$HOME/working_dir
78 mkdir $HOME/working_dir 78 mkdir $HOME/working_dir
79 79
804. Create virtualenv for the *devops* project (e.g. ``fuel-devops-venv``). 80#. Create virtualenv for the *devops* project (for example,
81 Note: the related directory will be used for the ``VENV_PATH`` variable: 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 cd $WORKING_DIR
86 sudo apt-get install --yes python-virtualenv 87 sudo apt-get install --yes python-virtualenv
87 virtualenv --no-site-packages fuel-devops-venv 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 .. note:: If you want to use different devops versions at the same time,
90 can create several different folders for each version, and then activate the 91 create several different folders for each version and activate
91 required virtual environment for each case. 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 # For fuel-devops 2.5.x
96 virtualenv --no-site-packages fuel-devops-venv-2.9 # For fuel-devops 2.9.x 97 virtualenv --no-site-packages fuel-devops-venv-2.9 # For fuel-devops 2.9.x
97 98
985. Activate virtualenv and install *devops* package using PyPI. 99#. Activate virtualenv and install ``devops`` package using PyPI.
99In order to indentify the latest available versions you would like to install, 100 To identify the latest available versions to install, visit the
100visit `fuel-devops <https://github.com/openstack/fuel-devops/tags>`_ repo. For 101 `fuel-devops <https://github.com/openstack/fuel-devops/tags>`_ repository.
101Fuel 6.0 and earlier, take the latest fuel-devops 2.5.x (e.g. 102 For Fuel 6.0 and earlier, take the latest ``fuel-devops`` 2.5.x (for
102fuel-devops.git@2.5.6). For Fuel 6.1 and later, use 2.9.x or newer (e.g. 103 example, ``fuel-devops.git@2.5.6``). For Fuel 6.1 and later, use version
103fuel-devops.git@2.9.11): 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 . fuel-devops-venv/bin/activate 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
110setup.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 114 .. hint:: You can also use `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/>`_
113 `virtualenvwrapper <http://virtualenvwrapper.readthedocs.org/>`_ 115 that manages virtual environments.
114 which can help you manage virtual environments
115 116
1166. Next, follow :ref:`DevOpsConf` section 117#. Follow the instructions in the :ref:`DevOpsConf` section.
117 118
118.. _DevOpsConf: 119.. _DevOpsConf:
119 120
@@ -123,10 +124,10 @@ Configuration
123Basically *devops* requires that the following system-wide settings are 124Basically *devops* requires that the following system-wide settings are
124configured: 125configured:
125 126
126 * Default libvirt storage pool is active (called 'default') 127* Default libvirt storage pool is active (called 'default')
127 * Current user must have permission to run KVM VMs with libvirt 128* Current user has a permission to run KVM VMs with libvirt
128 * PostgreSQL server running with appropriate grants and schema for *devops* 129* PostgreSQL server running with appropriate grants and schema for *devops*
129 * [Optional] Nested Paging is enabled 130* (Optional) Nested Paging is enabled
130 131
131Configuring libvirt pool 132Configuring libvirt pool
132~~~~~~~~~~~~~~~~~~~~~~~~~ 133~~~~~~~~~~~~~~~~~~~~~~~~~