openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Cinder option tables update

Browse Source 
Remove the quobyte documentation since it is not in the cinder tree
anymore.

Closes-Bug: #1474495
Closes-Bug: #1469518
Closes-Bug: #1467587
Closes-Bug: #1467170
Partial-Bug: #1467123
Partial-Bug: #1466971
Closes-Bug: #1466163
Partial-Bug: #1465700
Partial-Bug: #1464726
Closes-Bug: #1462459
Closes-Bug: #1462184
Closes-Bug: #1460811
Closes-Bug: #1460366
Closes-Bug: #1458714
Closes-Bug: #1453247
Closes-Bug: #1451526
Partial-Bug: #1447455
Partial-Bug: #1445154
Closes-Bug: #1444814
Closes-Bug: #1385248

Change-Id: I6eec26af059d7d390b2b3875b346fcb50c8100a5
This commit is contained in:
Gauvain Pocentek 2015-07-19 10:53:46 +02:00
parent a6dd7ad60f
commit 523d46a8b6
47 changed files with 994 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/common/tables/cinder-amqp.xml
View File

@ -23,7 +23,7 @@
</tr>
<tr>
<td><option>notification_driver</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
<td>(MultiStrOpt) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop</td>
</tr>
<tr>
<td><option>notification_topics</option> = <replaceable>notifications</replaceable></td>

49
doc/common/tables/cinder-api.xml
View File

@ -49,6 +49,14 @@
<td><option>extra_capabilities</option> = <replaceable>{}</replaceable></td>
<td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs. The key/value pairs can be used by the CapabilitiesFilter to select between backends when requests specify volume types. For example, specifying a service level or the geographical location of a backend, then creating a volume type to allow the user to select by these different properties.</td>
</tr>
<tr>
<td><option>ignore_pool_full_threshold</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Force LUN creation even if the full threshold of pool is reached.</td>
</tr>
<tr>
<td><option>management_ips</option> = <replaceable></replaceable></td>
<td>(StrOpt) List of Management IP addresses (separated by commas)</td>
</tr>
<tr>
<td><option>max_header_line</option> = <replaceable>16384</replaceable></td>
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
@ -85,10 +93,18 @@
<td><option>osapi_volume_workers</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.</td>
</tr>
<tr>
<td><option>per_volume_size_limit</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Max size allowed per volume, in gigabytes</td>
</tr>
<tr>
<td><option>public_endpoint</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Public url to use for versions endpoint. The default is None, which will use the request's host_url attribute to populate the URL base. If Cinder is operating behind a proxy, you will want to change this to represent the proxy's URL.</td>
</tr>
<tr>
<td><option>query_volume_filters</option> = <replaceable>name, status, metadata, availability_zone</replaceable></td>
<td>(ListOpt) Volume filter options which non-admin user could use to query volumes. Default values are: ['name', 'status', 'metadata', 'availability_zone']</td>
</tr>
<tr>
<td><option>transfer_api_class</option> = <replaceable>cinder.transfer.api.API</replaceable></td>
<td>(StrOpt) The full class name of the volume transfer API class</td>
@ -113,6 +129,39 @@
<td><option>volume_transfer_salt_length</option> = <replaceable>8</replaceable></td>
<td>(IntOpt) The number of characters in the salt.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
<tr>
<td><option>secure_proxy_ssl_header</option> = <replaceable>X-Forwarded-Proto</replaceable></td>
<td>(StrOpt) The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.</td>
</tr>
<tr>
<th colspan="2">[oslo_policy]</th>
</tr>
<tr>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<th colspan="2">[oslo_versionedobjects]</th>
</tr>
<tr>
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Make exception message format errors fatal</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/cinder-auth.xml
View File

@ -18,7 +18,7 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>auth_strategy</option> = <replaceable>noauth</replaceable></td>
<td><option>auth_strategy</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) The strategy to use for auth. Supports noauth, keystone, and deprecated.</td>
</tr>
</tbody>

6
doc/common/tables/cinder-auth_token.xml
View File

@ -119,7 +119,7 @@
</tr>
<tr>
<td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool.</td>
</tr>
<tr>
<td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
@ -131,7 +131,7 @@
</tr>
<tr>
<td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.</td>
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcached server.</td>
</tr>
<tr>
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
@ -147,7 +147,7 @@
</tr>
<tr>
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>

4
doc/common/tables/cinder-backups_swift.xml
View File

@ -29,6 +29,10 @@
<td><option>backup_swift_block_size</option> = <replaceable>32768</replaceable></td>
<td>(IntOpt) The size in bytes that changes are tracked for incremental backups. backup_swift_object_size has to be multiple of backup_swift_block_size.</td>
</tr>
<tr>
<td><option>backup_swift_ca_cert_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Location of the CA certificate file to use for swift client requests.</td>
</tr>
<tr>
<td><option>backup_swift_container</option> = <replaceable>volumebackups</replaceable></td>
<td>(StrOpt) The default Swift container to use</td>

54
doc/common/tables/cinder-blockbridge.xml Normal file
View File

@ -0,0 +1,54 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_blockbridge">
<caption>Description of BlockBridge EPS volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>blockbridge_api_host</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address/hostname of Blockbridge API.</td>
</tr>
<tr>
<td><option>blockbridge_api_port</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Override HTTPS port to connect to Blockbridge API server.</td>
</tr>
<tr>
<td><option>blockbridge_auth_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Blockbridge API password (for auth scheme 'password')</td>
</tr>
<tr>
<td><option>blockbridge_auth_scheme</option> = <replaceable>token</replaceable></td>
<td>(StrOpt) Blockbridge API authentication scheme (token or password)</td>
</tr>
<tr>
<td><option>blockbridge_auth_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Blockbridge API token (for auth scheme 'token')</td>
</tr>
<tr>
<td><option>blockbridge_auth_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Blockbridge API user (for auth scheme 'password')</td>
</tr>
<tr>
<td><option>blockbridge_default_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Default pool name if unspecified.</td>
</tr>
<tr>
<td><option>blockbridge_pools</option> = <replaceable>{'OpenStack': '+openstack'}</replaceable></td>
<td>(DictOpt) Defines the set of exposed pools and their associated backend query strings</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/cinder-cloudbyte.xml
View File

@ -29,6 +29,10 @@
<td><option>cb_apikey</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Driver will use this API key to authenticate against the CloudByte storage's management interface.</td>
</tr>
<tr>
<td><option>cb_auth_group</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) 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.</td>
</tr>
<tr>
<td><option>cb_confirm_volume_create_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Will confirm a successful volume creation in CloudByte storage by making this many number of attempts.</td>

28
doc/common/tables/cinder-common.xml
View File

