Commit Graph

35 Commits

Author SHA1 Message Date
Samriddhi Jain 459f078d0c Reorganised keystone documentation structure
Divided the keystone docs into four categories, depending
upon the usage criteria: general information (which will
be common for all), developer documentation,
user documantation and operator documentation.

Change-Id: I2f5dd41acd9874739accc54c4f4fd69460b58334
2017-06-22 13:26:46 +05:30
zlyqqq 9fb8af1360 Role name is unique within the owning domain
The commit has not been modified completely.
https://review.openstack.org/#/c/457835/

Change-Id: I91e2ec59d858c406cf18c513934a38bca5540369
2017-05-13 15:27:00 +08:00
huangtianhua b447b528a3 Role name is unique within the owning domain
Keytone supports to create roles with same name
in different domains, this fixes the doc nit.

Change-Id: I5da0bedef6cb9153054240502a09962cf3256fd2
2017-05-06 04:22:03 +00:00
Kenny Johnston d414418e9e Readability enhancements to architecture doc
Various readability and structure enhancements to
architecture.rst

Change-Id: I26985536168b775672f56ea3d597ae83950bcf2f
2017-04-25 13:09:47 +00:00
Steve Martinelli 4c5b15e3db Move docs from key_terms to architecture
there is a lot of overlap between the two docs, let's have a
single doc instead.

also clean up the references to modules as they have bitrotted.

Change-Id: I05d30fa51052b875b1de94c4152036b1d0768793
2016-11-21 11:05:44 -05:00
Eric Brown a74be79b05 Updates to the architecture doc
The text in the architecture doc is somewhat out-of-date for the
current function level of keystone. Edits include:

* Removed references to domain, project, role information in LDAP.
* Removed capitialization of keystone objects
* Some line wrap adjustments
* Updated link on oslo.policy location

Change-Id: Iefcaf00c8844613b10a2cf77a820db7fe0934742
2016-11-10 14:14:34 -08:00
Ronald De Rose d49f2b1e64 Move the token abstract base class out of core
This patch moves the token abstract base class out of core and
into providers/base.py, which is consistent with the other
backend drivers.

Change-Id: Icf22adb2ccfa0470bb61ceb7d6c90467f44da6c8
Closes-Bug: #1563101
2016-10-14 04:09:14 +00:00
Ronald De Rose bbcc1eff7a Remove driver version from docs
Change-Id: I99c073e6cabd87ef93e9708d191c2586ec58b64a
2016-10-06 17:44:26 +00:00
Dolph Mathews 141970f193 Remove mention of db_sync per backend
Many releases ago, we supported the notion of having migration
repositories per backend interface. If a backend needed to use the
database, it could manage it's own migrations independently from the
rest of keystone. That functionality was removed long ago, and this
blurb of text should have been removed with it.

Change-Id: If90e25ec556cf42322509ef28878e96120b0baad
2016-08-04 12:09:35 -05:00
Ronald De Rose 9f5ed12c11 Doc update for moving abstract base classes out of core
This patch updates the service backends documentation, updating the
location for the abstract base classes (out of core and into
backends.base).

Closes-Bug: #1563101

Change-Id: I0b4ce448ba94ec09294b07f704ee07d433049ac8
2016-07-07 18:03:51 +00:00
Ronald De Rose b316b14138 Dev doc update for moving abstract base classes out of core
As part of an effort to remove backend dependencies on higher level
classes, this patch updates the dev docs, defining a standard as to
where abstract base classes are located and named.

Partial-Bug: #1563101

Change-Id: I784e344f333ee616bda800f63af0b1c149a529f3
2016-04-06 18:14:27 +00:00
Pandiyan b90160d4c6 Add driver details in architecture doc
Added missing keystone driver details in architecture doc

Change-Id: Iac6d4008d72feeffa7f12ad1fa3b1d6c2cd634fe
Closes-Bug: #1546189
2016-03-01 03:26:42 +00:00
Vivek Dhayaal ba317dedd8 Stable Keystone Driver Interfaces
Extended support for versioned driver classes to the rest of the
backends based on the design of the initial support for catalog backend @
https://review.openstack.org/#/c/218481/

partially Implements bp stable-driver-interfaces

