keystone/doc/source/index.rst
Samriddhi Jain 718a046447 Added configuration options using oslo.config
There are auto generated configuration and policy guides which
were earlier manually copied and referenced. Used sphinext
module in oslo_config and oslo_policy to automatically render
those pages.

Change-Id: I2b49eb0083661cce70c5b9457fe5bd32dfe5e5e8
2017-07-10 17:34:21 +05:30

3.5 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 sontains the general information related to keystone which is commom to all the developers, users and operators. For documentation specific to the any of these three, please see the subsequent sections.

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

Contributor Documentation

This section contains the documentation needed for developing keystone.

devref/index.rst

Operator Documentation

This section contains the documentation for operating, deploying and configuring the keystone service.

configuration.rst advanced-topics/index.rst sample_files/index.rst

Administrator Guides

admin/identity-management.rst

Configuration Options

configuration/config-options.rst configuration/policy.rst configuration/samples/index.rst

API Documentation

An end user can find the specific API documentation here, OpenStack's Identity API.

Note

Following are some API examples using curl. Note that these examples are not automatically generated. They can be outdated as things change and are subject to regular updates and changes.

api_curl_examples.rst