@ -53,6 +53,14 @@
<td><option>driver_data_namespace</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Namespace for driver private data values to be saved in.</td>
</tr>
<tr>
<td><option>driver_ssl_cert_verify</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If set to True the http client will validate the SSL certificate of the backend endpoint.</td>
</tr>
<tr>
<td><option>enable_force_upload</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enables the Force option on upload_to_image. This enables running upload_volume on in-use volumes for backends that support it.</td>
</tr>
<tr>
<td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Services to be added to the available pool on create</td>
@ -109,6 +117,10 @@
<td><option>num_shell_tries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of times to attempt to run flakey shell commands</td>
</tr>
<tr>
<td><option>os_privileged_user_auth_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Auth URL associated with the OpenStack privileged account.</td>
</tr>
<tr>
<td><option>os_privileged_user_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) OpenStack privileged account username. Used for requests to other services (such as Nova) that require an account with special rights.</td>
@ -129,18 +141,6 @@
<td><option>periodic_interval</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
</tr>
<tr>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. Missing or empty directories are ignored.</td>
</tr>
<tr>
<td><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td><option>replication_api_class</option> = <replaceable>cinder.replication.api.API</replaceable></td>
<td>(StrOpt) The full class name of the volume replication API class</td>
@ -161,10 +161,6 @@
<td><option>rootwrap_config</option> = <replaceable>/etc/cinder/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
</tr>
<tr>
<td><option>run_external_periodic_tasks</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
</tr>
<tr>
<td><option>send_actions</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send the volume and snapshot create and delete notifications generated in the specified period.</td>

73
doc/common/tables/cinder-cors.xml Normal file
View File

@ -0,0 +1,73 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_cors">
<caption>Description of CORS configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[cors]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
<tr>
<th colspan="2">[cors.subdomain]</th>
</tr>
<tr>
<td><option>allow_credentials</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
</tr>
<tr>
<td><option>allow_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which header field names may be used during the actual request.</td>
</tr>
<tr>
<td><option>allow_methods</option> = <replaceable>GET, POST, PUT, DELETE, OPTIONS</replaceable></td>
<td>(ListOpt) Indicate which methods can be used during the actual request.</td>
</tr>
<tr>
<td><option>allowed_origin</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Indicate whether this resource may be shared with the domain received in the requests "origin" header.</td>
</tr>
<tr>
<td><option>expose_headers</option> = <replaceable>Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma</replaceable></td>
<td>(ListOpt) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.</td>
</tr>
<tr>
<td><option>max_age</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Maximum cache age of CORS preflight requests.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/cinder-debug.xml
View File

@ -18,8 +18,8 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>backdoor_port</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
<td><option>trace_flags</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) List of options that control which trace info is written to the DEBUG log level to assist developers. Valid values are method and api.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/cinder-dellsc.xml
View File

@ -29,6 +29,10 @@
<td><option>dell_sc_ssn</option> = <replaceable>64702</replaceable></td>
<td>(IntOpt) Storage Center System Serial Number</td>
</tr>
<tr>
<td><option>dell_sc_verify_cert</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTPS SC certificate verification.</td>
</tr>
<tr>
<td><option>dell_sc_volume_folder</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) Name of the volume folder to use on the Storage Center</td>

38
doc/common/tables/cinder-dothill.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_dothill">
<caption>Description of Dot Hill volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>dothill_backend_name</option> = <replaceable>OpenStack</replaceable></td>
<td>(StrOpt) VDisk or Pool name to use for volume creation.</td>
</tr>
<tr>
<td><option>dothill_backend_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) linear (for VDisk) or realstor (for Pool).</td>
</tr>
<tr>
<td><option>dothill_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of comma separated target iSCSI IP addresses.</td>
</tr>
<tr>
<td><option>dothill_wbi_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DotHill web interface protocol.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/cinder-hds-hus.xml → doc/common/tables/cinder-drbd.xml
View File

@ -3,8 +3,8 @@
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hds-hus">
<caption>Description of HDS HUS iSCSI driver configuration options</caption>
<table rules="all" xml:id="config_table_cinder_drbd">
<caption>Description of DRBD configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,8 +18,8 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hds_cinder_config_file</option> = <replaceable>/opt/hds/hus/cinder_hus_conf.xml</replaceable></td>
<td>(StrOpt) The configuration file for the Cinder HDS driver for HUS</td>
<td><option>drbdmanage_redundancy</option> = <replaceable>1</replaceable></td>
<td>(StrOpt) Number of nodes that should replicate the data.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/cinder-emc.xml
View File

@ -58,8 +58,8 @@
<td>(StrOpt) VNX authentication scope type.</td>
</tr>
<tr>
<td><option>storage_vnx_pool_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pool name.</td>
<td><option>storage_vnx_pool_names</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Comma-separated list of storage pool names to be used.</td>
</tr>
<tr>
<td><option>storage_vnx_security_file_dir</option> = <replaceable>None</replaceable></td>

66
doc/common/tables/cinder-emc_sio.xml Normal file
View File

@ -0,0 +1,66 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_emc_sio">
<caption>Description of EMC SIO volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>sio_force_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to allow force delete.</td>
</tr>
<tr>
<td><option>sio_protection_domain_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Protection domain id.</td>
</tr>
<tr>
<td><option>sio_protection_domain_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Protection domain name.</td>
</tr>
<tr>
<td><option>sio_rest_server_port</option> = <replaceable>443</replaceable></td>
<td>(StrOpt) REST server port.</td>
</tr>
<tr>
<td><option>sio_round_volume_capacity</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to round volume capacity.</td>
</tr>
<tr>
<td><option>sio_server_certificate_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Server certificate path.</td>
</tr>
<tr>
<td><option>sio_storage_pool_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pool id.</td>
</tr>
<tr>
<td><option>sio_storage_pool_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pool name.</td>
</tr>
<tr>
<td><option>sio_storage_pools</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pools.</td>
</tr>
<tr>
<td><option>sio_unmap_volume_before_deletion</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to unmap volume before deletion.</td>
</tr>
<tr>
<td><option>sio_verify_server_certificate</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Whether to verify server certificate.</td>
</tr>
</tbody>
</table>
</para>

12
doc/common/tables/cinder-flashsystem.xml
View File

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_flashsystem">
<caption>Description of IBM FlashSystem volume river configuration options</caption>
<caption>Description of IBM FlashSystem volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -19,15 +19,19 @@
</tr>
<tr>
<td><option>flashsystem_connection_protocol</option> = <replaceable>FC</replaceable></td>
<td>(StrOpt) Connection protocol should be FC.</td>
<td>(StrOpt) Connection protocol should be FC. (Default is FC.)</td>
</tr>
<tr>
<td><option>flashsystem_iscsi_portid</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Default iSCSI Port ID of FlashSystem. (Default port is 0.)</td>
</tr>
<tr>
<td><option>flashsystem_multihostmap_enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Allows vdisk to multi host mapping.</td>
<td>(BoolOpt) Allows vdisk to multi host mapping. (Default is True)</td>
</tr>
<tr>
<td><option>flashsystem_multipath_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Connect with multipath (FC only).</td>
<td>(BoolOpt) Connect with multipath (FC only).(Default is false.)</td>
</tr>
</tbody>
</table>

46
doc/common/tables/cinder-hgst.xml Normal file
View File

