cinder/doc/source/index.rst
Sean McGinnis 8148038e92 Add driver list to doc build
We have tox -e gendriverlist that outputs an RST-ish report of all drivers
in the tree. This output can be used in the docs build to automatically
publish the list of drivers to make it easier to find officially supported
drivers.

This effectively removes the existing drivers.html that was generated prior
that did not actually contain any useful information.

Change-Id: I8de78723af76aabcc976733ac4b248db0b8ca16f
2016-07-26 11:09:05 -05:00

2.3 KiB

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.

Developer Docs

devref/index database_architecture scheduler-filters scheduler-weights oslo-middleware

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:

drivers

API Extensions

Go to http://api.openstack.org for information about Cinder API extensions.

Sample Configuration File

sample_config

Outstanding Documentation Tasks

Indices and tables

  • genindex
  • modindex
  • search