..
      Copyright 2010-2012 United States Government as represented by the
      Administrator of the National Aeronautics and Space Administration.
      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.

===========================================
Cinder, the OpenStack Block Storage Service
===========================================

Cinder is an OpenStack project to provide "block storage as a service".

* **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 draft and project documentation on Cinder and other components of OpenStack can
be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_.

.. _`OpenStack wiki`: https://wiki.openstack.org/wiki/Main_Page
.. _`docs.openstack.org`: https://docs.openstack.org


Installing Cinder
~~~~~~~~~~~~~~~~~

To get started installing Cinder for use, start with the following documentation.

.. toctree::
   :maxdepth: 2

   install/index

Admin Docs
~~~~~~~~~~

Administrators will find helpful information in the following links including a
description of how Cinder works, manages storage and how to troubleshoot your
Cinder installation.

.. toctree::
   :maxdepth: 2

   admin/index

Contributor/Developer Docs
~~~~~~~~~~~~~~~~~~~~~~~~~~

The following links contained information for contributors and developers.
There is information on setting up a development environment, a lit of our API
information on how to add a driver and many other resources related to
contributing to Cinder.

.. toctree::
   :maxdepth: 1

   contributor/index
   scheduler-filters
   scheduler-weights
   upgrade

Command Line Interface Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Information on the commands available through Cinder's Command Line
Interface (CLI) can be found in this section of documentation. Full documentation
on the python-cinderclient is in the `python-cinderclient repo`_.

.. _`python-cinderclient repo`: https://docs.openstack.org/python-cinderclient/latest

.. toctree::
   :maxdepth: 2

   cli/cli-manage-volumes
   cli/cli-set-quotas
   cli/cli-cinder-quotas
   cli/cli-cinder-scheduling

Man Pages
~~~~~~~~~

Additional 'man page' style documentation for Cinder may be seen below.

.. toctree::
   :maxdepth: 2

   man/cinder-manage
   man/generalized_filters

Drivers
~~~~~~~

Cinder maintains drivers for volume backends, backup targets, and fibre
channel zone manager fabric types. The list of the available drivers can be
found here:

.. toctree::
   :maxdepth: 1

   drivers

API Extensions
~~~~~~~~~~~~~~

Go to https://developer.openstack.org/api-ref/block-storage/ for information about Cinder API extensions.

Configuration Reference
~~~~~~~~~~~~~~~~~~~~~~~

The following links provide information on the many configuration options
available for Cinder including a sample configuration file.

.. toctree::
    :maxdepth: 1

    configuration/index
    sample_config

Indices and tables
~~~~~~~~~~~~~~~~~~

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

Glossary
~~~~~~~~

.. toctree::
   :maxdepth: 1

   common/glossary.rst