@ -0,0 +1,46 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hgst">
<caption>Description of HGST volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hgst_net</option> = <replaceable>Net 1 (IPv4)</replaceable></td>
<td>(StrOpt) Space network name to use for data transfer</td>
</tr>
<tr>
<td><option>hgst_redundancy</option> = <replaceable>0</replaceable></td>
<td>(StrOpt) Should spaces be redundantly stored (1/0)</td>
</tr>
<tr>
<td><option>hgst_space_group</option> = <replaceable>disk</replaceable></td>
<td>(StrOpt) Group to own created spaces</td>
</tr>
<tr>
<td><option>hgst_space_mode</option> = <replaceable>0600</replaceable></td>
<td>(StrOpt) UNIX mode for created spaces</td>
</tr>
<tr>
<td><option>hgst_space_user</option> = <replaceable>root</replaceable></td>
<td>(StrOpt) User to own created spaces</td>
</tr>
<tr>
<td><option>hgst_storage_servers</option> = <replaceable>os:gbd0</replaceable></td>
<td>(StrOpt) Comma separated list of Space storage servers:devices. ex: os1_stor:gbd0,os2_stor:gbd0</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/cinder-hp3par.xml
View File

@ -43,7 +43,7 @@
</tr>
<tr>
<td><option>hp3par_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR Super user password</td>
<td>(StrOpt) 3PAR password for the user specified in hp3par_username</td>
</tr>
<tr>
<td><option>hp3par_snapshot_expiration</option> = <replaceable></replaceable></td>
@ -55,7 +55,7 @@
</tr>
<tr>
<td><option>hp3par_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR Super user username</td>
<td>(StrOpt) 3PAR username with the 'edit' role</td>
</tr>
</tbody>
</table>

38
doc/common/tables/cinder-hpmsa.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hpmsa">
<caption>Description of HP MSA Fiber Channel driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hpmsa_backend_name</option> = <replaceable>OpenStack</replaceable></td>
<td>(StrOpt) VDisk or Pool name to use for volume creation.</td>
</tr>
<tr>
<td><option>hpmsa_backend_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) linear (for VDisk) or realstor (for Pool).</td>
</tr>
<tr>
<td><option>hpmsa_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of comma separated target iSCSI IP addresses.</td>
</tr>
<tr>
<td><option>hpmsa_wbi_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPMSA web interface protocol.</td>
</tr>
</tbody>
</table>
</para>

94
doc/common/tables/cinder-hpxp.xml Normal file
View File

@ -0,0 +1,94 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_hpxp">
<caption>Description of HP XP volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hpxp_async_copy_check_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Interval to check copy asynchronously</td>
</tr>
<tr>
<td><option>hpxp_compute_target_ports</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Target port names of compute node for host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_copy_check_interval</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Interval to check copy</td>
</tr>
<tr>
<td><option>hpxp_copy_speed</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Copy speed of storage system</td>
</tr>
<tr>
<td><option>hpxp_default_copy_method</option> = <replaceable>FULL</replaceable></td>
<td>(StrOpt) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"</td>
</tr>
<tr>
<td><option>hpxp_group_request</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Request for creating host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_horcm_add_conf</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Add to HORCM configuration</td>
</tr>
<tr>
<td><option>hpxp_horcm_name_only_discovery</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Only discover a specific name of host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_horcm_numbers</option> = <replaceable>200, 201</replaceable></td>
<td>(ListOpt) Instance numbers for HORCM</td>
</tr>
<tr>
<td><option>hpxp_horcm_resource_name</option> = <replaceable>meta_resource</replaceable></td>
<td>(StrOpt) Resource group name of storage system for HORCM</td>
</tr>
<tr>
<td><option>hpxp_horcm_user</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username of storage system for HORCM</td>
</tr>
<tr>
<td><option>hpxp_ldev_range</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Logical device range of storage system</td>
</tr>
<tr>
<td><option>hpxp_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Pool of storage system</td>
</tr>
<tr>
<td><option>hpxp_storage_cli</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Type of storage command line interface</td>
</tr>
<tr>
<td><option>hpxp_storage_id</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) ID of storage system</td>
</tr>
<tr>
<td><option>hpxp_target_ports</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Target port names for host group or iSCSI target</td>
</tr>
<tr>
<td><option>hpxp_thin_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Thin pool of storage system</td>
</tr>
<tr>
<td><option>hpxp_zoning_request</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Request for FC Zone creating host group</td>
</tr>
</tbody>
</table>
</para>

54
doc/common/tables/cinder-infortrend.xml Normal file
View File

@ -0,0 +1,54 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_infortrend">
<caption>Description of Infortrend volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>infortrend_cli_max_retries</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Maximum retry time for cli. Default is 5.</td>
</tr>
<tr>
<td><option>infortrend_cli_path</option> = <replaceable>/opt/bin/Infortrend/raidcmd_ESDS10.jar</replaceable></td>
<td>(StrOpt) The Infortrend CLI absolute path. By default, it is at /opt/bin/Infortrend/raidcmd_ESDS10.jar</td>
</tr>
<tr>
<td><option>infortrend_cli_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Default timeout for CLI copy operations in minutes. Support: migrate volume, create cloned volume and create volume from snapshot. By Default, it is 30 minutes.</td>
</tr>
<tr>
<td><option>infortrend_pools_name</option> = <replaceable></replaceable></td>
<td>(StrOpt) Infortrend raid pool name list. It is separated with comma.</td>
</tr>
<tr>
<td><option>infortrend_provisioning</option> = <replaceable>full</replaceable></td>
<td>(StrOpt) Let the volume use specific provisioning. By default, it is the full provisioning. The supported options are full or thin.</td>
</tr>
<tr>
<td><option>infortrend_slots_a_channels_id</option> = <replaceable>0,1,2,3,4,5,6,7</replaceable></td>
<td>(StrOpt) Infortrend raid channel ID list on Slot A for OpenStack usage. It is separated with comma. By default, it is the channel 0~7.</td>
</tr>
<tr>
<td><option>infortrend_slots_b_channels_id</option> = <replaceable>0,1,2,3,4,5,6,7</replaceable></td>
<td>(StrOpt) Infortrend raid channel ID list on Slot B for OpenStack usage. It is separated with comma. By default, it is the channel 0~7.</td>
</tr>
<tr>
<td><option>infortrend_tiering</option> = <replaceable>0</replaceable></td>
<td>(StrOpt) Let the volume use specific tiering level. By default, it is the level 0. The supported levels are 0,2,3,4.</td>
</tr>
</tbody>
</table>
</para>

38
doc/common/tables/cinder-lenovo.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_lenovo">
<caption>Description of Lenovo volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>lenovo_backend_name</option> = <replaceable>OpenStack</replaceable></td>
<td>(StrOpt) VDisk or Pool name to use for volume creation.</td>
</tr>
<tr>
<td><option>lenovo_backend_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) linear (for VDisk) or realstor (for Pool).</td>
</tr>
<tr>
<td><option>lenovo_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of comma separated target iSCSI IP addresses.</td>
</tr>
<tr>
<td><option>lenovo_wbi_protocol</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Lenovo web interface protocol.</td>
</tr>
</tbody>
</table>
</para>

40
doc/common/tables/cinder-logging.xml
View File

