7279be8b85
Adds the specs/ directory to openstack-helm for housing future specifications for the project. It also includes an appropriate README with directions for drafting specs, links to the openstack resources for bp+spec lifecycle, and a template for use in drafting specifications Change-Id: Ice23447b358b520a8b4fb703fc836e8f09fa34d1
34 lines
1.3 KiB
ReStructuredText
34 lines
1.3 KiB
ReStructuredText
=====================
|
|
Project Specfications
|
|
=====================
|
|
|
|
Specifications in this repository represent a consensus on the topics covered
|
|
within. They should be considered a mandate on the path forward with regards
|
|
to the content on which they are drafted.
|
|
|
|
Purpose
|
|
-------
|
|
|
|
A specification should precede any broad-reaching technical changes or proposals
|
|
to OpenStack-Helm. Examples of changes requiring a specification include: a
|
|
standard format to the values.yaml files, multiple backend support for neutron,
|
|
and the approach for logging and monitoring in OpenStack-Helm. Some additional
|
|
features will not need an accompanying specification, but may be tied back to an
|
|
existing specification. An example of this would be introducing a service in
|
|
OpenStack-Helm that could be included under the scope of a specification already
|
|
drafted and approved.
|
|
|
|
Process
|
|
-------
|
|
|
|
Before drafting a specification, a blueprint should be filed in Launchpad_ along
|
|
with any dependencies the blueprint requires. Once the blueprint has been
|
|
registered, submit the specification as a patch set to the specs/ directory
|
|
using the supplied template.
|
|
|
|
More information about the blueprint + specification lifecycle can be found
|
|
here_.
|
|
|
|
.. _Launchpad: https://blueprints.launchpad.net/openstack-helm
|
|
.. _here: https://wiki.openstack.org/wiki/Blueprints#Blueprints_and_Specs
|