openstack
/
heat-specs
Code Issues Proposed changes
OpenStack Orchestration (Heat) Specifications
317 Commits 1 Branch 0 Tags 6.1 MiB
Python 100%
Go to file
Zane Bitter 01865425c5 Custom Resource type managed by Mistral Workflows 
Allow users to define custom resource types by implementing their
actions as Mistral workflows.

Change-Id: I9f6b86dff16018fe4b2ad43aa28282e88236dbae
 		2017-05-22 17:38:11 -04:00
doc/source Move to backlog properties group spec 2017-03-20 18:10:20 +04:00
specs Custom Resource type managed by Mistral Workflows 2017-05-22 17:38:11 -04:00
tests Stop ignoring kilo release directory in tests 2016-01-12 03:43:44 -05:00
.gitignore Added AUTHORS and ChangeLog to .gitignore 2015-09-25 15:26:18 -04:00
.gitreview Added cookiecutter specs framework 2014-05-27 12:47:57 -07:00
.testr.conf Add some tests to validate specs 2015-04-21 16:05:03 +05:30
LICENSE Added cookiecutter specs framework 2014-05-27 12:47:57 -07:00
MANIFEST.in Added cookiecutter specs framework 2014-05-27 12:47:57 -07:00
README.rst Update README.rst 2016-07-25 05:33:46 +00:00
requirements.txt Add RSS feed 2014-09-10 15:59:53 -04:00
setup.cfg Changed the homepage of heat-specs 2016-09-23 13:25:44 +05:30
setup.py Update setuptools setup_requires 2015-08-05 09:27:27 +08:00
test-requirements.txt Use testscenarios lib for testing per-release 2016-01-12 08:32:36 +00:00
tox.ini Add some tests to validate specs 2015-04-21 16:05:03 +05:30

README.rst

OpenStack Heat Specifications

This git repository is used to hold approved design specifications for additions to the heat 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>/

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.

You can find an example spec in specs/template.rst.

There is a sub-directory specs/<release>/backlog to store all specs that had been approved but are not implemented in a specific release.

Movement of specs to the backlog would be done in a batch at the end of a release cycle.

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

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 checkin the generated HTML files as a part of your commit.