..
      Copyright 2011 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 a cloud identity service written in Python, which provides
authentication, authorization, and an OpenStack service catalog. 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
    testing
    migration
    extensions
    configuration
    controllingservers
    configuringservices
    community
    usingkeystone

Administration
==============

.. toctree::
    :maxdepth: 1

    migration
    configuration
    controllingservers
    configuringservices
    endpoints
    ssl


API Use Case Examples
=====================

.. toctree::
    :maxdepth: 1

    adminAPI_curl_examples
    serviceAPI_curl_examples

Configuration File Examples
===========================

.. toctree::
    :maxdepth: 1

    nova-api-paste
    keystone.conf

Man Pages
=========

.. toctree::
    :maxdepth: 1

    man/keystone-manage
    man/keystone
    man/keystone-auth
    man/keystone-admin
    man/keystone-import
    man/keystone-control
    man/sampledata

Developer Docs
==============

.. toctree::
    :maxdepth: 1

    developing
    architecture
    middleware
    middleware_architecture
    sourcecode/autoindex

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

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