Jump to: navigation, search

Difference between revisions of "Neutron/BlueprintTemplate"

(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
= Blueprint Template =
= Blueprints in Neutron =
Below is an outline for a Blueprint Summary template. The purpose is to try and improve our development, review and release process. Please make sure that you include the sections below. If the section is not relevant the a simple ''N/A'' will suffice. In addition to this any links to diagrams will be greatly appreciated - this will be very helpful when we are documenting the feature release.
* Please use the spec file found here instead of this page: http://git.openstack.org/cgit/openstack/neutron-specs/tree/specs/template.rst.
* Follow the process here (https://wiki.openstack.org/wiki/Blueprints) for filing blueprints.
== Template ==
'''Scope:'''''' '''[Short overview and high level description of what the blueprint is trying to achieve.]
'''Use Cases'''''':'''''' '''[Short overview and high level description of what the blueprint is trying to achieve.]
'''Implementation Overview: '''[Provide an overview of the implementation and any algorithms that will be used]
'''Data Model Changes: '''[Are you introducing new model classes, or extending existing ones?]
'''Configuration variables:''' [List and explanation of the     new configuration variables (if they exist)]
'''API's: '''[List and explanation of the    new API's (if they exist)]
'''Plugin Interface: '''[Does this feature introduce any change?]
'''Required Plugin support: '''[What should the plugins do to support this new feature? (If applicable)]
'''Dependencies: '''[List of python packages and/or OpenStack components? (If applicable)]
'''CLI Requirements: '''[List of CLI requirements (If applicable)]
'''Horizon Requirements: '''[List of Horizon requirements (If applicable)]
'''Usage Example: '''[How to run/use/interface with the new feature. (If applicable)]
'''Test Cases: '''[Description of various test cases. (If applicable)]
<span style="font-size: large; color: green; background: yellow">OK</span>

Latest revision as of 01:48, 25 September 2014

Blueprints in Neutron