cinder/doc/source/configuration/tables/cinder-storage_ceph.inc
Jay S. Bryant 986a6a015f [DOC BLD FIX] Name files for inclusion properly
The Sphinx build was issuing hundreds of warning for
duplicate labels.  The reason for this was because
all of the tables we had were named as .rst files.
This would cause Sphinx to process them twice and it would
think there were duplicated sections.

There were two ways this could be handled:  1) Exclude the tables
directory from the docs build. 2) Name the files as they should
have always been so they weren't build twice.  Given that
option 1 just masked the problem, I am implementing this
patch using option 2.

So, all the tables we are including in our documentation
have been named from .rst to .inc and the .. include::
directives that use them have also been updated to use
the new file name.

Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
2017-08-04 15:33:52 -05:00

45 lines
2.2 KiB
PHP

..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _cinder-storage_ceph:
.. list-table:: Description of Ceph storage configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``rados_connect_timeout`` = ``-1``
- (Integer) Timeout value (in seconds) used when connecting to ceph cluster. If value < 0, no timeout is set and default librados value is used.
* - ``rados_connection_interval`` = ``5``
- (Integer) Interval value (in seconds) between connection retries to ceph cluster.
* - ``rados_connection_retries`` = ``3``
- (Integer) Number of retries if connection to ceph cluster failed.
* - ``rbd_ceph_conf`` =
- (String) Path to the ceph configuration file
* - ``rbd_cluster_name`` = ``ceph``
- (String) The name of ceph cluster
* - ``rbd_flatten_volume_from_snapshot`` = ``False``
- (Boolean) Flatten volumes created from snapshots to remove dependency from volume to snapshot
* - ``rbd_max_clone_depth`` = ``5``
- (Integer) Maximum number of nested volume clones that are taken before a flatten occurs. Set to 0 to disable cloning.
* - ``rbd_pool`` = ``rbd``
- (String) The RADOS pool where rbd volumes are stored
* - ``rbd_secret_uuid`` = ``None``
- (String) The libvirt uuid of the secret for the rbd_user volumes
* - ``rbd_store_chunk_size`` = ``4``
- (Integer) Volumes will be chunked into objects of this size (in megabytes).
* - ``rbd_user`` = ``None``
- (String) The RADOS client name for accessing rbd volumes - only set when using cephx authentication
* - ``replication_connect_timeout`` = ``5``
- (Integer) Timeout value (in seconds) used when connecting to ceph cluster to do a demotion/promotion of volumes. If value < 0, no timeout is set and default librados value is used.