@ -61,26 +61,6 @@
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td><option>log_config_append</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
</tr>
<tr>
<td><option>log_date_format</option> = <replaceable>%Y-%m-%d %H:%M:%S</replaceable></td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
</tr>
<tr>
<td><option>log_dir</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
</tr>
<tr>
<td><option>log_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td><option>log_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead.</td>
</tr>
<tr>
<td><option>logging_context_format_string</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</replaceable></td>
<td>(StrOpt) Format string to use for log messages with context.</td>
@ -94,7 +74,7 @@
<td>(StrOpt) Format string to use for log messages without context.</td>
</tr>
<tr>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</replaceable></td>
<td><option>logging_exception_prefix</option> = <replaceable>%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s</replaceable></td>
<td>(StrOpt) Prefix each line of exception output with this format.</td>
</tr>
<tr>
@ -105,29 +85,17 @@
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td><option>syslog_log_facility</option> = <replaceable>LOG_USER</replaceable></td>
<td>(StrOpt) Syslog facility to receive log lines.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
</tr>
<tr>
<td><option>use_stderr</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Log output to standard error.</td>
</tr>
<tr>
<td><option>use_syslog</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424.</td>
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in K, and will be removed in M, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>

4
doc/common/tables/cinder-netapp_cdot_iscsi.xml
View File

@ -21,6 +21,10 @@
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_lun_ostype</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>

12
doc/common/tables/cinder-netapp_cdot_nfs.xml
View File

@ -25,10 +25,22 @@
<td><option>netapp_copyoffload_tool_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.</td>
</tr>
<tr>
<td><option>netapp_host_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.</td>
</tr>
<tr>
<td><option>netapp_host_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.</td>
</tr>
<tr>
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Administrative user account name used to access the storage system or proxy server.</td>
</tr>
<tr>
<td><option>netapp_lun_ostype</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system that will access a LUN exported from Data ONTAP; it is assigned to the LUN at the time it is created.</td>
</tr>
<tr>
<td><option>netapp_partner_backend_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The name of the config.conf stanza for a Data ONTAP (7-mode) HA partner. This option is only used by the driver when connecting to an instance with a storage family of Data ONTAP operating in 7-Mode, and it is required if the storage protocol selected is FC.</td>

8
doc/common/tables/cinder-netapp_eseries_iscsi.xml
View File

@ -22,8 +22,12 @@
<td>(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.</td>
</tr>
<tr>
<td><option>netapp_eseries_host_type</option> = <replaceable>linux_dm_mp</replaceable></td>
<td>(StrOpt) This option is used to define how the controllers in the E-Series storage array will work with the particular operating system on the hosts that are connected to it.</td>
<td><option>netapp_enable_multiattach</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) This option specifies whether the driver should allow operations that require multiple attachments to a volume. An example would be live migration of servers that have volumes attached. When enabled, this backend is limited to 256 total volumes in order to guarantee volumes can be accessed by more than one host.</td>
</tr>
<tr>
<td><option>netapp_host_type</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) This option defines the type of operating system for all initiators that can access a LUN. This information is used when mapping LUNs to individual hosts or groups of hosts.</td>
</tr>
<tr>
<td><option>netapp_login</option> = <replaceable>None</replaceable></td>

26
doc/common/tables/cinder-oslo_middleware.xml
View File

@ -1,26 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_oslo_middleware">
<caption>Description of oslo_middleware configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>
<tr>
<td><option>max_request_body_size</option> = <replaceable>114688</replaceable></td>
<td>(IntOpt) The maximum body size for each request, in bytes.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/cinder-qpid.xml
View File

@ -70,8 +70,8 @@
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
</tr>
</tbody>
</table>

42
doc/common/tables/cinder-quobyte.xml
View File

@ -1,42 +0,0 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_quobyte">
<caption>Description of Quobyte USP volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>quobyte_client_cfg</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Path to a Quobyte Client configuration file.</td>
</tr>
<tr>
<td><option>quobyte_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
<td>(StrOpt) Base dir containing the mount point for the Quobyte volume.</td>
</tr>
<tr>
<td><option>quobyte_qcow2_volumes</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Create volumes as QCOW2 files rather than raw files.</td>
</tr>
<tr>
<td><option>quobyte_sparsed_volumes</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Create volumes as sparse files which take no space. If set to False, volume is created as regular file.In such case volume creation takes a lot of time.</td>
</tr>
<tr>
<td><option>quobyte_volume_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) URL to the Quobyte volume e.g., quobyte://&lt;DIR host&gt;/&lt;volume name&gt;</td>
</tr>
</tbody>
</table>
</para>

12
doc/common/tables/cinder-rabbitmq.xml
View File

@ -34,13 +34,17 @@
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disables the heartbeat, &gt;0 enables it. Enabling heartbeats requires kombu&gt;=3.0.7 and amqp&gt;=1.4.0). EXPERIMENTAL</td>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). EXPERIMENTAL</td>
</tr>
<tr>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td><option>kombu_reconnect_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) How long to wait before considering a reconnect attempt to have failed. This value should not be longer than rpc_response_timeout.</td>
</tr>
<tr>
<td><option>kombu_ssl_ca_certs</option> = <replaceable></replaceable></td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
@ -106,8 +110,8 @@
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
</tr>
</tbody>
</table>

4
doc/common/tables/cinder-rpc.xml
View File

@ -33,6 +33,10 @@
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>

2
doc/common/tables/cinder-solidfire.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>sf_account_prefix</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostsname (previous default behavior). The default is NO prefix.</td>
<td>(StrOpt) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix.</td>
</tr>
<tr>
<td><option>sf_allow_template_caching</option> = <replaceable>True</replaceable></td>

4
doc/common/tables/cinder-storage.xml
View File

@ -53,6 +53,10 @@
<td><option>iscsi_protocol</option> = <replaceable>iscsi</replaceable></td>
<td>(StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser".</td>
</tr>
<tr>
<td><option>iscsi_target_flags</option> = <replaceable></replaceable></td>
<td>(StrOpt) Sets the target-specific flags for the iSCSI target. Only used for tgtadm to specify backing device flags using bsoflags option. The specified string is passed as is to the underlying tool.</td>
</tr>
<tr>
<td><option>iscsi_target_prefix</option> = <replaceable>iqn.2010-10.org.openstack:</replaceable></td>
<td>(StrOpt) Prefix for iSCSI volumes</td>

12
doc/common/tables/cinder-storage_ceph.xml
View File

@ -21,10 +21,22 @@
<td><option>rados_connect_timeout</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value &lt; 0, no timeout is set and default librados value is used.</td>
</tr>
<tr>
<td><option>rados_connection_interval</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Interval value (in seconds) between connection retries to ceph cluster.</td>
</tr>
<tr>
<td><option>rados_connection_retries</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of retries if connection to ceph cluster failed.</td>
</tr>
<tr>
<td><option>rbd_ceph_conf</option> = <replaceable></replaceable></td>
<td>(StrOpt) Path to the ceph configuration file</td>
</tr>
<tr>
<td><option>rbd_cluster_name</option> = <replaceable>ceph</replaceable></td>
<td>(StrOpt) The name of ceph cluster</td>
</tr>
<tr>
<td><option>rbd_flatten_volume_from_snapshot</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Flatten volumes created from snapshots to remove dependency from volume to snapshot</td>

30
doc/common/tables/cinder-storpool.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_storpool">
<caption>Description of StorPool volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>storpool_replication</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) The default StorPool chain replication value. Used when creating a volume with no specified type if storpool_template is not set. Also used for calculating the apparent free space reported in the stats.</td>
</tr>
<tr>
<td><option>storpool_template</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The StorPool template for volumes with no type.</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/cinder-storwize.xml
View File

