OpenStack Networking (Neutron) Specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
David Shaughnessy acc57d57c4 Missing caveat in NC DSCP spec 1 month ago
doc Bump the openstackdocstheme extension to 1.20 4 months ago
images Introduce port mirroring for sriov-vf 1 year ago
misc Removed networking_general_api_information.rst 3 years ago
specs Missing caveat in NC DSCP spec 4 weeks ago
tests Fix py27 job in specs repo 1 year ago
.gitignore Switch to stestr 1 year ago
.gitreview OpenDev Migration Patch 10 months ago
.stestr.conf Switch to stestr 1 year ago
.zuul.yaml Switch py27 job to py36 9 months ago
LICENSE Add base neutron-specs framework 5 years ago
README.rst Delete redundant rst files and update README 1 year ago
requirements.txt Switch to stestr 1 year ago
setup.cfg Change openstack-dev to openstack-discuss 1 year ago
setup.py Update sphinx to 1.5 2 years ago
tox.ini Update the constraints url 4 months ago

README.rst

Team and repository tags

image

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 specs/template.rst.

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:

https://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://docs.openstack.org/infra/manual/developers.html#development-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 check in the generated HTML files as a part of your commit.