Files
keystone/doc/source/index.rst
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

3.1 KiB

Keystone, the OpenStack Identity Service

Keystone is an OpenStack service that provides API client authentication, service discovery, and distributed multi-tenant authorization by implementing OpenStack's Identity API.

This documentation is useful for contributors looking to get involved in our community, developers writing applications on top of OpenStack, and operators administering their own OpenStack deployments.

This documentation is generated by the Sphinx toolkit and lives in the source tree. Also see the getting-started/community page for other ways to interact with the community.

In addition to creating OpenStack's Identity Service, the Keystone team also provides a WSGI middleware, an Authentication library and a Python client library.

Installation Guides

install/index.rst

General Information

This section contains general information related to keystone which is relevant to developers, users and operators. For documentation specific to any of these three, please see the subsequent sections.

getting-started/index.rst code_documentation.rst indices-tables.rst

Contributor Documentation

This section contains the documentation needed for developing keystone.

contributor/index.rst

User Documentation

This section contains the documentation for end-users of keystone.

user/index.rst

CLI Documentation

This section details information related to keystone management commands.

cli/index.rst

Administrator Guides

admin/index.rst

Configuration Options

configuration/index.rst