Updated installation section.
The installation section was updated to document an installation from PyPI, using the upper constraints file of OpenStack. There is now a table that maps package versions to OpenStack releases. Three different currency variants are described: - recommended: Latest released fix level for a particular stable OpenStack release. - Latest fix level in development, for a particular stable OpenStack release. - For developers: Latest development level for OpenStack release in development. Change-Id: I2e4cce2d694ea233dbdb5af9b73cebf83cb2228a Partial-Bug: 1660689 Signed-off-by: Andreas Maier <maiera@de.ibm.com>
This commit is contained in:
parent
e430d2f0fa
commit
c73d6bd088
|
@ -5,31 +5,82 @@ Installation
|
|||
============
|
||||
|
||||
The nova-dpm virtualization driver must be installed on every OpenStack compute
|
||||
node that is supposed to manage a z Systems or LinuxONE machine in DPM mode.
|
||||
node for DPM.
|
||||
|
||||
This section describes the manual installation of the nova-dpm driver from
|
||||
the upstream OpenStack Git repository.
|
||||
This section describes the manual installation of the nova-dpm driver onto a
|
||||
compute node that has already been installed by some means.
|
||||
|
||||
Normally, you should use the stable Git branch for the OpenStack release you
|
||||
have on the compute node (e.g. for Ocata)::
|
||||
The nova-dpm virtualization driver is released on PyPI as package `nova-dpm`_.
|
||||
|
||||
$ nova_dpm=https://github.com/openstack/nova-dpm/tree/stable/ocata
|
||||
.. _`nova-dpm`: https://pypi.python.org/pypi/nova-dpm
|
||||
|
||||
If you want to use the latest development code level of the next OpenStack
|
||||
release, use the ``master`` Git branch::
|
||||
The following table indicates which version of the nova-dpm package on PyPI to
|
||||
use for a particular OpenStack release:
|
||||
|
||||
$ nova_dpm=https://github.com/openstack/nova-dpm/tree/master
|
||||
.. list-table::
|
||||
:widths: 50 50
|
||||
:header-rows: 1
|
||||
|
||||
If the Python packages of your OpenStack installation are in the system Python
|
||||
on the compute node, install the nova-dpm driver with::
|
||||
* - OpenStack release
|
||||
- nova-dpm version
|
||||
* - Ocata
|
||||
- 1.x.x
|
||||
|
||||
$ sudo pip install $nova_dpm
|
||||
Typically, the nova-dpm package will increase its major version number by one
|
||||
for each new OpenStack release.
|
||||
|
||||
If the Python packages of your OpenStack installation are in a virtual Python
|
||||
environment named ``venv`` that was established with ``virtualenvwrapper``,
|
||||
install the nova-dpm driver with::
|
||||
If you want to install the package for a particular OpenStack release,
|
||||
it is recommended to use the packages that have been released to PyPI, rather
|
||||
than installing from a particular branch of a Git repository.
|
||||
|
||||
$ workon venv
|
||||
$ pip install $nova_dpm
|
||||
To do that, identify the major version number for the desired OpenStack release
|
||||
from the table above, and install the latest minor and fix version of the
|
||||
package for that major version, also specifying the global upper constraints
|
||||
file for the desired OpenStack release (the latter ensures that you get the
|
||||
right versions of any dependent packages).
|
||||
|
||||
After installing the driver, proceed with its :ref:`configuration`.
|
||||
For example, for Ocata:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ constraints_file=https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/ocata
|
||||
$ pip install -c$constraints_file "nova-dpm >=1,<2"
|
||||
|
||||
If you have good reasons to install the latest not yet released fix level of
|
||||
the nova-dpm package for a particular (released) OpenStack release, install
|
||||
the nova-dpm package from the stable branch of the GitHub repo for that
|
||||
OpenStack release:
|
||||
|
||||
For example, for Ocata:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ constraints_file=https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/ocata
|
||||
$ pip install -c$constraints_file git+https://git.openstack.org/openstack/nova-dpm@stable/ocata
|
||||
|
||||
If you are a developer and want to install the latest code of the nova-dpm
|
||||
package for the OpenStack release that is in development:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ constraints_file=https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=master
|
||||
$ pip install -c$constraints_file git+https://git.openstack.org/openstack/nova-dpm@master
|
||||
|
||||
The pip commands above install the packages into the currently active Python
|
||||
environment.
|
||||
|
||||
If your active Python environment is a virtual Python environment, the
|
||||
commands above can be issued from a userid without sudo rights.
|
||||
|
||||
If you need to install the packages into the system Python environment, you
|
||||
need sudo rights:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo pip install ...
|
||||
|
||||
After installing the nova-dpm driver, proceed with its :ref:`configuration`.
|
||||
|
||||
Note that you will also need to install and configure the networking-dpm
|
||||
package on the compute node. For its documentation, see
|
||||
http://networking-dpm.readthedocs.io/en/latest/.
|
||||
|
|
Loading…
Reference in New Issue