Commit Graph

34 Commits

Author SHA1 Message Date
Hiromu Asahina f6ab28218e Fix presentation of OAuth2.0 user guides
Applied remining comments to the first OAuth2.0 documentation patch [1].

[1] https://review.opendev.org/c/openstack/keystone/+/838108

Change-Id: I95aac0b4ac4e887b79ef5b15ac5cb3d356c26735
2023-06-27 23:55:18 +09:00
Yusuke Niimi b438bf1efe Add doc of OAuth2.0 Client Credentials Grant Flow
This patch provides Keystone documents for OAuth2.0 client
authorization. The specification about new API is added to API
Reference. Also OAuth2.0 client credentials grant flow is added to
admin guide.

Implement: blueprint oauth2-client-credentials-ext
Change-Id: I6ac5835fb64a4e81f34f7b8631d255b2bb7f66da
2023-04-17 08:04:36 +00:00
Colleen Murphy 74c1d5aa34 Reorganize admin guide
Now that most of the operator docs are consolidated into the admin
guide, it is huge and hard to find things. This patch breaks the guide
into groups to make it a little easier to navigate:

1. Getting started: basics of keystone and initializing a deployment.
2. Configuration: not a replacement for the main config docs but a
   grouping of all discussions on the various config options.
3. Operations: maintenance workflows like upgrading and cleanups
4. Tokens: an important part of keystone
5. RBAC: gets a section to itself
6. Advanced keystone features: grouping of lesser-known/lesser-used,
   not-required features.
7. Authentication mechanisms: various auth methods besides password,
   including the federation guide

Change-Id: I9039b7023d843349154d28ee0ee2c7b9a9eb97ab
2018-12-14 10:08:10 +01:00
Colleen Murphy 652a8b39a8 Consolidate service catalog docs
Part of the "manage services" document was redundant with the "service
catalog" document. This change combines the two, additionally adding a
note about how to create an endpoint once a service is created.

Change-Id: Ieee33fb73a61bc2d4d1746a05b9497740a99440d
2018-12-14 09:56:09 +01:00
Zuul 7b73122190 Merge "Split trusts docs between admin and user guide" 2018-12-14 08:44:59 +00:00
Zuul 7880b3bb86 Merge "Move identity sources doc to admin guide" 2018-12-13 03:19:15 +00:00
Colleen Murphy f4b0061303 Delete outdated keystonemiddleware doc
We don't recommend using admin_user and admin_password in
[keystone_authtoken] anymore, those are very deprecated[1]. We have a
relatively up-to-date example in the keystonemiddleware docs[2].

[1] http://git.openstack.org/cgit/openstack/keystonemiddleware/tree/keystonemiddleware/auth_token/_auth.py?h=5.3.0#n30
[2] https://docs.openstack.org/keystonemiddleware/latest/middlewarearchitecture.html#configuration

Change-Id: I55961711f526a35ba0e1edb542b124b9eb330d5d
2018-12-12 11:38:52 +01:00
Colleen Murphy 05ff55e250 Remove example usage from admin guide
It's redundant with the supported clients docs[1] and the managing
projects users and roles docs[2].

[1] https://docs.openstack.org/keystone/latest/user/supported_clients.html
[2] https://docs.openstack.org/keystone/latest/admin/cli-manage-projects-users-and-roles.html

Change-Id: I8549e4e7123d719fadfbfeddf20781e90ccb541c
2018-12-12 11:33:12 +01:00
Colleen Murphy 79165aa469 Split trusts docs between admin and user guide
Trusts are user-facing, so explaining how they work should be in the
user guide. Cleaning up expired trusts is still an administrative task,
so leave that in the admin guide.

Change-Id: I9a77efd3c93c9b5b504c8143a51fb08b50139119
2018-12-12 11:17:04 +01:00
Colleen Murphy 46b30535cf Move identity sources doc to admin guide
Move the identity sources support matrix to the administrator guide and
clean up the remainder of the configuration page and the operator guide.

Change-Id: If6978121873b6b4a5438164f082f359688477298
2018-12-12 08:45:34 +01:00
Colleen Murphy d46f58fdd9 Remove Certificates for PKI guide
The "Certificates for PKI" guide is about generating certificate pairs
for signing PKI tokens, which we don't support anymore. Remove the
crufty guide.

Change-Id: I0aff718cf580892d3e5378c6705c089f496c88fd
2018-12-11 16:06:35 +01:00
Colleen Murphy 06a50907ce Move list limit docs to admin guide
Change-Id: I434982dbf71679cca2bc0dd8bb142d23e009e06a
2018-12-11 11:45:20 +01:00
Colleen Murphy ccb3d340e4 Rename admin guide pages
Some of the admin guide pages were prefixed with "identity-" because
they came from the centralized install guide or operators guide or
security guide or somewhere else. We don't need the prefix, everything
in keystone is identity. Remove the prefix from the affected pages so
that everything is consistent.

Change-Id: Icd172a39fe720472f1fb15395178f90282696ac9
2018-12-11 11:43:50 +01:00
Colleen Murphy 151635e224 Consolidate tokenless X.509 docs
Move these to the admin guide and remove the empty "advanced topics"
section.

Change-Id: Iee9e5e622aa2f0c8a19d0114d51840b82f70fee3
2018-12-11 10:16:34 +01:00
Suramya Shah b3c89e8c3f Consolidate Keystone docs: admin/identity-external-authentication.rst
Consolidate advanced-topics/external-auth.rst into
admin/identity-external-authentication.rst.

Change-Id: Ic4e9c37f41c4998fbdfe4b21c7b57b2de4776432
2018-12-11 10:00:38 +01:00
Suramya Shah fdf7a5b66d Consolidate Keystone docs: federated-identity.rst
Consolidate advanced-topics/federation into the admin guide.

