Add missing flagmappings from recent changes in nova

Closes-Bug: #1423373 Closes-Bug: #1415705 Partial-bug: #1417631 Change-Id: Ifce8c104da158f1da7006a95d51ff82f8de71293
openstack · Feb 19, 2015 · b989115 · b989115
1 parent 46962ea
commit b989115
Show file tree

Hide file tree

Showing 16 changed files with 186 additions and 9 deletions.
diff --git a/doc/common/tables/nova-api.xml b/doc/common/tables/nova-api.xml
@@ -50,7 +50,7 @@
         <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>
       </tr>
       <tr>
-        <td><option>multi_instance_display_name_template</option> = <replaceable>%(name)s-%(uuid)s</replaceable></td>
+        <td><option>multi_instance_display_name_template</option> = <replaceable>%(name)s-%(count)d</replaceable></td>
         <td>(StrOpt) When creating multiple instances with a single request using the os-multiple-create API extension, this template will be used to build the display name for each instance. The benefit is that the instances end up with different hostnames. To restore legacy behavior of every instance having the same name, set this option to "%(name)s".  Valid keys for the template are: name, uuid, count.</td>
       </tr>
       <tr>

diff --git a/doc/common/tables/nova-auth_token.xml b/doc/common/tables/nova-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/nova-barbican.xml b/doc/common/tables/nova-barbican.xml
@@ -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_nova_barbican">
+    <caption>Description of Barbican 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">[barbican]</th>
+      </tr>
+      <tr>
+        <td><option>cafile</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) PEM encoded Certificate Authority to use when verifying HTTPs connections.</td>
+      </tr>
+      <tr>
+        <td><option>catalog_info</option> = <replaceable>key-manager:barbican:public</replaceable></td>
+        <td>(StrOpt) Info to match when looking for barbican in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td>
+      </tr>
+      <tr>
+        <td><option>certfile</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) PEM encoded client certificate cert file</td>
+      </tr>
+      <tr>
+        <td><option>endpoint_template</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Override service catalog lookup with template for barbican endpoint e.g. http://localhost:9311/v1/%(project_id)s</td>
+      </tr>
+      <tr>
+        <td><option>insecure</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) Verify HTTPS connections.</td>
+      </tr>
+      <tr>
+        <td><option>keyfile</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) PEM encoded client certificate key file</td>
+      </tr>
+      <tr>
+        <td><option>os_region_name</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) Region name of this node</td>
+      </tr>
+      <tr>
+        <td><option>timeout</option> = <replaceable>None</replaceable></td>
+        <td>(IntOpt) Timeout value for http requests</td>
+      </tr>
+    </tbody>
+  </table>
+</para>
diff --git a/doc/common/tables/nova-common.xml b/doc/common/tables/nova-common.xml
@@ -84,6 +84,17 @@
         <td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
         <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
       </tr>
+      <tr>
+        <th colspan="2">[workarounds]</th>
+      </tr>
+      <tr>
+        <td><option>disable_libvirt_livesnapshot</option> = <replaceable>True</replaceable></td>
+        <td>(BoolOpt) When using libvirt 1.2.2 fails live snapshots intermittently under load.  This config option provides mechanism to disable livesnapshot while this is resolved.  See https://bugs.launchpad.net/nova/+bug/1334398</td>
+      </tr>
+      <tr>
+        <td><option>disable_rootwrap</option> = <replaceable>False</replaceable></td>
+        <td>(BoolOpt) This option allows a fallback to sudo for performance reasons. For example see https://bugs.launchpad.net/nova/+bug/1415106</td>
+      </tr>
     </tbody>
   </table>
 </para>
diff --git a/doc/common/tables/nova-compute.xml b/doc/common/tables/nova-compute.xml
@@ -93,6 +93,10 @@
         <td><option>instances_path</option> = <replaceable>$state_path/instances</replaceable></td>
         <td>(StrOpt) Where instances are stored on disk</td>
       </tr>
+      <tr>
+        <td><option>max_concurrent_builds</option> = <replaceable>10</replaceable></td>
+        <td>(IntOpt) Maximum number of instance builds to run concurrently</td>
+      </tr>
       <tr>
         <td><option>maximum_instance_delete_attempts</option> = <replaceable>5</replaceable></td>
         <td>(IntOpt) The number of times to attempt to reap an instance's files.</td>

diff --git a/doc/common/tables/nova-ec2.xml b/doc/common/tables/nova-ec2.xml
@@ -34,7 +34,7 @@
         <td>(IntOpt) The port on which the EC2 API will listen.</td>
       </tr>
       <tr>
-        <td><option>ec2_path</option> = <replaceable>/services/Cloud</replaceable></td>
+        <td><option>ec2_path</option> = <replaceable>/</replaceable></td>
         <td>(StrOpt) The path prefix used to call the ec2 API server</td>
       </tr>
       <tr>

