OpenStack Orchestration (Heat) Specifications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins 34b3846c61 OpenDev Migration Patch 2 months ago
doc/source Add Rocky Spec Template 11 months ago
specs [Trivial Fix] modify spelling error of "resource" 7 months ago
tests Fix rocky template 9 months ago
.gitignore Added AUTHORS and ChangeLog to .gitignore 3 years ago
.gitreview OpenDev Migration Patch 2 months ago
.testr.conf Add some tests to validate specs 4 years ago
.zuul.yaml import zuul job settings from project-config 9 months ago
LICENSE Added cookiecutter specs framework 5 years ago Added cookiecutter specs framework 5 years ago
README.rst Update README.rst 2 years ago
requirements.txt Add RSS feed 4 years ago
setup.cfg Change openstack-dev to openstack-discuss 5 months ago Update setuptools setup_requires 3 years ago
test-requirements.txt Use testscenarios lib for testing per-release 3 years ago
tox.ini fix tox python3 overrides 8 months ago


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:


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:

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

For more information about working with gerrit, see:

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.