f6e234e34b
This patch adds the documentation for admins to configure replication in OpenStack and how to recover from disaster scenarios with failover/failback operations. It also adds two scenarios: 1. failover/failback of boot from volume server 2. failover/failback of external data volume Signed-off-by: Rajat Dhasmana <rajatdhasmana@gmail.com> Change-Id: I330a0a4d56916601cd69f51d2c88a10c4c5d0166
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: https://docs.openstack.org/cinder/latest/
Tools
- Sphinx
-
The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.
- Graphviz
-
Some of the diagrams are generated using the
dotlanguage from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.
Building Documentation
Doc builds are performed using tox with the docs
target:
% cd ..
% tox -e docs