cinder/doc/source/index.rst
Sean McGinnis eca5f76927 Clean up docs landing page
Reorganizes and cleans up the docs landing page so viewers eyes don't
immediately start bleeding. Also tries to simplify things and put them
in a more logical and consumable order.

Change-Id: I1c3ee6ad21bd27a5ef7f6691ddd8dde25e9c4c01
2017-10-03 14:06:43 -05:00

3.1 KiB

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

Sample Configuration File <sample_config>

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