openstack
/
vitrage-specs
Code Issues Proposed changes
Vitrage Design Specifications
145 Commits 1 Branch 0 Tags 2.5 MiB
Python 100%
Go to file
Nguyen Hai 3f3a814045 import zuul job settings from project-config 
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: Ia1739a60144bfd3d922ce506dc1277f6958c64e0
Story: #2002586
Task: #24343
 		2018-08-17 14:05:09 +09:00
doc/source fix errors due to new validations 2018-06-14 13:27:24 +00:00
specs Merge "Add proposal "Vitage high availability - fast failover"" 2018-06-25 08:59:13 +00:00
tests Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
.gitignore Switch to stestr 2018-07-04 13:54:56 +07:00
.gitreview Added .gitreview 2015-11-06 06:43:41 +00:00
.stestr.conf Switch to stestr 2018-07-04 13:54:56 +07:00
.zuul.yaml import zuul job settings from project-config 2018-08-17 14:05:09 +09:00
LICENSE Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
README.rst Build sphinx doc automatically on changes 2017-11-22 09:53:43 +08:00
requirements.txt Switch to stestr 2018-07-04 13:54:56 +07:00
setup.cfg Update docs build job for new documentation PTI jobs 2017-12-26 09:04:01 +08:00
setup.py Initial setup of vitrage-spec project 2015-11-06 13:56:56 +02:00
tox.ini Switch to stestr 2018-07-04 13:54:56 +07: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.

To build the document automatically on changes, use the command:

$ tox -e autobuild

Then open in a browser http://localhost:8000