OpenStack Networking (Neutron) Specifications

Go to file

Kevin Benton 875253ecec Add spec for push notification refactor Adds a spec to change the method we use to get information from the server to the agents. Rather than the server notifying the agent to call the server, we can just put the relevant data in the notification itself to improve scalability and reliability. The bulk of this spec is dealing with the message ordering guarantee we will need to accomplish this. It also has some work items to help improve our current pattern. Related-Bug: #1516195 Change-Id: I3af200ad84483e6e1fe619d516ff20bc87041f7c		2016-05-14 06:27:20 -07:00
doc/source	Follow README guidelines in preparation of RC window	2016-03-14 01:24:45 -07:00
images	Introduce address scopes	2015-06-10 11:54:40 -06:00
misc	Revisit the structure of the specs repo	2015-10-28 21:55:08 +00:00
specs	Add spec for push notification refactor	2016-05-14 06:27:20 -07:00
tests	Revisit the structure of the specs repo	2015-10-28 21:55:08 +00:00
.gitignore	Changed .gitignore file to ignore .idea (Pycharm) and *~ (emacs)	2014-07-01 01:33:18 +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	Workflow documentation is now in infra-manual	2014-12-05 03:30:37 +00:00
requirements.txt	Merge "Remove docutils pin"	2014-09-25 19:22:49 +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:

http://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.