openstack
/
murano-specs
Code Issues Proposed changes
Murano Design Specifications
90 Commits 1 Branch 0 Tags 2.6 MiB
Python 100%
Go to file
Alexander Tivelkov ab01a2df95 Service API SDK 
This specification defines the design of Murano Service API SDK - a
high level client library allowing cloud applications (both
murano-deployed and external) to access applications's Service API in
consistent, convenient and secure way.

Change-Id: I6f1ba7b9079fc6ad5ef4ead491460506169d7d39
 		2016-02-19 15:23:06 +03:00
doc/source Replace deprecated library function os.popen() with subprocess 2016-01-14 05:30:07 -08:00
specs Service API SDK 2016-02-19 15:23:06 +03:00
tests Initial setup of spec project 2014-11-18 22:34:38 +03:00
.gitignore Initial setup of spec project 2014-11-18 22:34:38 +03:00
.gitreview Update .gitreview file to reflect repo rename 2015-04-18 00:37:36 +00:00
.testr.conf Initial setup of spec project 2014-11-18 22:34:38 +03:00
LICENSE Initial setup of spec project 2014-11-18 22:34:38 +03:00
README.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:45 +00:00
requirements.txt Initial setup of spec project 2014-11-18 22:34:38 +03:00
setup.cfg Initial setup of spec project 2014-11-18 22:34:38 +03:00
setup.py Initial setup of spec project 2014-11-18 22:34:38 +03:00
tox.ini Pass environment variables of proxy to tox 2015-12-10 12:59:53 +00:00

README.rst

OpenStack Murano Specifications

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

Where there are two sub-directories:

specs/<release>/approved: specifications approved but not yet implemented specs/<release>/implemented: implemented specifications

This directory structure allows you to see what we thought about doing, decided to do, and actually got done. Users interested in functionality in a given release should only refer to the implemented directory.

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

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.

Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.

Prior to the Kilo development cycle this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/murano

Starting from the Kilo-1 developement milestone Murano performs the pilot of the specs repos approach.

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.