keystone/doc/source/index.rst

121 lines
2.8 KiB
ReStructuredText

..
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.
====================================================
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://specs.openstack.org/openstack/keystone-specs/
.. _`end-user perspective`: http://docs.openstack.org/
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Also see the :doc:`community` page for other ways to interact with the
community.
Related Identity Projects
=========================
In addition to creating OpenStack's Identity Service, the Keystone team also
provides a `WSGI middleware`_, as well as `Python client library`_.
.. _`WSGI middleware`: http://docs.openstack.org/developer/keystonemiddleware/
.. _`Python client library`: http://docs.openstack.org/developer/python-keystoneclient/
Getting Started
===============
.. toctree::
:maxdepth: 1
installing
configuration
apache-httpd
policy_mapping
configuringservices
extensions
key_terms
community
Advanced Topics
===============
.. toctree::
:maxdepth: 2
federation/federated_identity
.. toctree::
:maxdepth: 1
configure_tokenless_x509
auth-totp
event_notifications
external-auth
Man Pages
=========
.. toctree::
:maxdepth: 1
man/keystone-manage
Developers Documentation
========================
.. toctree::
:maxdepth: 1
devref/development.environment
developing
developing_drivers
architecture
middlewarearchitecture
http-api
api_curl_examples
services
online_schema_migration_examples
Sample Configuration File
=========================
.. toctree::
:maxdepth: 1
sample_config
Code Documentation
==================
.. toctree::
:maxdepth: 1
api/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`