OpenStack Networking (Neutron) Specifications

Go to file

Boden R dc11da5109 Neutron resource diagnostics This spec proposes the introduction of a neutron diagnostics framework and API extension capable collecting resource diagnostics across neutron API and agent nodes. To keep the spec containable, the proposal suggests only providing a sample diagnostic check and reiterating on concrete diagnostics once we get the plumbing in place. While this spec has some inspiration from nova diagnostics [1], the approach herein is more generic and extensible supporting a broader set of use cases longer term. Finally it seeks to pave the way for supporting use case / features proposed in the related bugs. [1] https://wiki.openstack.org/wiki/Nova_VM_Diagnostics Related-Bug: #1507499 Related-Bug: #1519537 Related-Bug: #1537686 Related-Bug: #1563538 Change-Id: Id534acb1593f1fe210c561b1451656dce69514db		2017-04-13 15:30:14 -06:00
doc/source	Merge "Tweak stadium doc structure"	2017-03-31 00:04:39 +00:00
images	Introduce address scopes	2015-06-10 11:54:40 -06:00
misc	Removed networking_general_api_information.rst	2016-08-27 21:07:47 +00:00
specs	Neutron resource diagnostics	2017-04-13 15:30:14 -06:00
tests	Add Stadium project scorecard	2016-10-13 16:06:30 -07: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	Show team and repo badges on README	2016-11-25 15:37:16 +01:00
requirements.txt	Update sphinx to 1.5	2017-03-31 00:20:56 +00:00
setup.cfg	Update sphinx to 1.5	2017-03-31 00:20:56 +00:00
setup.py	Update sphinx to 1.5	2017-03-31 00:20:56 +00:00
tox.ini	Add base neutron-specs framework	2014-04-14 03:08:02 +00:00

README.rst

Team and repository tags

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.