cinder/doc/source/index.rst
Jay S. Bryant e9857d616d Migrate the blockstorage admin-guide to Cinder
This patch is part of the docs migration for Cinder.
It is more or less a drag and drop of the docs from
openstack-manuals admin-guide directory.  I needed to
change some syntax to work with Cinder's more stringent
doc build.

Note that the purpose of this patch is just to get the
documentation back to an accessible location.  Later patches
will clean up the organization and content.

Change-Id: Ib3f9255e0f9f2ff42a0ee4126607ff319a3d901e
2017-07-08 12:44:49 -05:00

2.4 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.

Installing Cinder

install/index

Admin Docs

admin/blockstorage

Developer Docs

devref/index scheduler-filters scheduler-weights upgrade

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

Indices and tables

  • genindex
  • modindex
  • search