Change-Id: I0078f6dc32932beb6db534ecf22b160097c5a090
2015-09-02 06:10:26 +00:00
Henry Nash f01cd89bd0 Split the assignments controller
This is the final part of the more comprehensive split of
assignments, which rationalizes both the backend and controllers.
In order to make this change easier for reviewers, it is divided
into a number of smaller patches. This patch divides up the
assignment controller, giving resource its own controller.

Previous patches have:
- Moved role management into its own manager and drivers
- Fixed incorrect doc strings for grant driver methods
- Updated controllers to call the new role manager
- Updated unit tests to call the new role manager
- Refactored the assignment manager and drivers enabling
  projects/domains to be split out
- Fixed incorrect comment about circular dependency between
  assignment and identity
- Moved the logically separated project and domain
  functionality into their own manager/backend (called resource).
- Removes unused pointer to assignment from identity driver
- Uddated controllers and managers to call the new resource
  manager
- Updated tests to call the new resource manager

Partially implements: bp pluggable-assignments
Change-Id: Ic7a4dbe9e39c1910ecc23b37d0b798955544fde4
2015-02-10 14:34:42 +00:00
Jenkins ab627dae92 Merge "Move projects and domains to their own backend" 2015-01-30 22:01:57 +00:00
Jenkins 7466a5701c Merge "Documentation fix for Keystone Architecture" 2015-01-29 23:48:16 +00:00
Henry Nash 0e05353d09 Move projects and domains to their own backend
This is the part of the more comprehensive split of
assignments, which rationalizes both the backend and controllers.
In order to make this change easier for reviewers, it is divided
into a number of smaller patches.

Previous patches:

- Move role management into its own manager and drivers
  (see: https://review.openstack.org/#/c/144239/)
- Fix incorrect doc strings for grant driver methods
  (see: https://review.openstack.org/#/c/144403/)
- Make controllers call the new, split out, role manager
  (see: https://review.openstack.org/#/c/144494/)
- Make unit tests call the new, split out, role manager
  (see: https://review.openstack.org/#/c/144548/)
- Refactor the assignment manager and drivers, enabling
  projects/domains to be split out
  (see: https://review.openstack.org/#/c/144650/)
- Fix incorrect comment about circular dependency between
  assignment and identity
  (see: https://review.openstack.org/#/c/144850/)

This patch moves the now logically separated project and domain
functionality into their own manager/backend (called resource).

Future patches will:

- Remove unused pointer to assignment in identity driver
- Update the controllers to call the new resource manager
- Update the tests to call the new resource manager
- Split the assignment controller, giving projects/domains
  their own controller

Partially implements: bp pluggable-assignments

Change-Id: I0ff1c2fa30237734d0a25d03dad5be03eb166367
2015-01-29 16:40:24 +00:00
Kamil Rykowski abeb6c48f0 Documentation fix for Keystone Architecture
During reading the Keystone Architecture documentation I've found a nit
issue under the Service Backends section. There is a missing "be" in the
sentence "Each of the services can configured to". Additionally double
space has been removed from LDAP backend session.

Change-Id: Ie9044cb251edf24ec3d6263769461ed9ff922e86
2015-01-29 17:08:47 +01:00
Henry Nash 3408515e8c Split roles into their own backend within assignments
This is the first part of the more comprehensive split of
assignments, which rationalizes both the backend and controllers.
In order to make this change easier for reviewers, it is divided
into a number of smaller patches.

Follow-on patches will:

- Fix incorrect doc strings for grant driver methods
- Update unit tests to call the new role manager
- Update the assignment controller to call the role manager
- Refactor assignment manager and driver methods to logically
  separate project/domains from the actual assignments
- Split projects and domains into their own backend
- Split the controllers so they call the correct manager
- Update the tests to call the new correct manager

Partially implements: bp pluggable-assignments

Change-Id: I41fc23a049c26e514222a966c1847e183448be00
2015-01-14 04:36:49 +00:00
Steve Martinelli 5d376ba9ad Update docs to no longer show XML support
implements bp removed-as-of-kilo

Change-Id: Ib78132093cc0ab9b964013b20734ada1039f0679
2014-12-16 22:51:26 -05:00
Steve Martinelli 2e32765413 Update architecture documentation
The architecture docs are very dated, and have several references
to tenants, PAM backends, and controllers that don't exist.

Change-Id: I85de743006e7df4fcf8ddbc3afc1a4bcd69583e6
2014-09-25 02:12:43 -04:00
Jenkins 34fe6b4c80 Merge "Fix Policy backend driver documentation" 2014-09-24 18:29:16 +00:00
Lance Bragstad feabb3404b Fix Policy backend driver documentation
Change-Id: If5e0655eb6733cca1294d780f3a9446ed4ada357
Closes-Bug: #1362007
2014-09-10 15:42:49 +00:00
Steve Martinelli a02d95c408 Add rst code-blocks to a bunch of missing examples
Several examples were either missing code-blocks entirely,
this patch added either bash or python, so the rendered HTML
is nicer.

Change-Id: Ia145dc78a871dc27cf0926ea1ef9cf9b6df564b7
2014-09-04 17:13:23 -04:00
Steve Martinelli 2fdb53d461 Capitalize all instances of Keystone in the docs
There were quite a few instances of `keystone` where `Keystone`
should have been used. Code examples were not changed, since that
would break things.

Change-Id: I533ad1b71cc3af1b70bb54cca0a820aaad3f62da
2014-09-04 12:29:01 -04:00
Steve Martinelli 5dbb794347 Fix spelling mistakes in docs
Noticed a bunch of minor spelling mistakes.

Change-Id: I8189dda5a78418820e6c56270089590ef87f1495
Closes-Bug: #1323361
2014-05-26 12:52:20 -04:00
Fabio Giannetti d7be2902ad Style the code examples in docs as python
Add the appropriate styling macro for the code snippets in the
documentation. This change highlights the language syntax making
the documentation more readable.

Closes-Bug: #1276299

Change-Id: Id331be204f688ccbb6e9f2c7ab9287310477312b
2014-02-10 12:42:17 -08:00
Sean Winn 0331f8a58a Changed header from LLC to Foundation based on trademark policies
Fixes: Bug 1214176

Change-Id: Ie937081a53d377671b8b88f422642c8131002f88
2013-09-05 15:03:32 -05:00
David Stanek ceb017071d Removes KVS references from the documentation
KVS backends are deprecated and removing references to them from the
documentation will discourage their use.

Change-Id: Iad2f9c39f9d92465ada5ecb6001cfc2b225cc01f
Related-Bug: #986980
2013-08-28 19:45:07 -04:00
Francois Deppierraz 03de2ef3f4 Fix typo: Tenents -> Tenants
Change-Id: I3cbef892af708368bffe8f503299be3cf8f3c030
2013-07-30 13:33:56 +02:00
Alan Pevec bf495949bc fix sphinx warnings
also disable building old docs

Change-Id: I0bbbb2b702a12bd9acb79f89b5b5c92cffeec779
2012-06-22 20:01:48 +02:00
Dolph Mathews 352839b9c9 Policy doc updates; RST syntax consistency
Change-Id: I087ba16c4c629291fbec9c59fcff873fef8b0213
2012-05-03 12:07:54 -05:00
Adam Gandelman 9363d5fea6 Properly return 501 for unsupported Catalog calls
Similar to the other APIs, this creates a Driver class that describes
expected functionality of the catalog driver and raises NotImplemented
accordingly. NotImplementedError()'s are caught and returned as proper
501s instead of AttributeErrors.

Also fixes some inconsistent paramters names in the sql backend.

Fixes bug 954087

Update: Convert usage of NotImplementedError() to new
        keystone.exception.NotImplemented() for all
        unimplemented driver actions.

Change-Id: I69d8e21a6f651e69b724ec5ed5784645bad80c00
2012-03-14 11:30:02 -07:00
Adam Young 5b3e05bbab added LDAP section to architecture and architecture
https://bugs.launchpad.net/keystone/+bug/949521

Bug 949521

Change-Id: I2e37c0d946e3d97a2c4bc4bf4a50bd94466f70c2
2012-03-13 19:30:39 -04:00
Monty Taylor f8ba5af130 Align with project configs.
* docs in doc/ rather than docs/
* write out changelog from git
* freeze requirements file

Change-Id: If28d5414f7b2747fd6835546c45e1acfac8a3563
2012-03-01 11:42:42 -08:00