6e049b6881
Cinder has always used a wiki page as the source of our
support matrix. Unfortunately the wiki gives us no way
to ensure that the information is accurate and makes it
harder to track changes. Moving to using the
sphinx-feature-classification library solves some of these
problems.
* It provides a programatic way to document driver support.
* It allows us to ensure that documentation is updated with
changes.
* It will provide a snapshot of the state of driver support
for a release at the time of release.
This matrix will serve as the truth for Cinder's driver support.
The existing wiki will be kept for historical purposes but I will
make a pointer to this new documentation and indicate that no
changes should be made to the wiki in the future.
Change-Id: I7c1b7fb539a48ec3b79e86c44ffe2d3005aeba25
117 lines
3.1 KiB
ReStructuredText
117 lines
3.1 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.
|
|
|
|
===========================================
|
|
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
|
|
|
|
|
|
Installation Guide
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
Installation Guide <install/index>
|
|
Upgrade Process <upgrade>
|
|
|
|
Administration Guide
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
admin/index
|
|
|
|
Configuration Reference
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
configuration/index
|
|
reference/support-matrix
|
|
drivers
|
|
|
|
CLI Reference
|
|
~~~~~~~~~~~~~
|
|
|
|
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 documentation`_.
|
|
|
|
.. _`python-cinderclient documentation`: https://docs.openstack.org/python-cinderclient/latest
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
cli/index
|
|
cinder-manage Usage <man/cinder-manage>
|
|
|
|
Contributor/Developer Docs
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
contributor/index
|
|
|
|
|
|
API Extensions
|
|
~~~~~~~~~~~~~~
|
|
|
|
Go to https://developer.openstack.org/api-ref/block-storage/ for information
|
|
about Cinder API extensions.
|
|
|
|
:doc:`Block Storage v3 API Microversion History </contributor/api_microversion_history>`:
|
|
The block storage v3 API evolves over time through
|
|
:doc:`API Microversions </contributor/api_microversion_dev/>`. This
|
|
provides the history of all those changes. Consider it a "what's new" in the
|
|
block storage v3 API.
|
|
|
|
Indices and tables
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|
|
|
|
Glossary
|
|
~~~~~~~~
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
common/glossary.rst
|