openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Ivan Pchelintsev 89bdebd2a9 Remove VxFlex OS credentials from connection_properties 
VxFlex OS password is not stored in block_device_mapping table.
Instead of this passwords are stored in separate file and are
retrieved during each attach/detach operation.

The stable/queens branch is in Extended Maintenance mode and is no
longer released from.  If you decide to apply this patch to your
deployment, you must make a corresponding change to the os-brick
library.  You can find the os-brick patch for stable/queens here:
    https://review.opendev.org/#/c/733104

Additionally, you must deploy a new configuration file on compute
nodes, cinder nodes, and anywhere you would perform a volume
attachment in your deployment.  See the documentation change on
this patch for details about the new config file.

See OSSN-0086 for more information about this change:
    https://wiki.openstack.org/wiki/OSSN/OSSN-0086

Closes-Bug: #1823200
Change-Id: I831321d12a6df2b950f05e2452710b9ae105ada4
 		2020-06-03 22:55:21 +00:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source Remove VxFlex OS credentials from connection_properties 2020-06-03 22:55:21 +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
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
requirements.txt Cap sphinx for py2 to match global reqs 2020-01-28 08:58:36 -05:00

README.rst

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