cinder/doc
yixuanzhang c0d471a424 Storwize: add hyperswap volume support
This patch adds hyperswap volume support for Storwize/SVC driver.

New properties are added in volume type configuration:
drivers:volume_topology sets to "hyperswap" would specify a
hyperswap volume.
drivers:peer_pool specifies the pool that hyperswap remote copy
volume is stored.
drivers:host_site specifies the site name of the host.

New property is added in group type configuration:
hyperswap_group_enabled="<is> True" would setup a hyperswap group.

DocImpact
Implements: blueprint svc-hyperswap-support

Change-Id: I989d22d9580c1f44546f371af1fffded14ddcbe3
2018-01-04 13:25:31 +08:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source Storwize: add hyperswap volume support 2018-01-04 13:25:31 +08:00
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05: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 Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
requirements.txt Follow the new PTI for document build 2017-12-20 18:24:11 -08:00

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 dot language 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