openstack/vitrage-specs
Code Issues Proposed changes
Vitrage Design Specifications
54 Commits 1 Branch 0 Tags 2.5 MiB
Python 100%
5e4a21661a
Go to file
Alexey Weyl 5e4a21661a rename internal vitrage properties 
1. vitrage_sync_mode to vitrage_action_type
2. vitrage_sync_type to vitrage_entity_type

Change-Id: I19c73e439f03d9830364c611774d27648278b6c7
2016-11-27 10:49:58 +02:00
doc/source Fixed the documentation, include also Newton and Ocata specs 2016-11-07 18:00:46 +00:00
specs rename internal vitrage properties 2016-11-27 10:49:58 +02:00
tests Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
.gitignore add .iml to git ignore 2015-12-24 14:28:14 +02:00
.gitreview Added .gitreview 2015-11-06 06:43:41 +00:00
.testr.conf Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
LICENSE Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
README.rst Show team and repo badges on README 2016-11-25 17:44:46 +01:00
requirements.txt fix pbr version 2015-11-08 14:43:04 +02:00
setup.cfg Changed the home-page of vitrage-specs in setup.cfg 2016-10-23 22:44:13 +05:30
setup.py Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
tox.ini Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00

README.rst

Team and repository tags

image

OpenStack Vitrage Specifications

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

Launchpad blueprints:

http://blueprints.launchpad.net/vitrage

Starting from the Mitaka-1 development milestone Vitrage 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.