cinder/doc
Simon Dodsley 81c919bb05 [Pure Storage] Add support for 3-site, trisync, replication.
Add new parameters `pure_trisync_enabled` and
`pure_trisync_pg_name`.

When these parameters are used in conjunction with a
volume type where `type <in> trisync` will create a volume
that is simultaneously replicate to two target arrays, one
synchronously and the other asynchronously.

It is required that two `replication_devices` are provided, one
that is sync and one that is async.

Also adds the ability to retype a volume between `sync` and
`trisync` replication types.

Consistency Groups are also supported for `trisync`` volume
types, as well as cloning `trisync` CGs.

These changes have been tested in-house by Pure and confirmed
to work as expected in the master branch for 2023.1.

Implements: blueprint pure-trisync
Change-Id: Idecb1c0421ece87f59818a65f15fcba1f49d940a
2023-01-25 15:17:24 +00:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source [Pure Storage] Add support for 3-site, trisync, replication. 2023-01-25 15:17:24 +00:00
test docs: Remove unnecessary 'blockstorage-' prefix 2022-02-20 19:06:32 +00:00
.gitignore 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 docs: Add whereto for testing redirect rules 2022-02-20 19:05:46 +00: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