Commit Graph

296 Commits

Author SHA1 Message Date
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 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 0b29be3302 Move supported clients section to user guide
Additionally, correct examples to use proper v3-style credentials.

Change-Id: Ie64a691a12175ca74a5ac7ea90217f68607beb06
2018-12-10 16:53:02 +01:00
Colleen Murphy 4e39e2abe5 Move SSL recommendation to installation guide
As part of the docs consolidation effort, move the SSL recommendation to
the installation guides for each distro. This also corrects the wording:
"running in a web server" is not necessarily secure on its own, the web
server must be configured to use SSL.

Change-Id: If0b547680cbbea4c7f29d82de3f4fe96bd14b4ec
2018-12-10 15:55:13 +01:00
Colleen Murphy c04756e0cd Move "Public ID Generators" to relevant docs
Currently, the section "Public ID Generators" is a subsection of
"Identity sources" but it reads as very out of place. Looking at the
commit that introduced the section (1a50986e7c), it's clear this was
meant to be part of the domain-specific-config section and was missed in
a reshuffle. This patch puts it back in place.

Change-Id: I2873f104adf6af4da4ba23f8c0d8afb0c1161da3
2018-12-10 13:52:47 +01:00
Colleen Murphy fed5f52c8a Consolidate catalog management guide
We already have an admin guide on creating services in the catalog and
creating service users, so reduce the duplication in the configuration
guide.

Change-Id: I1de964753b8c6c95af10b8c84501e4f74ca382e4
2018-12-07 15:31:42 +01:00
Zuul f81e028ba7 Merge "Consolidate endpoint-policy.rst" 2018-11-24 03:37:47 +00:00
Zuul 5945d10b13 Merge "Consolidate service-catalog.rst" 2018-11-24 03:15:29 +00:00
Suramya Shah ed6366813d Consolidate identity-domain-specific-config.rst
Consolidate from configuration.rst into identity-domain-specific-config.rst.

Change-Id: Id989342e31be31a3c5cb946ff2177ffa5a8f47a8
2018-11-22 21:06:21 +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
Arica Chakraborty 028abcb597 Changed the port numbers
Before keystone needed to be run on two separate ports to
accommodate the Identity v2 API which ran a separate
admin-only service commonly on port 35357. With the removal
of the v2 API, keystone runs only on port 5000.

Change-Id: I012662ea2af80441c99bafee757569d8b0d40ff3
2018-11-03 19:13:28 +05:30
Colleen Murphy 427cab6792 Delete "Preparing your environment" section
The "Preparing your environment" section on the configuration page is
out of date as it still refers to the service token. It is also out of
place for this page and is redundant with the installation guide[1] and
the developer environment guide[2]. Just delete it.

[1] https://docs.openstack.org/keystone/latest/install/index.html
[2] https://docs.openstack.org/keystone/latest/contributor/set-up-keystone.html

Change-Id: I1e3a17044260b2ca378a01c836b3fb6bfabe0e6d
2018-10-30 11:30:58 +01: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
Zuul 5de6fd0237 Merge "Consolidate identity-token-binding.rst" 2018-03-11 02:12:11 +00:00
Zuul 95bff6fbcd Merge "Consolidate identity-service-api-protection.rst" 2018-03-07 22:55:56 +00:00
Suramya Shah c7ef448035 Consolidate identity-token-binding.rst
Consolidate from configuration.rst into identity-token-binding.rst

Change-Id: Id62e7a245b8cf1c751e21395a30fee340d5bfbe0
2018-02-24 20:03:01 +05:30
Suramya Shah d5d6621598 Consolidate identity-service-api-protection.rst
Consolidate configuration.rst into identity-service-api-protection.rst.
[0] shows the location to the file with identical contents:
[0] https://github.com/openstack/keystone/blob/master/doc/source/admin/identity-service-api-protection.rst
Change-Id: Ia5a8650843300ce99ac239e5da2962e8cae27a73
2018-02-24 19:47:32 +05:30
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 f6b6691d2e Remove v2.0 from documentation guides
This commit removes all references to v2.0 from various guides found
under doc/source/.

Change-Id: I7c2ef1c9323faccc1ec371803f85f34890481f32
2018-02-06 22:19:37 +00:00
Samriddhi Jain 82785553dd Updated URLs in docs
With the docs migration and re-arrangement, some docs
have been shifted to new places, however the referenced
links are still old. Some of them give 404 error or
just point to the home page. This patch fixes those URLs.

Change-Id: Ie6b18ab3d4aa346dac8436dd426277fee4f07fcd
2017-08-09 23:46:33 +05:30
Jenkins 6167850d12 Merge "Consolidate certificate docs to admin-guide" 2017-08-09 14:12:09 +00:00
Jenkins f6602dc02c Merge "Fill in content in CLI Documentation" 2017-08-08 23:08:50 +00:00
Samriddhi Jain c326ae0417 Fill in content in CLI Documentation
Added keystone-manage documentation from man pages
to the placeholder created for CLI Documentation.

Change-Id: I0e259c76d96c6479a6165c535bc49c032b2f41da
2017-08-08 21:58:50 +05:30
Jenkins 86b4b4a747 Merge "Move url safe naming docs to admin guide" 2017-08-08 02:48:20 +00:00
Jenkins 156fa9389a Merge "Move credential encryption docs to admin-guide" 2017-08-07 21:31:47 +00:00
Jenkins 0cbd421da6 Merge "Remove duplicate configuration sections" 2017-08-03 02:15:12 +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
Jenkins 9f03a88fdf Merge "Consolidate LDAP documentation into admin-guide" 2017-08-02 16:58:33 +00:00
Lance Bragstad c1e9c97d33 Consolidate LDAP documentation into admin-guide
This commit merges two documents that were both attempting to
document integrating keystone with LDAP. Instead, we should have a
single document so that it's easier to operators to understand and
find.

