openstack/neutron-specs
Code Issues Proposed changes
OpenStack Networking (Neutron) Specifications
49 Commits 1 Branch 0 Tags 29 MiB
Python 100%
a7a242c8ea
Go to file
Paul Michali a7a242c8ea BP: Provider Validation for L3 Plugins 
Blueprint spec on adding vendor validation capabilities
for L3 services for Juno.

Initial work is to separate out the validation logic
so that it can be extended/overridden.

Later work could consider using TaskFlow to handle all
processing steps, but needs additional research first.

Change-Id: Ic34376fe261e36d4341ff7b2f1727f4a897e7479
2014-06-09 11:49:17 -04:00
doc/source Added Sphinx diagram tools 2014-04-17 21:11:15 +00:00
specs BP: Provider Validation for L3 Plugins 2014-06-09 11:49:17 -04:00
tests Ensure skeleton.rst is tested 2014-05-21 16:45:21 -04:00
.gitignore Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
.gitreview Added .gitreview 2014-03-28 19:24:51 +00:00
.testr.conf Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
LICENSE Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
README.rst Create a skeleton RST file 2014-05-19 11:35:02 -04:00
requirements.txt Added Sphinx diagram tools 2014-04-17 21:11:15 +00:00
setup.cfg Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
setup.py Add base neutron-specs framework 2014-04-14 03:08:02 +00:00
tox.ini Add base neutron-specs framework 2014-04-14 03:08:02 +00:00

README.rst

OpenStack Neutron Specifications

This git repository is used to hold approved design specifications for additions to the Neutron project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

You can find an example spec in doc/source/specs/template.rst. A skeleton that contains all the sections required for a spec file is located in doc/source/specs/skeleton.rst and can be copied, then filled in with the details of a new blueprint for convenience.

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/neutron

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

https://wiki.openstack.org/wiki/Gerrit_Workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory. Please do not checkin the generated HTML files as a part of your commit.