glance/doc/source/index.rst
Brian Waldon 87033d04d5 Rename glance api docs to something more concise
Related to bp glance-folsom-docs-cleanup

Change-Id: Ic2206b9a3233d9b9d0617a253749d2021d14ac20
2012-08-22 19:21:03 -07:00

84 lines
2.2 KiB
ReStructuredText

..
Copyright 2010 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 Glance's documentation!
==================================
The Glance project provides services for discovering, registering, and
retrieving virtual machine images. Glance has a RESTful API that allows
querying of VM image metadata as well as retrieval of the actual image.
VM images made available through Glance can be stored in a variety of
locations from simple filesystems to object-storage systems like the
OpenStack Swift project.
Glance, as with all OpenStack projects, is written with the following design
guidelines in mind:
* **Component based architecture**: Quickly add new behaviors
* **Highly available**: Scale to very serious workloads
* **Fault tolerant**: Isolated processes avoid cascading failures
* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
* **Open standards**: Be a reference implementation for a community-driven api
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional documentation on Glance and other components of OpenStack can
be found on the `OpenStack wiki`_.
.. _`OpenStack wiki`: http://wiki.openstack.org
Concepts
========
.. toctree::
:maxdepth: 1
identifiers
statuses
formats
Managing Glance
===============
.. toctree::
:maxdepth: 1
installing
controllingservers
configuring
db
policies
cache
authentication
Using Glance
============
.. toctree::
:maxdepth: 1
glanceapi
glanceclient
Developer Docs
==============
.. toctree::
:maxdepth: 1
architecture
community