openstack/keystone-specs
Code Issues Proposed changes
OpenStack Identity (Keystone) Specifications
100 Commits 1 Branch 0 Tags 14 MiB
Python 100%
393b7ea7e9
Go to file
Rodrigo Duarte Sousa 393b7ea7e9 API documentation for Hierarchical Multitenancy 
Changes regarding the functionality of Hierarchical Multitenancy

- Changes in the Keystone API considering projects hierarchy.

Co-Authored-By: Rodrigo Duarte <rodrigods@lsd.ufcg.edu.br>
Depends On: blueprint hierarchical-multitenancy

Change-Id: Ieecb24c07e5e9d5e7215398244057a6d87501cfc
2014-11-11 10:50:01 -03:00
api/v3 API documentation for Hierarchical Multitenancy 2014-11-11 10:50:01 -03:00
doc/source Prep to add Identity API v2.0 files 2014-10-27 23:10:14 +00:00
specs Merge "add v3 API documentation" 2014-10-22 02:33:38 +00:00
tests Add a new section that lists implemented specs for middleware 2014-10-07 16:03:37 -04:00
.gitignore Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
.gitreview Updated gitreview file for repo rename 2014-05-23 18:34:29 -04:00
.testr.conf Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
LICENSE Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
README.rst use double backticks on literals in README 2014-06-03 14:36:22 -05:00
requirements.txt add doc8 validation 2014-10-14 15:38:24 +00:00
setup.cfg Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
setup.py Updated from global requirements 2014-07-16 00:07:13 +00:00
tox.ini add v3 API documentation 2014-10-17 18:25:42 -04:00

README.rst

OpenStack Identity Specifications

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

specs/<release>/

The layout of this repository for Keystone Client is:

specs/keystoneclient/

When a release of Keystone Client is cut, the implemented blueprints will be moved to a directory specific to that release:

specs/keystoneclient/<release>/

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

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. Not all approved blueprints will get fully implemented. The implementation status of a blueprint for a given release can be found by looking at the blueprint in Launchpad:

http://blueprints.launchpad.net/keystone/<blueprint-name>

Incomplete 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 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/keystone

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:

https://wiki.openstack.org/wiki/Gerrit_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.