@ -42,8 +42,8 @@
<td>(BoolOpt) Connect with multipath (FC only; iSCSI multipath is controlled by Nova)</td>
</tr>
<tr>
<td><option>storwize_svc_npiv_compatibility_mode</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection</td>
<td><option>storwize_svc_npiv_compatibility_mode</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Indicate whether svc driver is compatible for NPIV setup. If it is compatible, it will allow no wwpns being returned on get_conn_fc_wwpns during initialize_connection. It should always be set to True. It will be deprecated and removed in M release.</td>
</tr>
<tr>
<td><option>storwize_svc_stretched_cluster_partner</option> = <replaceable>None</replaceable></td>

18
doc/common/tables/cinder-tintri.xml
View File

@ -4,7 +4,7 @@
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_tintri">
<caption>Description of Tintri driver configuration options</caption>
<caption>Description of Tintri volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -18,20 +18,20 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>tintri_server_hostname</option> = <replaceable> None </replaceable></td>
<td>(StrOpt) Tintri VMstore management IP address</td>
<td><option>tintri_api_version</option> = <replaceable>v310</replaceable></td>
<td>(StrOpt) API version for the storage system</td>
</tr>
<tr>
<td><option>tintri_server_username</option> = <replaceable> None </replaceable></td>
<td>(StrOpt) Tintri VMstore username</td>
<td><option>tintri_server_hostname</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The hostname (or IP address) for the storage system</td>
</tr>
<tr>
<td><option>tintri_server_password</option> = <replaceable> None </replaceable></td>
<td>(StrOpt) Tintri VMstore password for the user</td>
<td><option>tintri_server_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for the storage system</td>
</tr>
<tr>
<td><option>tintri_api_version</option> = <replaceable> v310 </replaceable></td>
<td>(StrOpt) Tintri VMstore API version</td>
<td><option>tintri_server_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) User name for the storage system</td>
</tr>
</tbody>
</table>

4
doc/common/tables/cinder-violin.xml
View File

@ -29,6 +29,10 @@
<td><option>use_igroups</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use igroups to manage targets and initiators</td>
</tr>
<tr>
<td><option>violin_request_timeout</option> = <replaceable>300</replaceable></td>
<td>(IntOpt) Global backend request timeout, in seconds.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/cinder-vmware.xml
View File

@ -21,6 +21,10 @@
<td><option>vmware_api_retry_count</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
</tr>
<tr>
<td><option>vmware_ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) CA bundle file to use in verifying the vCenter server certificate.</td>
</tr>
<tr>
<td><option>vmware_host_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
@ -41,6 +45,10 @@
<td><option>vmware_image_transfer_timeout_secs</option> = <replaceable>7200</replaceable></td>
<td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
</tr>
<tr>
<td><option>vmware_insecure</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set.</td>
</tr>
<tr>
<td><option>vmware_max_objects_retrieval</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>

42
doc/common/tables/cinder-vzstorage.xml Normal file
View File

@ -0,0 +1,42 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_vzstorage">
<caption>Description of VidZapper Storage volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>vzstorage_mount_options</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Mount options passed to the vzstorage client. See section of the pstorage-mount man page for details.</td>
</tr>
<tr>
<td><option>vzstorage_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>
<td>(StrOpt) Base dir containing mount points for vzstorage shares.</td>
</tr>
<tr>
<td><option>vzstorage_shares_config</option> = <replaceable>/etc/cinder/vzstorage_shares</replaceable></td>
<td>(StrOpt) File with the list of available vzstorage shares.</td>
</tr>
<tr>
<td><option>vzstorage_sparsed_volumes</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Create volumes as sparsed files which take no space rather than regular files when using raw format, in which case volume creation takes lot of time.</td>
</tr>
<tr>
<td><option>vzstorage_used_ratio</option> = <replaceable>0.95</replaceable></td>
<td>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.</td>
</tr>
</tbody>
</table>
</para>

20
doc/common/tables/cinder-xio.xml
View File

@ -21,26 +21,6 @@
<td><option>driver_use_ssl</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Tell driver to use SSL for connection to backend storage if the driver supports it.</td>
</tr>
<tr>
<td><option>ise_completion_retries</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Number on retries to get completion status after issuing a command to ISE.</td>
</tr>
<tr>
<td><option>ise_connection_retries</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) Number of retries (per port) when establishing connection to ISE management port.</td>
</tr>
<tr>
<td><option>ise_raid</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Raid level for ISE volumes.</td>
</tr>
<tr>
<td><option>ise_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Interval (secs) between retries.</td>
</tr>
<tr>
<td><option>ise_storage_pool</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Default storage pool for volumes.</td>
</tr>
</tbody>
</table>
</para>

86
doc/common/tables/cinder-zfssa-iscsi.xml Normal file
View File

@ -0,0 +1,86 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_zfssa-iscsi">
<caption>Description of ZFS Storage Appliance iSCSI driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>zfssa_initiator</option> = <replaceable></replaceable></td>
<td>(StrOpt) iSCSI initiator IQNs. (comma separated)</td>
</tr>
<tr>
<td><option>zfssa_initiator_config</option> = <replaceable></replaceable></td>
<td>(StrOpt) iSCSI initiators configuration.</td>
</tr>
<tr>
<td><option>zfssa_initiator_group</option> = <replaceable></replaceable></td>
<td>(StrOpt) iSCSI initiator group.</td>
</tr>
<tr>
<td><option>zfssa_initiator_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Secret of the iSCSI initiator CHAP user.</td>
</tr>
<tr>
<td><option>zfssa_initiator_user</option> = <replaceable></replaceable></td>
<td>(StrOpt) iSCSI initiator CHAP user (name).</td>
</tr>
<tr>
<td><option>zfssa_lun_compression</option> = <replaceable>off</replaceable></td>
<td>(StrOpt) Data compression.</td>
</tr>
<tr>
<td><option>zfssa_lun_logbias</option> = <replaceable>latency</replaceable></td>
<td>(StrOpt) Synchronous write bias.</td>
</tr>
<tr>
<td><option>zfssa_lun_sparse</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Flag to enable sparse (thin-provisioned): True, False.</td>
</tr>
<tr>
<td><option>zfssa_lun_volblocksize</option> = <replaceable>8k</replaceable></td>
<td>(StrOpt) Block size.</td>
</tr>
<tr>
<td><option>zfssa_pool</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Storage pool name.</td>
</tr>
<tr>
<td><option>zfssa_project</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Project name.</td>
</tr>
<tr>
<td><option>zfssa_target_group</option> = <replaceable>tgt-grp</replaceable></td>
<td>(StrOpt) iSCSI target group name.</td>
</tr>
<tr>
<td><option>zfssa_target_interfaces</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Network interfaces of iSCSI targets. (comma separated)</td>
</tr>
<tr>
<td><option>zfssa_target_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Secret of the iSCSI target CHAP user.</td>
</tr>
<tr>
<td><option>zfssa_target_portal</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) iSCSI target portal (Data-IP:Port, w.x.y.z:3260).</td>
</tr>
<tr>
<td><option>zfssa_target_user</option> = <replaceable></replaceable></td>
<td>(StrOpt) iSCSI target CHAP user (name).</td>
</tr>
</tbody>
</table>
</para>

27
doc/config-reference/block-storage/drivers/quobyte-driver.xml
View File

