Overhauled the documentation
This change is supposed to improve the documentation that currently exists, without adding much new content. Details: * Reorganized the main page into a common overview section, a section for users of the driver, and a section for contributors, and a section with links for quick access. * Separated between the `README.rst` file and the introductory text on the main page, because the `README.rst` file stands on its own when shown on the Github code page, while the introductory text is part of the larger documentation. As a result, removed the `doc/source/readme.rst` file. * Added an empty chapter for the topology to the overview section of the main page, instead of referencing the readme file. * Cleaned up headings and file names somewhat. * Added link targets to any major headings. * Adapted the contributions page to the project, and added links for the Git repo and the Gerrit review page. Change-Id: Id7a9a632984ad8945ca1dd347a7766601030a373 Partial-Bug: 1660689 Signed-off-by: Andreas Maier <maiera@de.ibm.com>
This commit is contained in:
parent
eb2bc80389
commit
cf932be130
|
@ -1,19 +0,0 @@
|
||||||
Contributing to Nova-DPM
|
|
||||||
============================
|
|
||||||
If you would like to contribute to the development of OpenStack,
|
|
||||||
you must follow the steps in the "If you're a developer, start here"
|
|
||||||
section of this page:
|
|
||||||
|
|
||||||
http://wiki.openstack.org/HowToContribute
|
|
||||||
|
|
||||||
Once those steps have been completed, changes to OpenStack
|
|
||||||
should be submitted for review via the Gerrit tool, following
|
|
||||||
the workflow documented at:
|
|
||||||
|
|
||||||
http://wiki.openstack.org/GerritWorkflow
|
|
||||||
|
|
||||||
Pull requests submitted through GitHub will be ignored.
|
|
||||||
|
|
||||||
Bugs should be filed on Launchpad, not GitHub:
|
|
||||||
|
|
||||||
https://bugs.launchpad.net/nova-dpm
|
|
54
README.rst
54
README.rst
|
@ -1,33 +1,37 @@
|
||||||
===============================
|
==========================
|
||||||
nova-dpm
|
openstack/nova-dpm Project
|
||||||
===============================
|
==========================
|
||||||
|
|
||||||
OpenStack Nova driver and agent for IBM z Systems PR/SM hypervisor in DPM mode
|
About this project
|
||||||
|
------------------
|
||||||
|
|
||||||
On IBM z Systems, certain workloads run better in a logical partition than
|
This project provides a Nova virtualization driver for the PR/SM hypervisor of
|
||||||
in a virtual machine of a software hypervisor such as KVM or z/VM.
|
IBM z Systems and IBM LinuxOne machines that are in the DPM (Dynamic Partition
|
||||||
|
Manager) administrative mode.
|
||||||
|
|
||||||
The IBM z13 system (and IBM LinuxONE) introduced a new administrative mode
|
The DPM mode enables dynamic capabilities of the firmware-based PR/SM
|
||||||
named "Dynamic Partition Manager" (DPM) that allows for managing the
|
hypervisor that are usually known from software-based hypervisors, such as
|
||||||
firmware-based logical partition hypervisor (PR/SM) with the dynamic
|
creation, deletion and modification of partitions (i.e. virtual machines) and
|
||||||
capabilities known from software-based hypervisors.
|
virtual devices within these partitions, and dynamic assignment of these
|
||||||
|
virtual devices to physical I/O adapters.
|
||||||
|
|
||||||
These new dynamic capabilities provided by the DPM mode enables PR/SM to
|
The z/VM and KVM hypervisors on z Systems and LinuxONE machines are supported
|
||||||
act as a hypervisor managed by OpenStack using Nova.
|
by separate Nova virtualization drivers:
|
||||||
|
|
||||||
This project supports adding the PR/SM hypervisor in DPM mode as a
|
* KVM is supported by the standard libvirt/KVM driver in the
|
||||||
Nova hypervisor platform, by implementing a new Nova driver.
|
`openstack/nova <http://git.openstack.org/cgit/openstack/nova>`_
|
||||||
|
project.
|
||||||
|
|
||||||
The other hypervisors on z Systems such as z/VM and KVM are already
|
* z/VM is supported by the z/VM driver in the
|
||||||
supported by OpenStack via Nova drivers. These drivers will continue to be
|
`openstack/nova-zvm-virt-driver <http://git.openstack.org/cgit/openstack/nova-zvm-virt-driver>`_
|
||||||
supported. Adding support for PR/SM DPM allows addressing customers that
|
project.
|
||||||
need or want to run their workloads in logical partitions, and provides the
|
|
||||||
advantage for them of using OpenStack as a uniform, standard, cloud
|
|
||||||
management platform on z Systems.
|
|
||||||
|
|
||||||
|
Links
|
||||||
|
-----
|
||||||
|
|
||||||
* Free software: Apache license
|
* Documentation: `<http://nova-dpm.readthedocs.io/en/latest/>`_
|
||||||
* Documentation: http://nova-dpm.readthedocs.io/en/latest/
|
* Source: `<http://git.openstack.org/cgit/openstack/nova-dpm>`_
|
||||||
* Source: http://git.openstack.org/cgit/openstack/nova-dpm
|
* Github shadow: `<https://github.com/openstack/nova-dpm>`_
|
||||||
* Bugs: http://bugs.launchpad.net/nova-dpm
|
* Bugs: `<http://bugs.launchpad.net/nova-dpm>`_
|
||||||
|
* Gerrit: `<https://review.openstack.org/#/q/project:openstack/nova-dpm>`_
|
||||||
|
* License: Apache 2.0 license
|
||||||
|
|
|
@ -0,0 +1,17 @@
|
||||||
|
.. _`configuration`:
|
||||||
|
|
||||||
|
=============
|
||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
|
The following is a sample ``nova_dpm.conf`` configuration file for the nova-dpm
|
||||||
|
driver, for adaptation and use.
|
||||||
|
|
||||||
|
It is auto-generated from the nova-dpm project when this documentation is
|
||||||
|
built, so if you are having issues with an option, please compare your version
|
||||||
|
of the ``nova-dpm`` Python package with the version of this documentation.
|
||||||
|
|
||||||
|
The sample configuration can also be viewed in
|
||||||
|
`file form <_static/nova_dpm.conf.sample>`_.
|
||||||
|
|
||||||
|
.. literalinclude:: _static/nova_dpm.conf.sample
|
|
@ -1,4 +1,30 @@
|
||||||
|
.. `contributing`:
|
||||||
|
|
||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
|
||||||
|
If you would like to contribute to the development of the nova-dpm project, you
|
||||||
|
must follow the rules for OpenStack contributions described in the
|
||||||
|
"If you're a developer, start here" section of this page:
|
||||||
|
|
||||||
|
http://wiki.openstack.org/HowToContribute
|
||||||
|
|
||||||
|
Once those steps have been completed, changes to the nova-dpm project should be
|
||||||
|
submitted for review via the Gerrit tool, following the workflow documented at:
|
||||||
|
|
||||||
|
http://wiki.openstack.org/GerritWorkflow
|
||||||
|
|
||||||
|
Pull requests submitted through GitHub will be ignored.
|
||||||
|
|
||||||
|
The Git repository for the nova-dpm project is here:
|
||||||
|
|
||||||
|
http://git.openstack.org/cgit/openstack/nova-dpm
|
||||||
|
|
||||||
|
Bugs against the nova-dpm project should be filed on Launchpad (not on GitHub):
|
||||||
|
|
||||||
|
https://bugs.launchpad.net/nova-dpm
|
||||||
|
|
||||||
|
Pending changes for the nova-dpm project can be seen on its Gerrit page:
|
||||||
|
|
||||||
|
https://review.openstack.org/#/q/project:openstack/nova-dpm
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _`developer guide`:
|
||||||
|
|
||||||
===============
|
===============
|
||||||
Developer Guide
|
Developer Guide
|
||||||
===============
|
===============
|
||||||
|
@ -41,4 +43,4 @@ To build the release notes::
|
||||||
in your local repository of this project.
|
in your local repository of this project.
|
||||||
|
|
||||||
More information about *reno* can be found at:
|
More information about *reno* can be found at:
|
||||||
http://docs.openstack.org/developer/reno/index.html
|
http://docs.openstack.org/developer/reno/index.html
|
||||||
|
|
|
@ -15,67 +15,70 @@
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
Welcome to nova-dpm's documentation!
|
Welcome to nova-dpm's documentation!
|
||||||
========================================
|
====================================
|
||||||
|
|
||||||
This project will be used for development of nova driver for supporting IBM System z PR/SM hypervisor in DPM mode as a valid nova hypervisor platform.
|
On IBM z Systems and IBM LinuxOne machines, certain workloads run better in a
|
||||||
|
partition of the firmware-based PR/SM (Processor Resource/System Manager)
|
||||||
|
hypervisor, than in a virtual machine of a software hypervisor such as KVM or
|
||||||
|
z/VM.
|
||||||
|
|
||||||
On IBM z Systems, certain workloads run better in a logical partition than
|
This project provides a Nova virtualization driver for the PR/SM hypervisor of
|
||||||
in a virtual machine of a software hypervisor such as KVM or z/VM.
|
IBM z Systems and IBM LinuxOne machines that are in the DPM (Dynamic Partition
|
||||||
|
Manager) administrative mode.
|
||||||
|
|
||||||
The IBM z13 system (and IBM LinuxONE) introduced a new administrative mode
|
The DPM mode enables dynamic capabilities of the firmware-based PR/SM
|
||||||
named "Dynamic Partition Manager" (DPM) that allows for managing the
|
hypervisor that are usually known from software-based hypervisors, such as
|
||||||
firmware-based logical partition hypervisor (PR/SM) with the dynamic
|
creation, deletion and modification of partitions (i.e. virtual machines) and
|
||||||
capabilities known from software-based hypervisors.
|
virtual devices within these partitions, and dynamic assignment of these
|
||||||
|
virtual devices to physical I/O adapters.
|
||||||
|
|
||||||
These new dynamic capabilities provided by the DPM mode enables PR/SM to
|
The z/VM and KVM hypervisors on z Systems and LinuxONE machines are supported
|
||||||
act as a hypervisor managed by OpenStack using Nova.
|
by separate Nova virtualization drivers:
|
||||||
|
|
||||||
This project supports adding the PR/SM hypervisor in DPM mode as a
|
* KVM is supported by the standard libvirt/KVM driver in the
|
||||||
Nova hypervisor platform, by implementing a new Nova driver.
|
`openstack/nova <http://git.openstack.org/cgit/openstack/nova>`_
|
||||||
|
project.
|
||||||
|
|
||||||
The other hypervisors on z Systems such as z/VM and KVM are already
|
* z/VM is supported by the z/VM driver in the
|
||||||
supported by OpenStack via Nova drivers. These drivers will continue to be
|
`openstack/nova-zvm-virt-driver <http://git.openstack.org/cgit/openstack/nova-zvm-virt-driver>`_
|
||||||
supported. Adding support for PR/SM DPM allows addressing customers that
|
project.
|
||||||
need or want to run their workloads in logical partitions, and provides the
|
|
||||||
advantage for them of using OpenStack as a uniform, standard, cloud
|
|
||||||
management platform on z Systems.
|
|
||||||
|
|
||||||
Nova-DPM Overview
|
Links
|
||||||
=====================
|
=====
|
||||||
|
|
||||||
Contents:
|
* Documentation: `<http://nova-dpm.readthedocs.io/en/latest/>`_
|
||||||
|
* Source: `<http://git.openstack.org/cgit/openstack/nova-dpm>`_
|
||||||
|
* Github shadow: `<https://github.com/openstack/nova-dpm>`_
|
||||||
|
* Bugs: `<http://bugs.launchpad.net/nova-dpm>`_
|
||||||
|
* Gerrit: `<https://review.openstack.org/#/q/project:openstack/nova-dpm>`_
|
||||||
|
|
||||||
|
Overview
|
||||||
|
========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 1
|
||||||
|
|
||||||
|
releasenotes/source/unreleased
|
||||||
|
topology
|
||||||
|
|
||||||
|
Using the nova-dpm driver
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
readme
|
|
||||||
support-matrix
|
|
||||||
installation
|
installation
|
||||||
usage
|
configuration
|
||||||
|
support-matrix
|
||||||
|
|
||||||
|
Contributing to the nova-dpm project
|
||||||
|
====================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
contributing
|
contributing
|
||||||
sample_config
|
|
||||||
devref
|
devref
|
||||||
|
specs/ocata/index
|
||||||
|
|
||||||
Release Notes
|
|
||||||
=============
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
releasenotes/source/unreleased
|
|
||||||
|
|
||||||
|
|
||||||
Specifications
|
|
||||||
==============
|
|
||||||
|
|
||||||
Here you can find the specs, and spec template, for each release:
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/ocata/index
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,35 @@
|
||||||
|
.. _`installation`:
|
||||||
|
|
||||||
============
|
============
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
At the command line::
|
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.
|
||||||
|
|
||||||
$ pip install nova-dpm
|
This section describes the manual installation of the nova-dpm driver from
|
||||||
|
the upstream OpenStack Git repository.
|
||||||
|
|
||||||
Or, if you have virtualenvwrapper installed::
|
Normally, you should use the stable Git branch for the OpenStack release you
|
||||||
|
have on the compute node (e.g. for Ocata)::
|
||||||
|
|
||||||
$ mkvirtualenv nova-dpm
|
$ nova_dpm=https://github.com/openstack/nova-dpm/tree/stable/ocata
|
||||||
$ pip install nova-dpm
|
|
||||||
|
If you want to use the latest development code level of the next OpenStack
|
||||||
|
release, use the ``master`` Git branch::
|
||||||
|
|
||||||
|
$ nova_dpm=https://github.com/openstack/nova-dpm/tree/master
|
||||||
|
|
||||||
|
If the Python packages of your OpenStack installation are in the system Python
|
||||||
|
on the compute node, install the nova-dpm driver with::
|
||||||
|
|
||||||
|
$ sudo pip install $nova_dpm
|
||||||
|
|
||||||
|
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::
|
||||||
|
|
||||||
|
$ workon venv
|
||||||
|
$ pip install $nova_dpm
|
||||||
|
|
||||||
|
After installing the driver, proceed with its :ref:`configuration`.
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../README.rst
|
|
|
@ -1,12 +0,0 @@
|
||||||
==============================
|
|
||||||
Nova-dpm Configuration Options
|
|
||||||
==============================
|
|
||||||
|
|
||||||
The following is a sample Nova-dpm configuration for adaptation and use.
|
|
||||||
It is auto-generated from Nova-dpm when this documentation is built, so
|
|
||||||
if you are having issues with an option, please compare your version of
|
|
||||||
Nova-dpm with the version of this documentation.
|
|
||||||
|
|
||||||
The sample configuration can also be viewed in `file form <_static/nova_dpm.conf.sample>`_.
|
|
||||||
|
|
||||||
.. literalinclude:: _static/nova_dpm.conf.sample
|
|
|
@ -1,6 +1,8 @@
|
||||||
=============================
|
=================================
|
||||||
Nova-dpm Ocata Specifications
|
Nova-dpm specifications for Ocata
|
||||||
=============================
|
=================================
|
||||||
|
|
||||||
|
**TODO:** Figure out what to do with this page and its child pages.
|
||||||
|
|
||||||
Template:
|
Template:
|
||||||
|
|
||||||
|
@ -9,7 +11,7 @@ Template:
|
||||||
|
|
||||||
Specification Template (Ocata release) <template>
|
Specification Template (Ocata release) <template>
|
||||||
|
|
||||||
Ocata implemented specs:
|
Specs implemented in Ocata:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
@ -17,7 +19,7 @@ Ocata implemented specs:
|
||||||
|
|
||||||
implemented/*
|
implemented/*
|
||||||
|
|
||||||
Ocata approved (but not implemented) specs:
|
Specs approved (but not implemented) in Ocata:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
|
.. `feature support matrix`:
|
||||||
|
|
||||||
|
======================
|
||||||
Feature Support Matrix
|
Feature Support Matrix
|
||||||
======================
|
======================
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,7 @@
|
||||||
|
.. `topology`:
|
||||||
|
|
||||||
|
========
|
||||||
|
Topology
|
||||||
|
========
|
||||||
|
|
||||||
|
**TODO:** Describe the topology
|
|
@ -1,7 +0,0 @@
|
||||||
========
|
|
||||||
Usage
|
|
||||||
========
|
|
||||||
|
|
||||||
To use nova-dpm in a project::
|
|
||||||
|
|
||||||
import nova_dpm
|
|
Loading…
Reference in New Issue