summaryrefslogtreecommitdiffstats
path: root/doc/source/index.rst
blob: ec7c7fd02f353d4af4728b359f376a647908b564 (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
..
      Copyright 2011-2012 OpenStack, LLC
      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.

====================================================
Welcome to Keystone, the OpenStack Identity Service!
====================================================

Keystone is an OpenStack project that provides Identity, Token, Catalog and
Policy services for use specifically by projects in the OpenStack family.
It implements `OpenStack's Identity API`_.

This document describes Keystone for contributors of the project, and assumes
that you are already familiar with Keystone from an `end-user perspective`_.

.. _`OpenStack's Identity API`: http://docs.openstack.org/api/openstack-identity-service/2.0/content/
.. _`end-user perspective`: http://docs.openstack.org/

This documentation is generated by the Sphinx toolkit and lives in the source
tree.  Additional documentation on Keystone and other components of OpenStack
can be found on the `OpenStack wiki`_.  Also see the :doc:`community` page for
other ways to interact with the community.

.. _`OpenStack wiki`: http://wiki.openstack.org

Getting Started
===============

.. toctree::
    :maxdepth: 1

    setup
    installing
    configuration
    configuringservices
    community

Man Pages
=========

.. toctree::
    :maxdepth: 1

    man/keystone-all
    man/keystone-manage

Developers Documentation
========================
.. toctree::
   :maxdepth: 1

   developing
   architecture
   middlewarearchitecture
   api_curl_examples
   apache-httpd
   external-auth

Code Documentation
==================
.. toctree::
   :maxdepth: 1

   api/autoindex

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`