openstack/cinder
Code Issues Proposed changes
a828709ecd
cinder/doc/source/index.rst
Jay S. Bryant 85f97d86d4 [DOC FIX] Create missing index pages 
There was a mistake in the documentation migration.  The
landing pages in the admin and configuration sections should
have been moved to index.html.  That step didn't happen which
is causing it to appear that that content is missing from
the main OpenStack docs website.

This patch updates our main index page and moves the existing
landing pages to index.rst.

Change-Id: Idb96a09f748d3bbebf6eb768dfd2b758da545096
2017-08-10 12:04:13 -05:00

3.7 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

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.

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