@ -1,27 +0,0 @@
<section xml:id="Quobyte-driver"
xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<title>Quobyte driver</title>
<para><link xlink:href="http://www.quobyte.com/">Quobyte
</link> provides a software defined storage system running
on plain Linux servers.
Quobyte allows reconfiguration at runtime without storage
service interruption. Storage behaviour is fully configurable
via policies which also control automation and hardware
independent configuration. Quobyte users can find more
information via the documentation link at
<link xlink:href="http://support.quobyte.com/">
http://support.quobyte.com/</link>.</para>
<para>This driver enables the use of Quobyte storage in a similar
fashion as NFS. It supports basic volume operations, including
snapshot and clone.</para>
<para>To use Block Storage with Quobyte, first set the
<literal>volume_driver</literal> configuration option in the
<filename>cinder.conf</filename> file:</para>
<programlisting>volume_driver = cinder.volume.drivers.quobyte.QuobyteDriver</programlisting>
<para>The following table contains the configuration options
supported by the Quobyte volume driver.</para>
<xi:include href="../../../common/tables/cinder-quobyte.xml" />
</section>

14
doc/config-reference/block-storage/section_misc.xml
View File

@ -16,25 +16,34 @@
<xi:include href="../../common/tables/cinder-auth.xml"/>
<xi:include href="../../common/tables/cinder-auth_token.xml"/>
<xi:include href="../../common/tables/cinder-backups.xml"/>
<xi:include href="../../common/tables/cinder-blockbridge.xml"/>
<xi:include href="../../common/tables/cinder-block-device.xml"/>
<xi:include href="../../common/tables/cinder-ca.xml"/>
<xi:include href="../../common/tables/cinder-cloudbyte.xml"/>
<xi:include href="../../common/tables/cinder-common.xml"/>
<xi:include href="../../common/tables/cinder-compute.xml"/>
<xi:include href="../../common/tables/cinder-cors.xml"/>
<xi:include href="../../common/tables/cinder-database.xml"/>
<xi:include href="../../common/tables/cinder-debug.xml"/>
<xi:include href="../../common/tables/cinder-dothill.xml"/>
<xi:include href="../../common/tables/cinder-drbd.xml"/>
<xi:include href="../../common/tables/cinder-emc.xml"/>
<xi:include href="../../common/tables/cinder-emc_sio.xml"/>
<xi:include href="../../common/tables/cinder-flashsystem.xml"/>
<xi:include href="../../common/tables/cinder-hgst.xml"/>
<xi:include href="../../common/tables/cinder-hp3par.xml"/>
<xi:include href="../../common/tables/cinder-hplefthand.xml"/>
<xi:include href="../../common/tables/cinder-hpmsa.xml"/>
<xi:include href="../../common/tables/cinder-hpxp.xml"/>
<xi:include href="../../common/tables/cinder-huawei.xml"/>
<xi:include href="../../common/tables/cinder-ibmnas.xml"/>
<xi:include href="../../common/tables/cinder-images.xml"/>
<xi:include href="../../common/tables/cinder-infortrend.xml"/>
<xi:include href="../../common/tables/cinder-keymgr.xml"/>
<xi:include href="../../common/tables/cinder-lenovo.xml"/>
<xi:include href="../../common/tables/cinder-logging.xml"/>
<xi:include href="../../common/tables/cinder-nas.xml"/>
<xi:include href="../../common/tables/cinder-openvstorage.xml"/>
<xi:include href="../../common/tables/cinder-oslo_middleware.xml"/>
<xi:include href="../../common/tables/cinder-profiler.xml"/>
<xi:include href="../../common/tables/cinder-pure.xml"/>
<xi:include href="../../common/tables/cinder-qpid.xml"/>
@ -47,8 +56,11 @@
<xi:include href="../../common/tables/cinder-scst.xml"/>
<xi:include href="../../common/tables/cinder-srb.xml"/>
<xi:include href="../../common/tables/cinder-storage.xml"/>
<xi:include href="../../common/tables/cinder-storpool.xml"/>
<xi:include href="../../common/tables/cinder-violin.xml"/>
<xi:include href="../../common/tables/cinder-vzstorage.xml"/>
<xi:include href="../../common/tables/cinder-zeromq.xml"/>
<xi:include href="../../common/tables/cinder-zfssa-iscsi.xml"/>
<xi:include href="../../common/tables/cinder-zones.xml"/>
</section>

1
doc/config-reference/block-storage/section_volume-drivers.xml
View File

@ -37,7 +37,6 @@
<xi:include href="drivers/nfs-volume-driver.xml"/>
<xi:include href="drivers/prophetstor-dpl-driver.xml"/>
<xi:include href="drivers/pure-storage-driver.xml"/>
<xi:include href="drivers/quobyte-driver.xml"/>
<xi:include href="drivers/scality-sofs-driver.xml"/>
<xi:include href="drivers/sheepdog-driver.xml"/>
<xi:include href="drivers/smbfs-volume-driver.xml"/>

169
tools/autogenerate-config-flagmappings/cinder.flagmappings
View File