diff --git a/doc/common/tables/nova-libvirt.xml b/doc/common/tables/nova-libvirt.xml
@@ -104,6 +104,10 @@
         <td><option>inject_password</option> = <replaceable>False</replaceable></td>
         <td>(BoolOpt) Inject the admin password at boot time, without an agent.</td>
       </tr>
+      <tr>
+        <td><option>iscsi_iface</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired. Supported transports are be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx and ocs. Default format is transport_name.hwaddress and can be generated manually or via iscsiadm -m iface</td>
+      </tr>
       <tr>
         <td><option>iscsi_use_multipath</option> = <replaceable>False</replaceable></td>
         <td>(BoolOpt) Use multipath connection of the iSCSI volume</td>
@@ -174,7 +178,7 @@
       </tr>
       <tr>
         <td><option>virt_type</option> = <replaceable>kvm</replaceable></td>
-        <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td>
+        <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen and parallels)</td>
       </tr>
       <tr>
         <td><option>volume_clear</option> = <replaceable>zero</replaceable></td>
@@ -185,7 +189,7 @@
         <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 =&gt; all</td>
       </tr>
       <tr>
-        <td><option>volume_drivers</option> = <replaceable>iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, smbfs=nova.virt.libvirt.volume.LibvirtSMBFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver, gpfs=nova.virt.libvirt.volume.LibvirtGPFSVolumeDriver</replaceable></td>
+        <td><option>volume_drivers</option> = <replaceable>iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, smbfs=nova.virt.libvirt.volume.LibvirtSMBFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver, gpfs=nova.virt.libvirt.volume.LibvirtGPFSVolumeDriver, quobyte=nova.virt.libvirt.volume.LibvirtQuobyteVolumeDriver</replaceable></td>
         <td>(ListOpt) DEPRECATED. Libvirt handlers for remote volumes. This option is deprecated and will be removed in the Kilo release.</td>
       </tr>
       <tr>

diff --git a/doc/common/tables/nova-quobyte.xml b/doc/common/tables/nova-quobyte.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_nova_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">[libvirt]</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) Directory where the Quobyte volume is mounted on the compute node</td>
+      </tr>
+    </tbody>
+  </table>
+</para>
diff --git a/doc/common/tables/nova-rabbitmq.xml b/doc/common/tables/nova-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/nova-rpc.xml b/doc/common/tables/nova-rpc.xml
@@ -43,7 +43,7 @@
       </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>
         <th colspan="2">[cells]</th>
@@ -52,6 +52,17 @@
         <td><option>rpc_driver_queue_base</option> = <replaceable>cells.intercell</replaceable></td>
         <td>(StrOpt) Base queue name to use when communicating between cells.  Various topics by message type will be appended to this.</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/nova-vmware.xml b/doc/common/tables/nova-vmware.xml
@@ -21,6 +21,10 @@
         <td><option>api_retry_count</option> = <replaceable>10</replaceable></td>
         <td>(IntOpt) The number of times we retry on failures, e.g., socket error, etc.</td>
       </tr>
+      <tr>
+        <td><option>cache_prefix</option> = <replaceable>None</replaceable></td>
+        <td>(StrOpt) The prefix for Where cached images are stored. This is NOT the full path - just a folder prefix. This should only be used when a datastore cache should be shared between compute nodes. Note: this should only be used when the compute nodes have a shared file system.</td>
+      </tr>
       <tr>
         <td><option>cluster_name</option> = <replaceable>None</replaceable></td>
         <td>(MultiStrOpt) Name of a VMware Cluster ComputeResource.</td>

diff --git a/doc/common/tables/nova-volumes.xml b/doc/common/tables/nova-volumes.xml
@@ -104,7 +104,7 @@
       </tr>
       <tr>
         <td><option>nfs_mount_options</option> = <replaceable>None</replaceable></td>
-        <td>(StrOpt) Mount options passedf to the NFS client. See section of the nfs man page for details</td>
+        <td>(StrOpt) Mount options passed to the NFS client. See section of the nfs man page for details</td>
       </tr>
       <tr>
         <td><option>nfs_mount_point_base</option> = <replaceable>$state_path/mnt</replaceable></td>

diff --git a/doc/common/tables/nova-xen.xml b/doc/common/tables/nova-xen.xml
@@ -141,7 +141,7 @@
       </tr>
       <tr>
         <td><option>num_vbd_unplug_retries</option> = <replaceable>10</replaceable></td>
-        <td>(IntOpt) Maximum number of retries to unplug VBD</td>
+        <td>(IntOpt) Maximum number of retries to unplug VBD. if &lt;=0, should try once and no retry</td>
       </tr>
       <tr>
         <td><option>ovs_integration_bridge</option> = <replaceable>xapi1</replaceable></td>

diff --git a/doc/common/tables/nova-zeromq.xml b/doc/common/tables/nova-zeromq.xml
@@ -34,7 +34,7 @@
         <td>(StrOpt) Directory for holding IPC sockets.</td>
       </tr>
       <tr>
-        <td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
+        <td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo_messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
         <td>(StrOpt) MatchMaker driver.</td>
       </tr>
       <tr>