fcd7fcea3e
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
74 lines
2.1 KiB
ReStructuredText
74 lines
2.1 KiB
ReStructuredText
..
|
|
Copyright 2010-2012 United States Government as represented by the
|
|
Administrator of the National Aeronautics and Space Administration.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
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`_.
|
|
|
|
.. _`OpenStack wiki`: http://wiki.openstack.org
|
|
.. _`docs.openstack.org`: http://docs.openstack.org
|
|
|
|
|
|
Developer Docs
|
|
==============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
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
|
|
=========================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
sample_config
|
|
|
|
Outstanding Documentation Tasks
|
|
===============================
|
|
|
|
.. todolist::
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|