cinder/doc/source/index.rst
Jay S. Bryant 7a6180575c Migrate Cinder Scheduling CLI documentation
The next chapter in the Cinder documentation migration.

This change brings over the scheduling documentation from
openstack-manuals.

As with the other changes, this is just intended to make the
content accessible again.  Future patches will be proposed to
improve the content.

Change-Id: Idf0366bdf7bf1a3f5b67ea46c30bbf5d92120c3b
2017-07-08 14:06:39 -05:00

105 lines
2.6 KiB
ReStructuredText

..
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.
Welcome to Cinder's developer documentation!
============================================
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`: http://wiki.openstack.org
.. _`docs.openstack.org`: http://docs.openstack.org
Installing Cinder
=================
.. toctree::
:maxdepth: 2
install/index
Admin Docs
==========
.. toctree::
:maxdepth: 2
admin/blockstorage
Developer Docs
==============
.. toctree::
:maxdepth: 1
devref/index
scheduler-filters
scheduler-weights
upgrade
Command Line Interface Documentation
====================================
.. toctree::
:maxdepth: 2
admin/cli-manage-volumes
admin/cli-set-quotas
admin/cli-cinder-quotas
admin/cli-cinder-scheduling
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 http://api.openstack.org for information about Cinder API extensions.
Sample Configuration File
=========================
.. toctree::
:maxdepth: 1
sample_config
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`