Add missing flagmappings from recent changes in cinder

Relevant generated files also updated Closes-Bug: #1422601 Closes-Bug: #1417207 Closes-Bug: #1423029 Change-Id: Id458ebdc318744d34607e8567f4d1082e3c1efed
openstack · Feb 18, 2015 · 1904aaa · 1904aaa
1 parent 547a7ff
commit 1904aaa
Show file tree

Hide file tree

Showing 18 changed files with 191 additions and 28 deletions.
diff --git a/doc/common/tables/cinder-auth_token.xml b/doc/common/tables/cinder-auth_token.xml
@@ -41,6 +41,10 @@
         <td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
         <td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
       </tr>
+      <tr>
+        <td><option>auth_plugin</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Name of the plugin to load</td>
+      </tr>
       <tr>
         <td><option>auth_port</option> = <replaceable>35357</replaceable></td>
         <td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
@@ -49,6 +53,10 @@
         <td><option>auth_protocol</option> = <replaceable>https</replaceable></td>
         <td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
       </tr>
+      <tr>
+        <td><option>auth_section</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Config Section from which to load plugin specific options</td>
+      </tr>
       <tr>
         <td><option>auth_uri</option> = <replaceable>None</replaceable></td>
         <td>(StrOpt) Complete public Identity API endpoint.</td>
@@ -109,6 +117,26 @@
         <td><option>keyfile</option> = <replaceable>None</replaceable></td>
         <td>(StrOpt) Required if identity server requires client certificate</td>
       </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>
+      </tr>
+      <tr>
+        <td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
+        <td>(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.</td>
+      </tr>
+      <tr>
+        <td><option>memcache_pool_maxsize</option> = <replaceable>10</replaceable></td>
+        <td>(IntOpt) (Optional) Maximum total number of open connections to every memcached server.</td>
+      </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>
+      </tr>
+      <tr>
+        <td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
+        <td>(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.</td>
+      </tr>
       <tr>
         <td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
         <td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
@@ -117,6 +145,10 @@
         <td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
         <td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT.  If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
       </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>
+      </tr>
       <tr>
         <td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
         <td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>

diff --git a/doc/common/tables/cinder-common.xml b/doc/common/tables/cinder-common.xml
@@ -17,6 +17,18 @@
       <tr>
         <th colspan="2">[DEFAULT]</th>
       </tr>
+      <tr>
+        <td><option>chap_password</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) CHAP password to use for iSCSI Targets</td>
+      </tr>
+      <tr>
+        <td><option>chap_username</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) CHAP username to use for iSCSI Targets</td>
+      </tr>
+      <tr>
+        <td><option>chiscsi_conf</option> = <replaceable>/etc/chelsio-iscsi/chiscsi.conf</replaceable></td>
+        <td>(StrOpt) Chiscsi (CXT) global defaults configuration file</td>
+      </tr>
       <tr>
         <td><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
         <td>(IntOpt) Timeout for client connections' socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
@@ -41,6 +53,10 @@
         <td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
         <td>(BoolOpt) Services to be added to the available pool on create</td>
       </tr>
+      <tr>
+        <td><option>enforce_multipath_for_image_xfer</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) If this is set to True, attachment of volumes for image transfer will be aborted when multipathd is not running. Otherwise, it will fallback to single path.</td>
+      </tr>
       <tr>
         <td><option>host</option> = <replaceable>localhost</replaceable></td>
         <td>(StrOpt) Name of this node.  This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.</td>
@@ -49,10 +65,18 @@
         <td><option>iet_conf</option> = <replaceable>/etc/iet/ietd.conf</replaceable></td>
         <td>(StrOpt) IET configuration file</td>
       </tr>
+      <tr>
+        <td><option>iscsi_secondary_ip_addresses</option> = <replaceable></replaceable></td>
+        <td>(ListOpt) The list of secondary IP addresses of the iSCSI daemon</td>
+      </tr>
       <tr>
         <td><option>lio_initiator_iqns</option> = <replaceable></replaceable></td>
         <td>(StrOpt) This option is deprecated and unused. It will be removed in the next release.</td>
       </tr>
