Make specs build

Move specs under the doc/source path so they're picked up by tox -e
docs. Fix rst errors. Make them show up in toctrees.

Change-Id: I96cb7a93b129d0839733e446b66ab19d05f91acc
This commit is contained in:
Eric Fried 2018-07-12 16:31:23 -05:00
parent b15c2bdf2b
commit cce490f918
13 changed files with 84 additions and 46 deletions

View File

@ -29,10 +29,8 @@ Documentation on Nova can be found at the `Nova Devref`_.
.. _`PowerVM`: http://www-03.ibm.com/systems/power/software/virtualization/
.. _`Nova Devref`: https://docs.openstack.org/nova/latest/
Nova-PowerVM Overview
=====================
Contents:
Overview
--------
.. toctree::
:maxdepth: 1
@ -40,22 +38,27 @@ Contents:
readme
support-matrix
Nova-PowerVM Policies
=====================
Contents:
Policies
--------
.. toctree::
:maxdepth: 1
policies/index
Nova-PowerVM Devref
===================
Contents:
Devref
------
.. toctree::
:maxdepth: 1
devref/index
Specifications
--------------
.. toctree::
:maxdepth: 1
specs/template
specs/index

View File

@ -0,0 +1,12 @@
Nova-PowerVM Specifications
===========================
Contents:
.. toctree::
:maxdepth: 2
:glob:
:reversed:
*/index

View File

@ -0,0 +1,7 @@
Newton Specifications
=====================
.. toctree::
:glob:
*

View File

@ -41,11 +41,12 @@ virtualization admin authority).
A user should be able to do the standard VIF use cases with either of these
agents:
- Add NIC
- Remove NIC
- Security Groups
- Multiple Network Types (Flat, VLAN, vxlan)
- Bandwidth limiting
* Add NIC
* Remove NIC
* Security Groups
* Multiple Network Types (Flat, VLAN, vxlan)
* Bandwidth limiting
The existing Neutron agents should be used without any changes from PowerVM.
All of the changes that should occur will be in nova-powervm. Any limitations
@ -59,27 +60,27 @@ support.
Proposed change
===============
- Create a parent VIF driver for NovaLink based I/O. This will hold the code
that is common between the Linux Bridge VIFs and OVS VIFs. There will be
common code due to both needing to run on the NovaLink management VM.
* Create a parent VIF driver for NovaLink based I/O. This will hold the code
that is common between the Linux Bridge VIFs and OVS VIFs. There will be
common code due to both needing to run on the NovaLink management VM.
- The VIF drivers should create a Trunk VEA on the NovaLink partition for
each VIF. It will be given a unique channel of communication to the VM.
The device will be named according to the Neutron device name.
* The VIF drivers should create a Trunk VEA on the NovaLink partition for
each VIF. It will be given a unique channel of communication to the VM.
The device will be named according to the Neutron device name.
- The OVS VIF driver will use the nova linux_net code to set the metadata on
the trunk adapter.
* The OVS VIF driver will use the nova linux_net code to set the metadata on
the trunk adapter.
- Live migration will suspend the VIF on the target host until it has been
treated. Treating means ensuring that the communication to the VM is on
a unique channel (its own VLAN on a vSwitch).
* Live migration will suspend the VIF on the target host until it has been
treated. Treating means ensuring that the communication to the VM is on
a unique channel (its own VLAN on a vSwitch).
- A private PowerVM virtual switch named 'NovaLinkVEABridge' will be created
to support the private communication between the trunk adapters and the
VMs.
* A private PowerVM virtual switch named 'NovaLinkVEABridge' will be created
to support the private communication between the trunk adapters and the
VMs.
- Live migration on the source will need to clean up the remaining trunk
adapter for Open vSwitch that is left around on the management VM.
* Live migration on the source will need to clean up the remaining trunk
adapter for Open vSwitch that is left around on the management VM.
It should be noted that Hybrid VIF plugging will not be supported. Instead,
PowerVM will use the conntrack integration in Ubuntu 16.04/OVS 2.5 to support
@ -117,10 +118,10 @@ Deployer impact
---------------
The deployer will need to do the following:
* Attach an Ethernet I/O Card to the NovaLink partition. Configure the ports
in accordance with the Open vSwitch or Linux Bridge Neutron Agent's
requirements.
* Run the agent on their NovaLink management VM.
No major changes are anticipated outside of this. The Shared Ethernet

View File

@ -33,7 +33,7 @@ these problems.
Use Cases
---------
- As an end user, subsequent deploys of the same image should go faster
* As an end user, subsequent deploys of the same image should go faster
Proposed change
@ -41,15 +41,17 @@ Proposed change
Create a subclass of nova.virt.imagecache.ImageManager in the nova-powervm
project. It should implement the necessary methods of the cache:
- _scan_base_images
- _age_and_verify_cached_images
- _get_base
- update
* _scan_base_images
* _age_and_verify_cached_images
* _get_base
* update
The nova-powervm driver will need to be updated to utilize the cache. This
includes:
- Implementing the manage_image_cache method
- Adding the has_imagecache capability
* Implementing the manage_image_cache method
* Adding the has_imagecache capability
The localdisk driver within nova-powervm will be updated to have the
following logic. It will check the volume group backing the instance. If the
@ -68,10 +70,10 @@ overwhelming the backing disks.
Alternatives
------------
- Leave as is, all deploys potentially slow
- Implement support for linked clones. This is an eventual goal, but
the image cache is still needed in this case as it will also manage the
root disk image.
* Leave as is, all deploys potentially slow
* Implement support for linked clones. This is an eventual goal, but
the image cache is still needed in this case as it will also manage the
root disk image.
Security impact

View File

@ -0,0 +1,7 @@
Ocata Specifications
====================
.. toctree::
:glob:
*

View File

@ -0,0 +1,7 @@
Pike Specifications
===================
.. toctree::
:glob:
*

View File

@ -1 +0,0 @@
../template.rst