History

Mudassir Latif 5191751760 Allow replicated volumes to be recoverable Currently, once they are in ‘error’ or ‘failed-over’ states you can’t do anything with them. We need to allow enable_replication after the admin has resolved any issues that may have prevented the operation. Same thing for after a fail-over, you cannot enable replication on it. This change allows for more states to be recoverable via enable replication. It also more uniformly sets the state to ‘error’ when something bad happens. 'enabled' --> replication is on. 'disabled' --> replication is off by design. 'failed-over' --> we have just failed over. Replication is off. 'error' --> an error occurred during the last operation. allowed flow is: 'enabled' --> 'failed-over'/'disabled'/'error' 'error' --> 'enabled'/'error' 'disabled' --> 'enabled'/'error' 'failed-over' --> 'enabled'/'error' Change-Id: Icbc22b8501b048b1755019305430177ba0a9385f Partial-Bug: #1491631		2015-12-22 07:36:11 -08:00
..
ext	Replace xrange() with six.moves.range()	2015-06-16 10:46:40 +02:00
source	Allow replicated volumes to be recoverable	2015-12-22 07:36:11 -08:00
.gitignore	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00
Makefile	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00
README.rst	Complete the doc/README.rst instructions to build docs	2015-04-16 08:13:04 +00:00
find_autodoc_modules.sh	Fixes a small issue in find_autodoc_modules.sh	2015-01-23 14:38:44 +08:00
generate_autodoc_index.sh	Initial fork out of Nova.	2012-05-03 10:48:26 -07:00

README.rst

Building the docs

Dependencies

Sphinx

You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the cinder modules.

pip install Sphinx

Graphviz

Some of the diagrams are generated using the dot language from Graphviz.

sudo apt-get install graphviz

Use make

Just type make:

% make

Look in the Makefile for more targets.

Manually

Generate the code.rst file so that Sphinx will pull in our docstrings:
% ./generate_autodoc_index.sh > source/code.rst
Run `sphinx_build`:
% sphinx-build -b html source build/html

Use tox

The easiest way to build the docs and avoid dealing with all dependencies is to let tox prepare a virtualenv and run the build_sphinx target inside the virtualenv:

% cd ..
% tox -e docs

The docs have been built

Check out the build directory to find them. Yay!