@ -5,7 +5,6 @@ api_rate_limit api
auth_strategy auth
available_devices block-device
az_cache_duration api
backdoor_port debug
backend_host api
backup_api_class backups
backup_ceph_chunk_size backups_ceph
@ -30,6 +29,7 @@ backup_share backups_nfs
backup_swift_auth backups_swift
backup_swift_auth_version backups_swift
backup_swift_block_size backups_swift
backup_swift_ca_cert_file backups_swift
backup_swift_container backups_swift
backup_swift_enable_progress_timer backups_swift
backup_swift_key backups_swift
@ -44,10 +44,19 @@ backup_topic backups
backup_tsm_compression backups_tsm
backup_tsm_password backups_tsm
backup_tsm_volume_prefix backups_tsm
blockbridge_api_host blockbridge
blockbridge_api_port blockbridge
blockbridge_auth_password blockbridge
blockbridge_auth_scheme blockbridge
blockbridge_auth_token blockbridge
blockbridge_auth_user blockbridge
blockbridge_default_pool blockbridge
blockbridge_pools blockbridge
capacity_weight_multiplier storage
cb_account_name cloudbyte
cb_add_qosgroup cloudbyte
cb_apikey cloudbyte
cb_auth_group cloudbyte
cb_confirm_volume_create_retries cloudbyte
cb_confirm_volume_create_retry_interval cloudbyte
cb_create_volume cloudbyte
@ -76,14 +85,22 @@ default_volume_type common
dell_sc_api_port dellsc
dell_sc_server_folder dellsc
dell_sc_ssn dellsc
dell_sc_verify_cert dellsc
dell_sc_volume_folder dellsc
destroy_empty_storage_group emc
dothill_backend_name dothill
dothill_backend_type dothill
dothill_iscsi_ips dothill
dothill_wbi_protocol dothill
dpl_pool prophetstor_dpl
dpl_port prophetstor_dpl
drbdmanage_redundancy drbd
driver_client_cert datera
driver_client_cert_key datera
driver_data_namespace common
driver_ssl_cert_verify common
driver_use_ssl xio
enable_force_upload common
enable_new_services common
enable_v1_api api
enable_v2_api api
@ -103,6 +120,7 @@ fatal_deprecations logging
fatal_exception_format_errors logging
filter_function scheduler
flashsystem_connection_protocol flashsystem
flashsystem_iscsi_portid flashsystem
flashsystem_multihostmap_enabled flashsystem
flashsystem_multipath_enabled flashsystem
force_delete_lun_in_storagegroup emc
@ -129,9 +147,14 @@ gpfs_max_clone_depth storage_gpfs
gpfs_mount_point_base storage_gpfs
gpfs_sparse_volumes storage_gpfs
gpfs_storage_pool storage_gpfs
hds_cinder_config_file hds-hus
hds_hnas_iscsi_config_file hds-hnas
hds_hnas_nfs_config_file hds-hnas
hgst_net hgst
hgst_redundancy hgst
hgst_space_group hgst
hgst_space_mode hgst
hgst_space_user hgst
hgst_storage_servers hgst
hitachi_add_chap_user hitachi-hbsd
hitachi_async_copy_check_interval hitachi-hbsd
hitachi_auth_method hitachi-hbsd
@ -170,9 +193,40 @@ hplefthand_debug hplefthand
hplefthand_iscsi_chap_enabled hplefthand
hplefthand_password hplefthand
hplefthand_username hplefthand
hpmsa_backend_name hpmsa
hpmsa_backend_type hpmsa
hpmsa_iscsi_ips hpmsa
hpmsa_wbi_protocol hpmsa
hpxp_async_copy_check_interval hpxp
hpxp_compute_target_ports hpxp
hpxp_copy_check_interval hpxp
hpxp_copy_speed hpxp
hpxp_default_copy_method hpxp
hpxp_group_request hpxp
hpxp_horcm_add_conf hpxp
hpxp_horcm_name_only_discovery hpxp
hpxp_horcm_numbers hpxp
hpxp_horcm_resource_name hpxp
hpxp_horcm_user hpxp
hpxp_ldev_range hpxp
hpxp_pool hpxp
hpxp_storage_cli hpxp
hpxp_storage_id hpxp
hpxp_target_ports hpxp
hpxp_thin_pool hpxp
hpxp_zoning_request hpxp
ibmnas_platform_type ibmnas
iet_conf common
ignore_pool_full_threshold api
image_conversion_dir images
infortrend_cli_max_retries infortrend
infortrend_cli_path infortrend
infortrend_cli_timeout infortrend
infortrend_pools_name infortrend
infortrend_provisioning infortrend
infortrend_slots_a_channels_id infortrend
infortrend_slots_b_channels_id infortrend
infortrend_tiering infortrend
initiator_auto_deregistration emc
initiator_auto_registration emc
instance_format logging
@ -185,24 +239,19 @@ iscsi_num_targets storage
iscsi_port storage prophetstor_dpl
iscsi_protocol storage
iscsi_secondary_ip_addresses common
iscsi_target_flags storage
iscsi_target_prefix storage
iscsi_write_cache storage
ise_completion_retries xio
ise_connection_retries xio
ise_raid xio
ise_retry_interval xio
ise_storage_pool xio
iser_helper storage
iser_ip_address storage
iser_num_targets storage
iser_port storage
iser_target_prefix storage
lenovo_backend_name lenovo
lenovo_backend_type lenovo
lenovo_iscsi_ips lenovo
lenovo_wbi_protocol lenovo
lio_initiator_iqns common
log-config-append logging
log-date-format logging
log-dir logging
log-file logging
log-format logging
log_config_append logging
log_date_format logging
log_dir logging
@ -215,6 +264,7 @@ logging_exception_prefix logging
lvm_conf_file lvm
lvm_mirrors lvm
lvm_type lvm
management_ips api
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
max_age quota
@ -239,8 +289,10 @@ nas_ssh_port nas
naviseccli_path emc
netapp_controller_ips netapp_eseries_iscsi
netapp_copyoffload_tool_path netapp_cdot_nfs
netapp_eseries_host_type netapp_eseries_iscsi
netapp_enable_multiattach netapp_eseries_iscsi
netapp_host_type netapp_cdot_nfs netapp_cdot_nfs netapp_eseries_iscsi
netapp_login netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi
netapp_lun_ostype netapp_cdot_nfs netapp_cdot_iscsi
netapp_partner_backend_name netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi
netapp_password netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_eseries_iscsi
netapp_sa_password netapp_eseries_iscsi
@ -276,6 +328,7 @@ nova_endpoint_template compute
num_iser_scan_tries storage
num_shell_tries common
num_volume_device_scan_tries storage
os_privileged_user_auth_url common
os_privileged_user_name common
os_privileged_user_password common
os_privileged_user_tenant common
@ -288,19 +341,13 @@ osapi_volume_extension api
osapi_volume_listen api
osapi_volume_listen_port api
osapi_volume_workers api
per_volume_size_limit api
periodic_fuzzy_delay common
periodic_interval common
policy_default_rule common
policy_dirs common
policy_file common
public_endpoint api
publish_errors logging
pure_api_token pure
quobyte_client_cfg quobyte
quobyte_mount_point_base quobyte
quobyte_qcow2_volumes quobyte
quobyte_sparsed_volumes quobyte
quobyte_volume_url quobyte
query_volume_filters api
quota_backup_gigabytes quota
quota_backups quota
quota_consistencygroups quota
@ -309,7 +356,10 @@ quota_gigabytes quota
quota_snapshots quota
quota_volumes quota
rados_connect_timeout storage_ceph
rados_connection_interval storage_ceph
rados_connection_retries storage_ceph
rbd_ceph_conf storage_ceph
rbd_cluster_name storage_ceph
rbd_flatten_volume_from_snapshot storage_ceph
rbd_max_clone_depth storage_ceph
rbd_pool storage_ceph
@ -325,6 +375,7 @@ restore_discard_excess_bytes backups_ceph
rootwrap_config common
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address zeromq
@ -334,7 +385,6 @@ rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
run_external_periodic_tasks common
san_clustername san xiv
san_ip san prophetstor_dpl xiv
san_is_local san
@ -365,6 +415,17 @@ sf_allow_tenant_qos solidfire
sf_api_port solidfire
sf_emulate_512 solidfire
sf_template_account_name solidfire
sio_force_delete emc_sio
sio_protection_domain_id emc_sio
sio_protection_domain_name emc_sio
sio_rest_server_port emc_sio
sio_round_volume_capacity emc_sio
sio_server_certificate_path emc_sio
sio_storage_pool_id emc_sio
sio_storage_pool_name emc_sio
sio_storage_pools emc_sio
sio_unmap_volume_before_deletion emc_sio
sio_verify_server_certificate emc_sio
smbfs_default_volume_format smbfs
smbfs_mount_options smbfs
smbfs_mount_point_base smbfs
@ -387,8 +448,10 @@ start_time common
state_path common
storage_availability_zone common
storage_vnx_authentication_type emc
storage_vnx_pool_name emc
storage_vnx_pool_names emc
storage_vnx_security_file_dir emc
storpool_replication storpool
storpool_template storpool
storwize_svc_allow_tenant_qos storwize
storwize_svc_connection_protocol storwize
storwize_svc_flashcopy_timeout storwize
@ -407,23 +470,21 @@ storwize_svc_vol_warning storwize
storwize_svc_volpool_name storwize
strict_ssh_host_key_policy common
swift_catalog_info backups_swift
syslog-log-facility logging
syslog_log_facility logging
tcp_keepalive common
tcp_keepalive_count common
tcp_keepalive_interval common
tcp_keepidle common
tintri_server_hostname tintri
tintri_server_username tintri
tintri_server_password tintri
tintri_api_version tintri
thres_avl_size_perc_start netapp_7mode_nfs netapp_cdot_nfs
thres_avl_size_perc_stop netapp_7mode_nfs netapp_cdot_nfs
tintri_api_version tintri
tintri_server_hostname tintri
tintri_server_password tintri
tintri_server_username tintri
trace_flags debug
transfer_api_class api
transport_url amqp
until_refresh common
use-syslog logging
use-syslog-rfc-format logging
use_chap_auth common
use_default_quota_class quota
use_forwarded_for common
@ -433,12 +494,15 @@ use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
verbose logging
violin_request_timeout violin
vmware_api_retry_count vmware
vmware_ca_file vmware
vmware_host_ip vmware
vmware_host_password vmware
vmware_host_username vmware
vmware_host_version vmware
vmware_image_transfer_timeout_secs vmware
vmware_insecure vmware
vmware_max_objects_retrieval vmware
vmware_task_poll_interval vmware
vmware_tmp_dir vmware
@ -465,6 +529,11 @@ volume_transfer_salt_length api
volume_usage_audit_period storage
volumes_dir storage
vpool_name openvstorage
vzstorage_mount_options vzstorage
vzstorage_mount_point_base vzstorage
vzstorage_shares_config vzstorage
vzstorage_sparsed_volumes vzstorage
vzstorage_used_ratio vzstorage
windows_iscsi_lun_path windows
wsgi_keep_alive common
xiv_chap xiv
@ -473,13 +542,29 @@ xiv_ds8k_proxy xiv
xtremio_cluster_name emc
zfssa_data_ip zfssa-nfs
zfssa_https_port zfssa-nfs
zfssa_initiator zfssa-iscsi
zfssa_initiator_config zfssa-iscsi
zfssa_initiator_group zfssa-iscsi
zfssa_initiator_password zfssa-iscsi
zfssa_initiator_user zfssa-iscsi
zfssa_lun_compression zfssa-iscsi
zfssa_lun_logbias zfssa-iscsi
zfssa_lun_sparse zfssa-iscsi
zfssa_lun_volblocksize zfssa-iscsi
zfssa_nfs_mount_options zfssa-nfs
zfssa_nfs_pool zfssa-nfs
zfssa_nfs_project zfssa-nfs
zfssa_nfs_share zfssa-nfs
zfssa_nfs_share_compression zfssa-nfs
zfssa_nfs_share_logbias zfssa-nfs
zfssa_pool zfssa-iscsi
zfssa_project zfssa-iscsi
zfssa_rest_timeout zfssa zfssa-nfs
zfssa_target_group zfssa-iscsi
zfssa_target_interfaces zfssa-iscsi
zfssa_target_password zfssa-iscsi
zfssa_target_portal zfssa-iscsi
zfssa_target_user zfssa-iscsi
zoning_mode zoning
BRCD_FABRIC_EXAMPLE/fc_fabric_address zoning_fabric
BRCD_FABRIC_EXAMPLE/fc_fabric_password zoning_fabric
@ -497,6 +582,18 @@ CISCO_FABRIC_EXAMPLE/cisco_zone_activate zoning_fabric_cisco
CISCO_FABRIC_EXAMPLE/cisco_zone_name_prefix zoning_fabric_cisco
CISCO_FABRIC_EXAMPLE/cisco_zoning_policy zoning_fabric_cisco
CISCO_FABRIC_EXAMPLE/cisco_zoning_vsan zoning_fabric_cisco
cors/allow_credentials cors
cors/allow_headers cors
cors/allow_methods cors
cors/allowed_origin cors
cors/expose_headers cors
cors/max_age cors
cors.subdomain/allow_credentials cors
cors.subdomain/allow_headers cors
cors.subdomain/allow_methods cors
cors.subdomain/allowed_origin cors
cors.subdomain/expose_headers cors
cors.subdomain/max_age cors
database/backend database
database/connection database
database/connection_debug database
@ -595,13 +692,14 @@ oslo_messaging_qpid/qpid_sasl_mechanisms qpid
oslo_messaging_qpid/qpid_tcp_nodelay qpid
oslo_messaging_qpid/qpid_topology_version qpid
oslo_messaging_qpid/qpid_username qpid
oslo_messaging_qpid/rpc_conn_pool_size qpid
oslo_messaging_qpid/send_single_reply qpid
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/fake_rabbit rabbitmq
oslo_messaging_rabbit/heartbeat_rate rabbitmq
oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq
oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_reconnect_timeout rabbitmq
oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq
oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq
@ -618,7 +716,12 @@ oslo_messaging_rabbit/rabbit_retry_interval rabbitmq
oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/rpc_conn_pool_size rabbitmq
oslo_middleware/max_request_body_size oslo_middleware
oslo_messaging_rabbit/send_single_reply rabbitmq
oslo_middleware/max_request_body_size api
oslo_middleware/secure_proxy_ssl_header api
oslo_policy/policy_default_rule api
oslo_policy/policy_dirs api
oslo_policy/policy_file api
oslo_versionedobjects/fatal_exception_format_errors api
profiler/profiler_enabled profiler
profiler/trace_sqlalchemy profiler