+      <tr>
+        <td><option>max_over_subscription_ratio</option> = <replaceable>2.0</replaceable></td>
+        <td>(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 2.0, meaning provisioned capacity can be twice of the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times of the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 will be ignored and the default value will be used instead.</td>
+      </tr>
       <tr>
         <td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
         <td>(ListOpt) Memcached servers or None for in process cache.</td>
@@ -71,7 +95,7 @@
       </tr>
       <tr>
         <td><option>no_snapshot_gb_quota</option> = <replaceable>False</replaceable></td>
-        <td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
+        <td>(BoolOpt) Whether snapshots count against gigabyte quota</td>
       </tr>
       <tr>
         <td><option>num_shell_tries</option> = <replaceable>3</replaceable></td>

diff --git a/doc/common/tables/cinder-database.xml b/doc/common/tables/cinder-database.xml
@@ -17,10 +17,6 @@
       <tr>
         <th colspan="2">[DEFAULT]</th>
       </tr>
-      <tr>
-        <td><option>db_backend</option> = <replaceable>sqlalchemy</replaceable></td>
-        <td>(StrOpt) The backend to use for db</td>
-      </tr>
       <tr>
         <td><option>db_driver</option> = <replaceable>cinder.db</replaceable></td>
         <td>(StrOpt) Driver to use for database access</td>

diff --git a/doc/common/tables/cinder-emc.xml b/doc/common/tables/cinder-emc.xml
@@ -18,13 +18,21 @@
         <th colspan="2">[DEFAULT]</th>
       </tr>
       <tr>
-        <td><option>cinder_emc_config_file</option> = <replaceable>/etc/cinder/cinder_emc_config.xml</replaceable></td>
-        <td>(StrOpt) use this file for cinder emc plugin config data</td>
+        <td><option>check_max_pool_luns_threshold</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.</td>
       </tr>
       <tr>
         <td><option>destroy_empty_storage_group</option> = <replaceable>False</replaceable></td>
         <td>(BoolOpt) To destroy storage group when the last LUN is removed from it. By default, the value is False.</td>
       </tr>
+      <tr>
+        <td><option>force_delete_lun_in_storagegroup</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) Delete a LUN even if it is in Storage Groups.</td>
+      </tr>
+      <tr>
+        <td><option>initiator_auto_deregistration</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.</td>
+      </tr>
       <tr>
         <td><option>initiator_auto_registration</option> = <replaceable>False</replaceable></td>
         <td>(BoolOpt) Automatically register initiators. By default, the value is False.</td>

diff --git a/doc/common/tables/cinder-eqlx.xml b/doc/common/tables/cinder-eqlx.xml
@@ -19,31 +19,31 @@
       </tr>
       <tr>
         <td><option>eqlx_chap_login</option> = <replaceable>admin</replaceable></td>
-        <td>(StrOpt) Existing CHAP account name</td>
+        <td>(StrOpt) Existing CHAP account name. Defaults to "admin".</td>
       </tr>
       <tr>
         <td><option>eqlx_chap_password</option> = <replaceable>password</replaceable></td>
-        <td>(StrOpt) Password for specified CHAP account name</td>
+        <td>(StrOpt) Password for specified CHAP account name. Defaults to "password".</td>
       </tr>
       <tr>
         <td><option>eqlx_cli_max_retries</option> = <replaceable>5</replaceable></td>
-        <td>(IntOpt) Maximum retry count for reconnection</td>
+        <td>(IntOpt) Maximum retry count for reconnection. Default is 5.</td>
       </tr>
       <tr>
         <td><option>eqlx_cli_timeout</option> = <replaceable>30</replaceable></td>
-        <td>(IntOpt) Timeout for the Group Manager cli command execution</td>
+        <td>(IntOpt) Timeout for the Group Manager cli command execution. Default is 30.</td>
       </tr>
       <tr>
         <td><option>eqlx_group_name</option> = <replaceable>group-0</replaceable></td>
