Sean McGinnis fcd7fcea3e Add sample config file to cinder docs

The oslo sphinxconfiggen module was added to the oslo.config
2.3.0 release. This enables config file generation as part of
the sphinx doc generation.

The generated config file will pick up the current config
options from the code base. And as an added bonus, it will
now be published to the docs.openstack.org site for easy
reference or download.

This also puts us inline with what other projects like Nova
are doing for sample config files and is the recommended
method from the Oslo team.

Change-Id: I912a97eb2686d3dc56e50d8641d7bd930179bc18

2016-05-17 08:52:21 -05:00

2.1 KiB

Raw Blame History

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 drivers oslo-middleware

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

2.1 KiB Raw Blame History