11
tools/autogenerate-config-flagmappings/cinder.headers
View File

@ -4,24 +4,31 @@ backups_nfs NFS backup driver
backups_swift Swift backup driver
backups_tsm IBM Tivoli Storage Manager backup driver
block-device block device
blockbridge BlockBridge EPS volume driver
cloudbyte CloudByte volume driver
datera Datera volume driver
dellsc Dell Storage Center volume driver
dothill Dot Hill volume driver
drbd DRBD
emc EMC
emc_sio EMC SIO volume driver
eqlx Dell EqualLogic volume driver
flashsystem IBM FlashSystem volume river
flashsystem IBM FlashSystem volume driver
fujitsu_eternus_dx Fujitsu ETERNUS DX volume driver
fusionio Fusion-io driver
hds-hnas HDS HNAS iSCSI and NFS driver
hds-hus HDS HUS iSCSI driver
hgst HGST volume driver
hitachi-hbsd Hitachi storage volume driver
hp3par HP 3PAR Fibre Channel and iSCSI drivers
hplefthand HP LeftHand/StoreVirtual driver
hpmsa HP MSA Fiber Channel driver
hpxp HP XP volume driver
huawei Huawei storage driver
ibmnas IBM NAS volume driver
images images
infortrend Infortrend volume driver
lenovo Lenovo volume driver
lvm LVM
nas NAS
netapp_7mode_iscsi NetApp 7-Mode iSCSI driver
@ -53,11 +60,13 @@ storwize IBM Storwise driver
srb Scality REST Block storage driver
tintri Tintri volume driver
violin Violin volume driver
vzstorage VidZapper Storage volume driver
windows Windows
xio X-IO volume driver
xiv IBM XIV and DS8000 volume driver
zadara Zadara Storage driver
zfssa ZFS Storage Appliance iSCSI driver
zfssa-iscsi ZFS Storage Appliance iSCSI driver
zfssa-nfs ZFS Storage Appliance NFS driver
zones zones
zoning zoning