Change-Id: I35c3d261ecf7c042c30c1272d4af85a0916515e2
2018-12-08 19:09:21 +01:00
Suramya Shah dc3b8edaac Consolidate auth-totp.rst
Consolidate from advanced-topics/auth-totp.rst into admin/auth-totp.rst.

Change-Id: I5cbc2c7d87df5c4d4f3c5cffb238f9c91aa2724c
2018-11-22 19:51:40 +01:00
Suramya Shah 3daeeb4f21 Consolidate event_notifications.rst
Change-Id: I66afc49dac0ba8b9d90fe90715894042f469db20
2018-11-22 19:49:33 +01:00
Suramya Shah f1ad6654db Consolidate endpoint-policy.rst
Consolidate from configuration.rst into endpoint-policy.rst.

Change-Id: I80184005cc70a1e769fd3507360aa7d795785f5c
2018-11-22 19:45:05 +01:00
Suramya Shah 53f0b62e8e Consolidate service-catalog.rst
Consolidate from configuration.rst into admin/service-catalog.rst.

Change-Id: I3446f5e8ac7dc5ea2db180b0039b9f66d3f703e7
2018-11-22 19:41:54 +01:00
Lance Bragstad 7f8c1a3069 Document user options
User options have been available in keystone for a few releases but
there isn't any official documentation for them.

This commit add a general section to the administrator guide that
attempts to describe each options and its type.

Change-Id: Ib0cc07236ba9083c2a35bf8ac6444ccfd19b7219
Related-Bug: 1792026
2018-11-20 08:59:42 +00:00
Vishakha Agarwal df982016dd Remove deprecated "bind" in token
The 'bind' option was deprecated and is
in no use now, thus removing it. Also
removing its rst file.

bp:removed-as-of-stein
Change-Id: Ie355733dc031b3c4908fdc4e44f8f1220cff456c
2018-11-09 07:22:52 +05:30
Colleen Murphy 77d59635d3 Delete the external auth admin guide
There is already a more extensive guide in the advanced topics
section[1] so this stub guide does not provide any value and feels out
of place. Remove it to avoid duplication and confusion.

[1] https://docs.openstack.org/keystone/latest/advanced-topics/external-auth.html

Change-Id: I2b96f4bf285cf5cc79ab0c44685bc15b5d9b61e9
2018-10-28 19:02:34 +01:00
Colleen Murphy 914885fefd Delete administrator federation guide
The federated-identity guide in the admin section is out of date
relative to the one in the operator section. It is sort of incoherent
and the information within it that is valuable is already present in the
other guide. Delete this guide in favor of just promoting the operator
guide.

Related-bug: #1793374

Change-Id: I8c0190725d0f7297957bbf10fd9d7184e52ff5f3
2018-10-25 22:04:56 +02:00
Gage Hugo 22af20b0f6 Add docs for case-insensitivity in keystone
This adds a new page of documentation to describe how keystone handles
case sensitivity (or the lack of) depending on the resource and
backend used.

Change-Id: I868b43e6be7809648f9260e1b272f5626b30a95d
2018-07-10 20:29:21 +00:00
Suramya Shah 6bac0a1bae Consolidate oauth1.rst
Consolidate from configuration.rst into oauth1.rst.

Change-Id: I866e147935e5847a2feb66d61d45ef4241eb38cd
2018-05-11 15:09:01 -05:00
Suramya Shah 641694ce19 Consolidate health-check-middleware.rst
Consolidate from configuration.rst into admin/health-check-middleware.rst.

Change-Id: Ib4de0a26975641ae6bc44a4525423628a2a04a3c
2018-05-08 17:27:41 -05:00
Suramya Shah 7abb53fb05 Consolidate endpoint-filtering.rst
Consolidate from configuration.rst into endpoint-filtering.rst.

Change-Id: Ie6ba10b71b1a25f8aa0470235b27723c529a6288
2018-02-23 12:25:47 +05:30
Lance Bragstad 005f462089 Add documentation describing unified limits
This commit add some high-level documentation from the unified limit
specification to the administrator guide. A subsequent patch will
elaborate on enforcement models.

bp unified-limits

Change-Id: Ic644a7073fb8eeed9427b8c702ba2fa15fd4a9d5
2018-01-26 22:12:28 +00:00
Jenkins 86b4b4a747 Merge "Move url safe naming docs to admin guide" 2017-08-08 02:48:20 +00:00
Lance Bragstad 8c05a873a7 Move credential encryption docs to admin-guide
This is part of an effort to consolidate all the content in the
Operator guide into the Administrator guide.

Change-Id: I3431ecbff399bf6ae7620996e4c4cce9bb3489eb
2017-08-02 19:11:51 +00:00
Lance Bragstad 8dd5bcf56d Move url safe naming docs to admin guide
This is part of an effort to consolidate everything from the Operator
guide into the Administrator guide.

Change-Id: I76b0eaee11f5a8d68304a163381c905611edd43b
2017-07-28 21:02:32 +00:00
Lance Bragstad b614a0ce8a Move performance documentation to admin-guide
Now that the admin-guide lives within keystone, it should be home to
our performance documentation.

Change-Id: I522cf238a977e9cead384fcf993300e7f8c2a395
2017-07-26 14:59:24 +00:00
Samriddhi Jain da5c9d7bd4 Added index.rst in each sub-directory
The doc migration spec requires each sub directory
to have an index page which could be directly
referenced in the main openstack documentation under
the topic specific pages, along with other projects.

This patch validates that and adds new files where
they are absent.

Change-Id: I180952857db758482fd767aa9f5cf6343fec9c42
2017-07-20 22:24:22 +08:00