Jay S. Bryant 6e049b6881 Add sphinx-feature-classification based support matrix

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

2018-08-07 09:35:32 -05:00

3.1 KiB

Raw Blame History

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.

Installation Guide

Installation Guide <install/index> Upgrade Process <upgrade>

Administration Guide

admin/index

Configuration Reference

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.

cli/index cinder-manage Usage <man/cinder-manage>

Contributor/Developer Docs

contributor/index

API Extensions

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

Block Storage v3 API Microversion History </contributor/api_microversion_history>: The block storage v3 API evolves over time through 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

genindex
search

Glossary

common/glossary.rst

3.1 KiB Raw Blame History