Change-Id: I1b1927b498d93f39d57a03b60384de22f07ad2f2
2017-08-02 13:55:41 +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 64165b8609 Consolidate certificate docs to admin-guide
The admin-guide and configuration.rst both had separate sections
that detailed certificate documentation. Much of the documentation
was exactly the same. Now that keystone owns it's own admin-guide,
we can remove the duplication and simplify our docs.

Change-Id: I387902723637174c259ff421083a2933942f07fd
2017-07-25 22:03:50 +00:00
Lance Bragstad e2ebb3c41a Move auth plugin development doc to contrib guide
The operator documentation had a section specific to developing
authentication plugins. This type of documentation is better suited
to the contributor guide. This commit moves it there.

Change-Id: I74337e8b3d8c9031fa3cb7fb709cc41042161bb9
2017-07-25 14:58:39 +00:00
Lance Bragstad 2c6458c355 Remove duplicate configuration sections
Keystone nows has it's own configuration guide, which means we no
longer need to maintain a separate configuration reference in the
operator guide.

Change-Id: Iadfb90db9f5f23798d57a442e372d35519332a49
2017-07-17 15:04:28 +00:00
Lance Bragstad a393792028 Move bootstrapping documentation to admin-guide
The operator documentation had two sections that described
bootstrapping keystone. This is better suited for the admin-guide
and this commit moves it there.

Change-Id: Ibca2bc3e439ca6e26d8e4ead13ed101fd9010f12
2017-07-15 20:04:57 +00:00
Lance Bragstad 6ae5cbc383 Move caching docs into admin-guide
The admin-guide and configuration guide both had separate sections
dedicated to documenting caching. This patch attempts to consolidate
them into a single section in the admin-guide. It also takes the
opportunity to update a couple pieces of information that have
changed since writing the original docs in configuration.rst.

The old configuration section also reference a lot of configuration
options for caching. These were removed because they should be
documented in the configuration guide.

Change-Id: Ifb39075a6a78419e5c44c7e0871f3e1c055c2332
2017-07-07 02:08:28 +00:00
Jenkins b9b3b5c389 Merge "Remove duplicate token docs" 2017-07-05 20:22:40 +00:00
Lance Bragstad 935c43b6c8 Remove duplicate token docs
Now that the admin guide is within keystone, we can remove all the
operator specific information we were maintaining in tree. This will
make it easier to operators to find all the information they need
related to tokens.

Change-Id: Iac2bf86a7b06b54fe8edea6ddbc62fe576b8959c
2017-07-05 15:56:13 +00:00
Jenkins 1299318c08 Merge "Remove duplicate logging documentation" 2017-06-28 19:23:29 +00:00
Lance Bragstad 0f5d093259 Remove duplicate logging documentation
The admin-guide now lives within keystone and it contains a copy of
the logging documentation we were maintaining in configuration.rst.
This change remove the duplicated documentation in favor of the copy
in the admin-guide:

  https://docs.openstack.org/developer/keystone/admin/identity-keystone-usage-and-features.html

Change-Id: I2a3e5ea4d87047e569c3b010a0ca85db8fc4a982
2017-06-27 16:07:41 +00:00
Jenkins 80202297ec Merge "Remove the revocation api config section" 2017-06-27 00:22:03 +00:00
Lance Bragstad 3157d0086f Move token flush documentation to admin-guide
This commit moves the token cleanup documentation we had on our
configuration.rst to the official admin-guide. This is an effort to
consolidate all admin-like information into a single place for easier
discoverability and more consistent documentation.

Change-Id: I9e02fbe366a13e86d1be5cba46df71c4ff725b9d
2017-06-26 20:51:16 +00:00
Lance Bragstad e2b0ba21e6 Remove the revocation api config section
In parsing the configuration.rst doc and porting important bits over
to the admin-guide, I noticed the revocation events section isn't
very accurate.

The revocation API (GET /v3/OS-REVOKE/events) has been deprecated and
only returns an empty list, since it was only used for PKI/Z tokens,
which are no longer supported by keystone.

Otherwise revocation events are a structure that keystone only uses
internally. This commit removes it from the configuration.rst guide.
The information that was accurate in the guide is already documented
in configuration and the API.

Change-Id: I45d16fd50239efc543fe20b228b021f65cfd104d
2017-06-26 19:35:44 +00:00
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
Colleen Murphy dd298f66f7 Update dead API spec links
The API specifications were moved out of the specs repo and into the
api-ref directory of the main keystone repo[1]. This patch updates some
of the straggler links in the configuration docs that still referenced
the old location.

[1] https://review.openstack.org/#/c/342399/

Change-Id: I883cfb4ab8b65873286f46194a8c8ccd7af97dd2
2017-05-01 21:15:02 +02:00
David Stanek 928d23db02 Removed the deprecated pki_setup command
bp removed-as-of-pike

Change-Id: Ib39d21ed547e3be7a3a2c333a7193f990043a80b
2017-03-29 00:15:09 +00:00
Ubuntu 62c4897092 Add a note to db_sync configuration section
This patch just adds a note under the configuration section for
rolling upgrades to inform the user that
``keystone-manage db_sync --check`` is now available to run when
they would like information about the status of their upgrade.

Change-Id: I29e2ccd8973443daf592aaa45bb4e8167327c7cc
2017-03-24 17:23:09 +00:00
jolie 6748673948 Fix typo in config doc
Change-Id: I3095fe4bd7dbe6a6fb056819cd68d952570a0f02
2017-02-20 10:32:30 +08:00