summaryrefslogtreecommitdiff
path: root/doc/source/index.rst
blob: bd8c1b25c6d89d19917b4bd27cf8759e49aa70c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
..
      Copyright 2011-2012 OpenStack Foundation
      All Rights Reserved.

      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.

========================================
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 :doc:`getting-started/community` page for other ways to interact with the
community.

.. _`OpenStack's Identity API`: https://developer.openstack.org/api-ref/identity/index.html
.. _`source tree`: https://git.openstack.org/cgit/openstack/keystone/tree/doc/source

Related Projects
~~~~~~~~~~~~~~~~

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

.. _`WSGI middleware`: https://docs.openstack.org/keystonemiddleware/latest
.. _`Authentication library`: https://docs.openstack.org/keystoneauth/latest
.. _`Python client library`: https://docs.openstack.org/python-keystoneclient/latest

Installation Guides
~~~~~~~~~~~~~~~~~~~
.. toctree::
    :maxdepth: 2

    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.

.. toctree::
    :maxdepth: 2

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

Contributor Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~

This section contains the documentation needed for developing keystone.

.. toctree::
    :maxdepth: 2

    contributor/index.rst

Operator Documentation
~~~~~~~~~~~~~~~~~~~~~~

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

.. toctree::
    :maxdepth: 2

    configuration.rst
    advanced-topics/index.rst

User Documentation
~~~~~~~~~~~~~~~~~~

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

.. toctree::
    :maxdepth: 2

    user/index.rst

CLI Documentation
~~~~~~~~~~~~~~~~~

This section details information related to ``keystone-manage``.

.. toctree::
    :maxdepth: 2

    cli/index.rst

Administrator Guides
~~~~~~~~~~~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    admin/index.rst

Configuration Options
~~~~~~~~~~~~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    configuration/index.rst