-        <td>(StrOpt) Group name to use for creating volumes</td>
+        <td>(StrOpt) Group name to use for creating volumes. Defaults to "group-0".</td>
       </tr>
       <tr>
         <td><option>eqlx_pool</option> = <replaceable>default</replaceable></td>
-        <td>(StrOpt) Pool in which volumes will be created</td>
+        <td>(StrOpt) Pool in which volumes will be created. Defaults to "default".</td>
       </tr>
       <tr>
         <td><option>eqlx_use_chap</option> = <replaceable>False</replaceable></td>
-        <td>(BoolOpt) Use CHAP authentication for targets?</td>
+        <td>(BoolOpt) Use CHAP authentication for targets. Defaults to "False".</td>
       </tr>
     </tbody>
   </table>

diff --git a/doc/common/tables/cinder-huawei.xml b/doc/common/tables/cinder-huawei.xml
@@ -21,10 +21,6 @@
         <td><option>cinder_huawei_conf_file</option> = <replaceable>/etc/cinder/cinder_huawei_conf.xml</replaceable></td>
         <td>(StrOpt) The configuration file for the Cinder Huawei driver</td>
       </tr>
-      <tr>
-        <td><option>cinder_huawei_sds_conf_file</option> = <replaceable>/etc/cinder/cinder_huawei_storac_conf.xml</replaceable></td>
-        <td>(StrOpt) huawei storagehyper driver config file path</td>
-      </tr>
     </tbody>
   </table>
 </para>
diff --git a/doc/common/tables/cinder-lvm.xml b/doc/common/tables/cinder-lvm.xml
@@ -17,6 +17,10 @@
       <tr>
         <th colspan="2">[DEFAULT]</th>
       </tr>
+      <tr>
+        <td><option>lvm_conf_file</option> = <replaceable>/etc/cinder/lvm.conf</replaceable></td>
+        <td>(StrOpt) LVM conf file to use for the LVM driver in Cinder; this setting is ignored if the specified file does not exist (You can also specify 'None' to not use a conf file even if one exists).</td>
+      </tr>
       <tr>
         <td><option>lvm_mirrors</option> = <replaceable>0</replaceable></td>
         <td>(IntOpt) If &gt;0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space</td>

diff --git a/doc/common/tables/cinder-nas.xml b/doc/common/tables/cinder-nas.xml
@@ -25,6 +25,10 @@
         <td><option>nas_login</option> = <replaceable>admin</replaceable></td>
         <td>(StrOpt) User name to connect to NAS system.</td>
       </tr>
+      <tr>
+        <td><option>nas_mount_options</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Options used to mount the storage backend file system where Cinder volumes are stored.</td>
+      </tr>
       <tr>
         <td><option>nas_password</option> = <replaceable></replaceable></td>
         <td>(StrOpt) Password to connect to NAS system.</td>
@@ -41,6 +45,10 @@
         <td><option>nas_secure_file_permissions</option> = <replaceable>auto</replaceable></td>
         <td>(StrOpt) Set more secure file permissions on network-attached storage volume files to restrict broad other/world access. If set to False, volumes are created with open permissions. If set to True, volumes are created with permissions for the cinder user and group (660). If set to auto, a check is done to determine if this is a new installation: True is used if so, otherwise False. Default is auto.</td>
       </tr>
+      <tr>
+        <td><option>nas_share_path</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Path to the share to use for storing Cinder volumes. For example:  "/srv/export1" for an NFS server export available at 10.0.5.10:/srv/export1 .</td>
+      </tr>
       <tr>
         <td><option>nas_ssh_port</option> = <replaceable>22</replaceable></td>
         <td>(IntOpt) SSH port to use to connect to NAS system.</td>

diff --git a/doc/common/tables/cinder-openvstorage.xml b/doc/common/tables/cinder-openvstorage.xml
@@ -0,0 +1,26 @@
+<?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_openvstorage">
+    <caption>Description of openvstorage 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>vpool_name</option> = <replaceable></replaceable></td>
+        <td>(StrOpt) Vpool to use for volumes - backend is defined by vpool not by us.</td>
+      </tr>
+    </tbody>
+  </table>
+</para>
diff --git a/doc/common/tables/cinder-rabbitmq.xml b/doc/common/tables/cinder-rabbitmq.xml
@@ -35,7 +35,7 @@
       </tr>
       <tr>
         <td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
