OpenStack Identity (Keystone) Specifications
Go to file
Rafael Weingärtner 2170b9176d Add schema version and support to "domain" attribute in mapping rules
As discussed in the Keystone meeting [1], I am proposing this spec, so
we can review and discuss the implementation proposed in [2].

[1] http://eavesdrop.openstack.org/meetings/keystone/2020/keystone.2020-08-25-16.59.log.txt
[2] https://review.opendev.org/#/c/739966/

Change-Id: I84426119a60c595eaf462662c6a24a990914c516
Implements: blueprint versioning-for-attribute-mapping-schema
RFE: https://bugs.launchpad.net/keystone/+bug/1887515
2023-11-20 17:40:45 -03:00
attic Move SP endpoint filters spec to attic 2019-05-13 11:46:20 -07:00
doc/source Add schema version and support to "domain" attribute in mapping rules 2023-11-20 17:40:45 -03:00
specs Add schema version and support to "domain" attribute in mapping rules 2023-11-20 17:40:45 -03:00
superseded add a README file to the superseded spec folder 2017-01-06 21:37:51 +00:00
tests Add a new section that lists implemented specs for middleware 2014-10-07 16:03:37 -04:00
.gitignore Switch to stestr 2018-08-21 11:05:51 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:43:00 +00:00
.stestr.conf Switch to stestr 2018-08-21 11:05:51 +00:00
.zuul.yaml Disable auto-discovery for setuptools and update python testing 2022-06-07 12:16:12 +02:00
LICENSE Initial Commit for Identity-specs repo 2014-05-22 16:49:00 -07:00
README.rst Update links in README 2018-06-12 16:25:41 +08:00
requirements.txt OAuth2.0 Client Credentials Grant Flow Support 2022-01-28 14:20:34 +09:00
setup.cfg Cleanup py27 support 2020-04-10 10:50:16 +02:00
setup.py Disable auto-discovery for setuptools and update python testing 2022-06-07 12:16:12 +02:00
tox.ini OAuth 2.0 Mutual-TLS Support 2022-12-13 23:54:11 +09:00

README.rst

Team and repository tags

image

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.

For specifications that have been reviewed and approved but have not been implemented:

specs/backlog/

Specifications in this directory indicate the original author has either become unavailable, or has indicated that they are not going to implement the specification. The specifications found here are available as projects for people looking to get involved with Keystone. If you are interested in claiming a spec, start by posting a review for the specification that moves it from this directory to the next active release. Please set yourself as the new primary assignee and maintain the original author in the other contributors list.

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>

Warning

Specifications not accepted by the second milestone of a release will not be targeted for that release without an explicit exception granted. To request an exception, send an email to the developer mailing list with the details of the specification, why it should be accepted after the deadline, and any supporting documentation (e.g. proof of concept code) that will indicate to the core team it will be completed before feature freeze.

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:

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.