986a6a015f
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
45 lines
2.9 KiB
PHP
45 lines
2.9 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-cloudbyte:
|
|
|
|
.. list-table:: Description of CloudByte volume driver configuration options
|
|
:header-rows: 1
|
|
:class: config-ref-table
|
|
|
|
* - Configuration option = Default value
|
|
- Description
|
|
* - **[DEFAULT]**
|
|
-
|
|
* - ``cb_account_name`` = ``None``
|
|
- (String) CloudByte storage specific account name. This maps to a project name in OpenStack.
|
|
* - ``cb_add_qosgroup`` = ``{'latency': '15', 'iops': '10', 'graceallowed': 'false', 'iopscontrol': 'true', 'memlimit': '0', 'throughput': '0', 'tpcontrol': 'false', 'networkspeed': '0'}``
|
|
- (Dict) These values will be used for CloudByte storage's addQos API call.
|
|
* - ``cb_apikey`` = ``None``
|
|
- (String) Driver will use this API key to authenticate against the CloudByte storage's management interface.
|
|
* - ``cb_auth_group`` = ``None``
|
|
- (String) This corresponds to the discovery authentication group in CloudByte storage. Chap users are added to this group. Driver uses the first user found for this group. Default value is None.
|
|
* - ``cb_confirm_volume_create_retries`` = ``3``
|
|
- (Integer) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.
|
|
* - ``cb_confirm_volume_create_retry_interval`` = ``5``
|
|
- (Integer) A retry value in seconds. Will be used by the driver to check if volume creation was successful in CloudByte storage.
|
|
* - ``cb_confirm_volume_delete_retries`` = ``3``
|
|
- (Integer) Will confirm a successful volume deletion in CloudByte storage by making this many number of attempts.
|
|
* - ``cb_confirm_volume_delete_retry_interval`` = ``5``
|
|
- (Integer) A retry value in seconds. Will be used by the driver to check if volume deletion was successful in CloudByte storage.
|
|
* - ``cb_create_volume`` = ``{'compression': 'off', 'deduplication': 'off', 'blocklength': '512B', 'sync': 'always', 'protocoltype': 'ISCSI', 'recordsize': '16k'}``
|
|
- (Dict) These values will be used for CloudByte storage's createVolume API call.
|
|
* - ``cb_tsm_name`` = ``None``
|
|
- (String) This corresponds to the name of Tenant Storage Machine (TSM) in CloudByte storage. A volume will be created in this TSM.
|
|
* - ``cb_update_file_system`` = ``compression, sync, noofcopies, readonly``
|
|
- (List) These values will be used for CloudByte storage's updateFileSystem API call.
|
|
* - ``cb_update_qos_group`` = ``iops, latency, graceallowed``
|
|
- (List) These values will be used for CloudByte storage's updateQosGroup API call.
|