openstack/cinder
Code Issues Proposed changes
406527a1e1
cinder/doc/source/index.rst
Jay S. Bryant be10de4b91 [Doc Bld Fix] Add links to man page contents 
The pages under man/ had not been linked to from anywhere.  This
was causing Sphinx to issue warnings during build.  This patch
corrects that.

There was also a 'todo' directive that wasn't valid that needed
to be removed.  This patch also corrects that.

Change-Id: I8ab75b7be921a05e9e4eb023c4dfe90cf4404e6c
2017-08-21 13:56:27 -05:00

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

Installing Cinder

To get started installing Cinder for use, start with the following documentation.

install/index

Admin Docs

Administrators will find helpful information in the following links including a description of how Cinder works, manages storage and how to troubleshoot your Cinder installation.

admin/index

Contributor/Developer Docs

The following links contained information for contributors and developers. There is information on setting up a development environment, a lit of our API information on how to add a driver and many other resources related to contributing to Cinder.

contributor/index scheduler-filters scheduler-weights upgrade

Command Line Interface Documentation

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

cli/cli-manage-volumes cli/cli-set-quotas cli/cli-cinder-quotas cli/cli-cinder-scheduling

Man Pages

Additional 'man page' style documentation for Cinder may be seen below.

man/cinder-manage man/generalized_filters

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 https://developer.openstack.org/api-ref/block-storage/ for information about Cinder API extensions.

Configuration Reference

The following links provide information on the many configuration options available for Cinder including a sample configuration file.

configuration/index sample_config

Indices and tables

  • genindex
  • modindex
  • search

Glossary

common/glossary.rst