..
      Copyright 2010 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 Glance's documentation!
==================================

The Glance project provides a service where users can upload and discover
data assets that are meant to be used with other services. This currently
includes images and metadata definitions.

Glance image services include 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.

.. include:: deprecation-note.inc

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

Glance Background Concepts
==========================

.. toctree::
   :maxdepth: 1

   architecture
   database_architecture
   domain_model
   domain_implementation
   identifiers
   statuses
   tasks
   formats
   common-image-properties
   metadefs-concepts

Installing/Configuring Glance
=============================

.. toctree::
   :maxdepth: 1

   installing
   configuring
   sample-configuration
   authentication
   policies
   image-location-strategy-modules
   artifact-types
   flows
   property-protections
   opts/index
   requirements

Operating Glance
================

.. toctree::
   :maxdepth: 1

   controllingservers
   db
   cache
   notifications

Using Glance
============

.. toctree::
   :maxdepth: 1

   glanceapi
   glanceclient
   glancemetadefcatalogapi
   signature

Glance Manual Pages
===================

.. toctree::
   :glob:
   :maxdepth: 1

   man/*
   api/modules

Contributing to Glance
======================

.. toctree::
   :maxdepth: 1

   contributing/index

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

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