openstack/ironic-specs
Code Issues Proposed changes
OpenStack Baremetal (Ironic) Specifications
375 Commits 1 Branch 0 Tags 20 MiB
Python 100%
9506b9561e
Go to file
Julia Kreger 9506b9561e Revise driver composition reform defaults 
Revising the specification based upon discussions [1] amongst the
team to allow the capability for an operator to explicitly define a
default interface for their environment, as well as define how
default interfaces are determined should one not be defined by
either the operator or the API user creating the node.

[1] http://lists.openstack.org/pipermail/openstack-dev/2016-August/101477.html

Co-Authored-By: Dmitry Tantsur <dtantsur@redhat.com>
Change-Id: I6e7e57f02eaa1f3470725c901e991b32906bfe8b
2016-11-01 12:13:04 +01:00
doc/source Update implemented specs for 6.1 2016-08-15 21:35:26 +00:00
priorities Priorities that were done in Mitaka 2016-05-10 15:33:12 -04:00
specs Revise driver composition reform defaults 2016-11-01 12:13:04 +01:00
tests Improve assertion error in check_file_ext test 2016-04-13 09:28:38 -07:00
.gitignore Initial commit 2014-05-22 15:51:33 -07:00
.gitreview Updated .gitreview file for repo rename 2014-05-26 16:06:07 +00:00
.testr.conf Initial commit 2014-05-22 15:51:33 -07:00
LICENSE Initial commit 2014-05-22 15:51:33 -07:00
README.rst Update README to reflect use of RFE bugs 2016-01-05 20:35:28 +00:00
requirements.txt Add RSS feed 2014-09-10 16:00:19 -04:00
setup.cfg Initial commit 2014-05-22 15:51:33 -07:00
setup.py Initial commit 2014-05-22 15:51:33 -07:00
test-requirements.txt Use doc8 style checker 2015-09-30 20:29:50 +00:00
tox.ini Add doc8 check on priorities/ 2016-05-04 14:07:49 +01:00

README.rst

OpenStack Baremetal Provisioning Specifications

This git repository is used to hold approved design specifications for additions to the Baremetal Provisioning program, and in particular, the Ironic 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/approved/
specs/backlog/
specs/not-implemented/
specs/<release>/
specs/<juno|kilo|liberty>-implemented/

There are also placeholder directories for old links that have been moved.

Specifications must follow the template which can be found at doc/source/specs/template.rst.

Specifications are proposed by adding them to the specs/approved directory, adding a soft link to it from the specs/not-implemented directory, and posting it for review. When a specification is fully implemented, the link in specs/not-implemented directory should be moved to the appropriate specs/<release> directory. Not all approved specifications will get fully implemented.

Starting with the Mitaka development cycle, all approved specifications (implemented and not-implemented) will reside in the specs/approved directory.

Also starting with the Mitaka development cycle, our Launchpad bug tracking system is used for tracking the work related to a specification. (This replaces the use of Launchpad blueprints). The bug should be tagged with 'rfe', its title should be prefixed with '[RFE]' and the Importance should be set to 'Wishlist'. For existing RFE bugs, see:

https://bugs.launchpad.net/ironic/+bugs?field.tag=rfe

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/ironic

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.