openstack/cinder
Code Issues Proposed changes

Update Datera docs to use config-table directive

Browse Source 
Remove static config table in favor of dynamic config table
generation using the config-table directive.

Change-Id: I285da382185f3234615d73cdbdc43166e0b6a82c
This commit is contained in:
Sean McGinnis 2018-04-25 01:24:48 +00:00
parent f3feee2f95
commit bd4da9309d
2 changed files with 3 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/configuration/block-storage/drivers/datera-volume-driver.rst
View File

@ -32,9 +32,10 @@ Prerequisites
* open-iscsi-utils
* wget
.. include:: ../../tables/cinder-datera.inc
.. config-table::
:config-target: Datera
cinder.volume.drivers.datera.datera_iscsi
Configuring the Datera volume driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

34
doc/source/configuration/tables/cinder-datera.inc
View File

@ -1,34 +0,0 @@
..
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-datera:
.. list-table:: Description of Datera volume driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``datera_503_interval`` = ``5``
- (Integer) Interval between 503 retries
* - ``datera_503_timeout`` = ``120``
- (Integer) Timeout for HTTP 503 retry messages
* - ``datera_api_port`` = ``7717``
- (String) Datera API port.
* - ``datera_api_version`` = ``2``
- (String) DEPRECATED: Datera API version.
* - ``datera_debug`` = ``False``
- (Boolean) True to set function arg and return logging
* - ``datera_debug_replica_count_override`` = ``False``
- (Boolean) ONLY FOR DEBUG/TESTING PURPOSES True to set replica_count to 1
* - ``datera_tenant_id`` = ``None``
- (String) If set to 'Map' --> OpenStack project ID will be mapped implicitly to Datera tenant ID If set to 'None' --> Datera tenant ID will not be used during volume provisioning If set to anything else --> Datera tenant ID will be the provided value