-        <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
+        <td>(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
       </tr>
       <tr>
         <td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>

diff --git a/doc/common/tables/cinder-rootwrap.xml b/doc/common/tables/cinder-rootwrap.xml
@@ -22,7 +22,7 @@
         <td>List of directories to load filter definitions from (separated by ','). These directories MUST all be only writeable by root !</td>
       </tr>
       <tr>
-        <td><option>exec_dirs</option> = <replaceable>/sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin</replaceable></td>
+        <td><option>exec_dirs</option> = <replaceable>/sbin,/usr/sbin,/bin,/usr/bin,/usr/local/bin,/usr/local/sbin</replaceable></td>
         <td>List of directories to search executables in, in case filters do not explicitely specify a full path (separated by ',') If not specified, defaults to system PATH environment variable. These directories MUST all be only writeable by root !</td>
       </tr>
       <tr>

diff --git a/doc/common/tables/cinder-rpc.xml b/doc/common/tables/cinder-rpc.xml
@@ -43,12 +43,23 @@
       </tr>
       <tr>
         <td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
-        <td>(IntOpt) Size of RPC greenthread pool.</td>
+        <td>(IntOpt) Size of RPC thread pool.</td>
       </tr>
       <tr>
         <td><option>volume_topic</option> = <replaceable>cinder-volume</replaceable></td>
         <td>(StrOpt) The topic that volume nodes listen on</td>
       </tr>
+      <tr>
+        <th colspan="2">[oslo_concurrency]</th>
+      </tr>
+      <tr>
+        <td><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) Enables or disables inter-process locks.</td>
+      </tr>
+      <tr>
+        <td><option>lock_path</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Directory to use for lock files.  For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
+      </tr>
       <tr>
         <th colspan="2">[oslo_messaging_amqp]</th>
       </tr>

diff --git a/doc/common/tables/cinder-scst.xml b/doc/common/tables/cinder-scst.xml
@@ -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_scst">
+    <caption>Description of scst 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>scst_target_driver</option> = <replaceable>iscsi</replaceable></td>
+        <td>(StrOpt) SCST target implementation can choose from multiple SCST target drivers.</td>
+      </tr>
+      <tr>
+        <td><option>scst_target_iqn_name</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Certain ISCSI targets have predefined target names, SCST target driver uses this name.</td>
+      </tr>
+    </tbody>
+  </table>
+</para>
diff --git a/doc/common/tables/cinder-srb.xml b/doc/common/tables/cinder-srb.xml
@@ -19,7 +19,7 @@
       </tr>
       <tr>
         <td><option>srb_base_urls</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) Comma-separated list of REST servers to connect to</td>
+        <td>(StrOpt) Comma-separated list of REST servers IP to connect to. (eg http://IP1/,http://IP2:81/path</td>
       </tr>
     </tbody>
   </table>

diff --git a/doc/common/tables/cinder-storage.xml b/doc/common/tables/cinder-storage.xml
@@ -31,7 +31,7 @@
       </tr>
       <tr>
         <td><option>iscsi_helper</option> = <replaceable>tgtadm</replaceable></td>
-        <td>(StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, iseradm for the ISER protocol, or fake for testing.</td>
+        <td>(StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, iseradm for the ISER protocol, iscsictl for Chelsio iSCSI Target or fake for testing.</td>
       </tr>
       <tr>
         <td><option>iscsi_iotype</option> = <replaceable>fileio</replaceable></td>
@@ -49,6 +49,10 @@
         <td><option>iscsi_port</option> = <replaceable>3260</replaceable></td>
         <td>(IntOpt) The port that the iSCSI daemon is listening on</td>
       </tr>
+      <tr>
+        <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_prefix</option> = <replaceable>iqn.2010-10.org.openstack:</replaceable></td>
         <td>(StrOpt) Prefix for iSCSI volumes</td>