openstack/openstack-manuals
Code Issues Proposed changes

[config-ref] Nova option tables update

Browse Source 
Partial-Bug: #1472417
Closes-Bug: #1465841
Partial-Bug: #1461459
Partial-Bug: #1454356
Closes-Bug: #1450002

Change-Id: I1ce5933ce20d2021f4286ca965823483940157fe
This commit is contained in:
Gauvain Pocentek 2015-07-19 17:00:01 +02:00
parent afa9c38f44
commit cdebb041d5
24 changed files with 225 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,7 +27,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>

18
doc/common/tables/nova-api.xml
View File

@ -117,6 +117,24 @@
<td><option>wsgi_log_format</option> = <replaceable>%(client_ip)s "%(request_line)s" status: %(status_code)s len: %(body_length)s time: %(wall_seconds).7f</replaceable></td>
<td>(StrOpt) A python format string that is used as the template to generate log lines. The following values can be formatted into it: client_ip, date_time, request_line, status_code, body_length, wall_seconds.</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_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>

6
doc/common/tables/nova-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>

8
doc/common/tables/nova-cells.xml
View File

@ -27,7 +27,7 @@
</tr>
<tr>
<td><option>cell_type</option> = <replaceable>compute</replaceable></td>
<td>(StrOpt) Type of cell: api or compute</td>
<td>(StrOpt) Type of cell</td>
</tr>
<tr>
<td><option>cells_config</option> = <replaceable>None</replaceable></td>
@ -66,13 +66,9 @@
<td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
</tr>
<tr>
<td><option>mute_weight_multiplier</option> = <replaceable>-10.0</replaceable></td>
<td><option>mute_weight_multiplier</option> = <replaceable>-10000.0</replaceable></td>
<td>(FloatOpt) Multiplier used to weigh mute children. (The value should be negative.)</td>
</tr>
<tr>
<td><option>mute_weight_value</option> = <replaceable>1000.0</replaceable></td>
<td>(FloatOpt) Weight value assigned to mute children. (The value should be positive.)</td>
</tr>
<tr>
<td><option>name</option> = <replaceable>nova</replaceable></td>
<td>(StrOpt) Name of this cell</td>

8
doc/common/tables/nova-common.xml
View File

@ -89,16 +89,20 @@
</tr>
<tr>
<td><option>destroy_after_evacuate</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether to destroy instances on startup when we suspect they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785</td>
<td>(BoolOpt) DEPRECATED: Whether to destroy instances on startup when we suspect they have previously been evacuated. This can result in data loss if undesired. See https://launchpad.net/bugs/1419785</td>
</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>
<td>(BoolOpt) When using libvirt 1.2.2 live snapshots fail intermittently under load. This config option provides a mechanism to enable live snapshot 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>
<tr>
<td><option>handle_virt_lifecycle_events</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Whether or not to handle events raised from the compute driver's 'emit_event' method. These are lifecycle events raised from compute drivers that implement the method. An example of a lifecycle event is an instance starting or stopping. If the instance is going through task state changes due to an API operation, like resize, the events are ignored. However, this is an advanced feature which allows the hypervisor to signal to the compute service that an unexpected state change has occurred in an instance and the instance can be shutdown automatically - which can inherently race in reboot operations or when the compute service or host is rebooted, either planned or due to an unexpected outage. Care should be taken when using this and sync_power_state_interval is negative since then if any instances are out of sync between the hypervisor and the Nova database they will have to be synchronized manually. See https://bugs.launchpad.net/bugs/1444630</td>
</tr>
</tbody>
</table>
</para>

14
doc/common/tables/nova-compute.xml
View File

@ -17,9 +17,13 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>compute_available_monitors</option> = <replaceable>None</replaceable></td>
<td>(MultiStrOpt) Monitor classes available to the compute which may be specified more than once. This option is DEPRECATED and no longer used. Use setuptools entry points to list available monitor plugins.</td>
</tr>
<tr>
<td><option>compute_driver</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, baremetal.BareMetalDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver</td>
<td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, ironic.IronicDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver</td>
</tr>
<tr>
<td><option>compute_manager</option> = <replaceable>nova.compute.manager.ComputeManager</replaceable></td>
@ -27,7 +31,7 @@
</tr>
<tr>
<td><option>compute_monitors</option> = <replaceable></replaceable></td>
<td>(ListOpt) A list of monitors that can be used for getting compute metrics.</td>
<td>(ListOpt) A list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces.</td>
</tr>
<tr>
<td><option>compute_resources</option> = <replaceable>vcpu</replaceable></td>
@ -119,7 +123,7 @@
</tr>
<tr>
<td><option>running_deleted_instance_action</option> = <replaceable>reap</replaceable></td>
<td>(StrOpt) Action to take if a running deleted instance is detected. Valid options are 'noop', 'log', 'shutdown', or 'reap'. Set to 'noop' to take no action.</td>
<td>(StrOpt) Action to take if a running deleted instance is detected.Set to 'noop' to take no action.</td>
</tr>
<tr>
<td><option>running_deleted_instance_poll_interval</option> = <replaceable>1800</replaceable></td>
@ -145,6 +149,10 @@
<td><option>sync_power_state_interval</option> = <replaceable>600</replaceable></td>
<td>(IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate.</td>
</tr>
<tr>
<td><option>update_resources_interval</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds.</td>
</tr>
<tr>
<td><option>vif_plugging_is_fatal</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Fail instance boot if vif plugging fails</td>

2
doc/common/tables/nova-configdrive.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>config_drive_format</option> = <replaceable>iso9660</replaceable></td>
<td>(StrOpt) Config drive format. One of iso9660 (default) or vfat</td>
<td>(StrOpt) Config drive format.</td>
</tr>
<tr>
<td><option>config_drive_skip_versions</option> = <replaceable>1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15 2008-02-01 2008-09-01</replaceable></td>

73
doc/common/tables/nova-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_nova_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>

2
doc/common/tables/nova-ec2.xml
View File

@ -47,7 +47,7 @@
</tr>
<tr>
<td><option>ec2_scheme</option> = <replaceable>http</replaceable></td>
<td>(StrOpt) The protocol to use when connecting to the EC2 API server (http, https)</td>
<td>(StrOpt) The protocol to use when connecting to the EC2 API server</td>
</tr>
<tr>
<td><option>ec2_strict_validation</option> = <replaceable>True</replaceable></td>

2
doc/common/tables/nova-ironic.xml
View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>admin_auth_token</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Ironic keystone auth token.</td>
<td>(StrOpt) Ironic keystone auth token.DEPRECATED: use admin_username, admin_password, and admin_tenant_name instead</td>
</tr>
<tr>
<td><option>admin_password</option> = <replaceable>None</replaceable></td>

18
doc/common/tables/nova-libvirt.xml
View File

@ -66,7 +66,7 @@
</tr>
<tr>
<td><option>hw_disk_discard</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Discard option for nova managed disks (valid options are: ignore, unmap). Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format)</td>
<td>(StrOpt) Discard option for nova managed disks. Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format)</td>
</tr>
<tr>
<td><option>hw_machine_type</option> = <replaceable>None</replaceable></td>
@ -86,7 +86,7 @@
</tr>
<tr>
<td><option>images_type</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) VM Images format. Acceptable values are: raw, qcow2, lvm, rbd, default. If default is specified, then use_cow_images flag is used instead of this one.</td>
<td>(StrOpt) VM Images format. If default is specified, then use_cow_images flag is used instead of this one.</td>
</tr>
<tr>
<td><option>images_volume_group</option> = <replaceable>None</replaceable></td>
@ -106,7 +106,7 @@
</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>
<td>(StrOpt) The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form &lt;transport_name&gt;.&lt;hwaddress&gt; where &lt;transport_name&gt; is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and &lt;hwadress&gt; is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name.</td>
</tr>
<tr>
<td><option>iscsi_use_multipath</option> = <replaceable>False</replaceable></td>
@ -121,8 +121,8 @@
<td>(IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics.</td>
</tr>
<tr>
<td><option>remove_unused_kernels</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option. This will be enabled by default in future.</td>
<td><option>remove_unused_kernels</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) DEPRECATED: Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option (running Grizzly or newer level compute). This will be the default behavior in the 13.0.0 release.</td>
</tr>
<tr>
<td><option>remove_unused_resized_minimum_age_seconds</option> = <replaceable>3600</replaceable></td>
@ -150,7 +150,7 @@
</tr>
<tr>
<td><option>snapshot_image_format</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Snapshot image format (valid options are : raw, qcow2, vmdk, vdi). Defaults to same as source image</td>
<td>(StrOpt) Snapshot image format. Defaults to same as source image</td>
</tr>
<tr>
<td><option>snapshots_directory</option> = <replaceable>$instances_path/snapshots</replaceable></td>
@ -162,7 +162,7 @@
</tr>
<tr>
<td><option>sysinfo_serial</option> = <replaceable>auto</replaceable></td>
<td>(StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. Permitted options are "hardware", "os", "none" or "auto" (default).</td>
<td>(StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS.</td>
</tr>
<tr>
<td><option>uid_maps</option> = <replaceable></replaceable></td>
@ -178,11 +178,11 @@
</tr>
<tr>
<td><option>virt_type</option> = <replaceable>kvm</replaceable></td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen and parallels)</td>
<td>(StrOpt) Libvirt domain type</td>
</tr>
<tr>
<td><option>volume_clear</option> = <replaceable>zero</replaceable></td>
<td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
<td>(StrOpt) Method used to wipe old volumes.</td>
</tr>
<tr>
<td><option>volume_clear_size</option> = <replaceable>0</replaceable></td>

40
doc/common/tables/nova-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>

26
doc/common/tables/nova-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_nova_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/nova-policy.xml
View File

@ -21,10 +21,6 @@
<td><option>allow_instance_snapshots</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Permit instance snapshot operations.</td>
</tr>
<tr>
<td><option>allow_migrate_to_same_host</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow migrate machine to the same host. Useful when testing in single-host environments.</td>
</tr>
<tr>
<td><option>allow_resize_to_same_host</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Allow destination machine to match source for resize. Useful when testing in single-host environments.</td>

4
doc/common/tables/nova-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>

12
doc/common/tables/nova-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/nova-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/nova-upgrade_levels.xml
View File

@ -34,7 +34,7 @@
</tr>
<tr>
<td><option>compute</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from havana to icehouse, you should set this option to "icehouse-compat" before beginning the live upgrade procedure.</td>
<td>(StrOpt) Set a version cap for messages sent to compute services. If you plan to do a live upgrade from an old version to a newer version, you should set this option to the old version before beginning the live upgrade procedure. Only upgrading to the next version is supported, so you cannot skip a release for the live upgrade procedure.</td>
</tr>
<tr>
<td><option>conductor</option> = <replaceable>None</replaceable></td>

22
doc/common/tables/nova-vmware.xml
View File

@ -21,33 +21,45 @@
<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>ca_file</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Specify a CA bundle file to use in verifying the vCenter server certificate.</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>
<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>
</tr>
<tr>
<td><option>console_delay_seconds</option> = <replaceable>None</replaceable></td>
<td>(IntOpt) Set this value if affected by an increased network latency causing repeated characters when typing in a remote console.</td>
</tr>
<tr>
<td><option>datastore_regex</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Regex to match the name of a datastore.</td>
</tr>
<tr>
<td><option>host_ip</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Hostname or IP address for connection to VMware VC host.</td>
<td>(StrOpt) Hostname or IP address for connection to VMware vCenter host.</td>
</tr>
<tr>
<td><option>host_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Password for connection to VMware VC host.</td>
<td>(StrOpt) Password for connection to VMware vCenter host.</td>
</tr>
<tr>
<td><option>host_port</option> = <replaceable>443</replaceable></td>
<td>(IntOpt) Port for connection to VMware VC host.</td>
<td>(IntOpt) Port for connection to VMware vCenter host.</td>
</tr>
<tr>
<td><option>host_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Username for connection to VMware VC host.</td>
<td>(StrOpt) Username for connection to VMware vCenter host.</td>
</tr>
<tr>
<td><option>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 "ca_file" is set.</td>
</tr>
<tr>
<td><option>integration_bridge</option> = <replaceable>br-int</replaceable></td>

47
doc/common/tables/nova-vnc.xml
View File

@ -25,10 +25,6 @@
<td><option>key</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) SSL key file (if separate from cert)</td>
</tr>
<tr>
<td><option>novncproxy_base_url</option> = <replaceable>http://127.0.0.1:6080/vnc_auto.html</replaceable></td>
<td>(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html"</td>
</tr>
<tr>
<td><option>novncproxy_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Host on which to listen for incoming requests</td>
@ -49,22 +45,6 @@
<td><option>ssl_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Disallow non-encrypted connections</td>
</tr>
<tr>
<td><option>vnc_enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable VNC related features</td>
</tr>
<tr>
<td><option>vnc_keymap</option> = <replaceable>en-us</replaceable></td>
<td>(StrOpt) Keymap for VNC</td>
</tr>
<tr>
<td><option>vncserver_listen</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) IP address on which instance vncservers should listen</td>
</tr>
<tr>
<td><option>vncserver_proxyclient_address</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect</td>
</tr>
<tr>
<td><option>web</option> = <replaceable>/usr/share/spice-html5</replaceable></td>
<td>(StrOpt) Run webserver on same port. Serve files from DIR.</td>
@ -80,6 +60,33 @@
<td><option>vnc_port_total</option> = <replaceable>10000</replaceable></td>
<td>(IntOpt) Total number of VNC ports</td>
</tr>
<tr>
<th colspan="2">[vnc]</th>
</tr>
<tr>
<td><option>enabled</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Enable VNC related features</td>
</tr>
<tr>
<td><option>keymap</option> = <replaceable>en-us</replaceable></td>
<td>(StrOpt) Keymap for VNC</td>
</tr>
<tr>
<td><option>novncproxy_base_url</option> = <replaceable>http://127.0.0.1:6080/vnc_auto.html</replaceable></td>
<td>(StrOpt) Location of VNC console proxy, in the form "http://127.0.0.1:6080/vnc_auto.html"</td>
</tr>
<tr>
<td><option>vncserver_listen</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) IP address on which instance vncservers should listen</td>
</tr>
<tr>
<td><option>vncserver_proxyclient_address</option> = <replaceable>127.0.0.1</replaceable></td>
<td>(StrOpt) The address to which proxy clients (like nova-xvpvncproxy) should connect</td>
</tr>
<tr>
<td><option>xvpvncproxy_base_url</option> = <replaceable>http://127.0.0.1:6081/console</replaceable></td>
<td>(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console"</td>
</tr>
</tbody>
</table>
</para>

4
doc/common/tables/nova-xen.xml
View File

@ -181,7 +181,7 @@
</tr>
<tr>
<td><option>torrent_base_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Base URL for torrent files.</td>
<td>(StrOpt) Base URL for torrent files; must contain a slash character (see RFC 1808, step 6)</td>
</tr>
<tr>
<td><option>torrent_download_stall_cutoff</option> = <replaceable>600</replaceable></td>
@ -189,7 +189,7 @@
</tr>
<tr>
<td><option>torrent_images</option> = <replaceable>none</replaceable></td>
<td>(StrOpt) Whether or not to download images via Bit Torrent (all|some|none).</td>
<td>(StrOpt) Whether or not to download images via Bit Torrent.</td>
</tr>
<tr>
<td><option>torrent_listen_port_end</option> = <replaceable>6891</replaceable></td>

8
doc/common/tables/nova-xvpvncproxy.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_nova_xvpnvncproxy">
<caption>Description of XCP VNC proxy configuration options</caption>
<table rules="all" xml:id="config_table_nova_xvpvncproxy">
<caption>Description of xvpvncproxy configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -17,10 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>xvpvncproxy_base_url</option> = <replaceable>http://127.0.0.1:6081/console</replaceable></td>
<td>(StrOpt) Location of nova xvp VNC console proxy, in the form "http://127.0.0.1:6081/console"</td>
</tr>
<tr>
<td><option>xvpvncproxy_host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Address that the XCP VNC proxy should bind to</td>

2
doc/config-reference/compute/section_compute-options-reference.xml
View File

@ -21,6 +21,7 @@
<xi:include href="../../common/tables/nova-conductor.xml"/>
<xi:include href="../../common/tables/nova-configdrive.xml"/>
<xi:include href="../../common/tables/nova-console.xml"/>
<xi:include href="../../common/tables/nova-cors.xml"/>
<xi:include href="../../common/tables/nova-database.xml"/>
<xi:include href="../../common/tables/nova-debug.xml"/>
<xi:include href="../../common/tables/nova-ec2.xml"/>
@ -39,7 +40,6 @@
<xi:include href="../../common/tables/nova-metadata.xml"/>
<xi:include href="../../common/tables/nova-network.xml"/>
<xi:include href="../../common/tables/nova-neutron.xml"/>
<xi:include href="../../common/tables/nova-oslo_middleware.xml"/>
<xi:include href="../../common/tables/nova-pci.xml"/>
<xi:include href="../../common/tables/nova-periodic.xml"/>
<xi:include href="../../common/tables/nova-policy.xml"/>

50
tools/autogenerate-config-flagmappings/nova.flagmappings
View File

@ -1,7 +1,6 @@
aggregate_image_properties_isolation_namespace scheduler
aggregate_image_properties_isolation_separator scheduler
allow_instance_snapshots policy
allow_migrate_to_same_host policy
allow_resize_to_same_host policy
allow_same_net_traffic network
api_paste_config api
@ -23,6 +22,7 @@ cert_manager ca
cert_topic ca
client_socket_timeout api
cnt_vpn_clients network
compute_available_monitors compute
compute_driver compute
compute_manager compute
compute_monitors compute
@ -156,11 +156,6 @@ live_migration_retry_count livemigration
lockout_attempts ec2
lockout_minutes ec2
lockout_window ec2
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
@ -209,7 +204,6 @@ notification_driver amqp
notification_topics amqp
notify_api_faults common
notify_on_state_change common
novncproxy_base_url vnc
novncproxy_host vnc
novncproxy_port vnc
null_kernel api
@ -275,6 +269,7 @@ rootwrap_config common
routing_source_ip network
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
@ -328,7 +323,6 @@ ssl_only vnc
state_path common
stub_compute xen
sync_power_state_interval compute
syslog-log-facility logging
syslog_log_facility logging
tcp_keepidle api
teardown_unused_network_gateway network
@ -337,8 +331,7 @@ timeout_nbd hypervisor
transport_url amqp
until_refresh policy
update_dns_entries network
use-syslog logging
use-syslog-rfc-format logging
update_resources_interval compute
use_cow_images hypervisor
use_forwarded_for api
use_ipv6 ipv6
@ -359,10 +352,6 @@ vif_plugging_timeout compute
virt_mkfs hypervisor
vlan_interface network
vlan_start network
vnc_enabled vnc
vnc_keymap vnc
vncserver_listen vnc
vncserver_proxyclient_address vnc
volume_api_class volumes
volume_usage_poll_interval volumes
vpn_flavor vpn
@ -374,7 +363,6 @@ web vnc
wsgi_default_pool_size api
wsgi_keep_alive api
wsgi_log_format api
xvpvncproxy_base_url xvpvncproxy
xvpvncproxy_host xvpvncproxy
xvpvncproxy_port xvpvncproxy
api_database/connection database
@ -411,7 +399,6 @@ cells/manager cells
cells/max_hop_count cells
cells/mute_child_interval cells
cells/mute_weight_multiplier cells
cells/mute_weight_value cells
cells/name cells
cells/offset_weight_multiplier cells
cells/ram_weight_multiplier scheduler
@ -437,6 +424,18 @@ conductor/manager conductor
conductor/topic conductor
conductor/use_local conductor
conductor/workers conductor
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
@ -651,13 +650,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
@ -674,8 +674,10 @@ 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_versionedobjects/fatal_exception_format_errors api
rdp/enabled rdp
rdp/html5_proxy_base_url rdp
serial_console/base_url serial_console
@ -714,13 +716,16 @@ upgrade_levels/intercell upgrade_levels
upgrade_levels/network upgrade_levels
upgrade_levels/scheduler upgrade_levels
vmware/api_retry_count vmware
vmware/ca_file vmware
vmware/cache_prefix vmware
vmware/cluster_name vmware
vmware/console_delay_seconds vmware
vmware/datastore_regex vmware
vmware/host_ip vmware
vmware/host_password vmware
vmware/host_port vmware
vmware/host_username vmware
vmware/insecure vmware
vmware/integration_bridge vmware
vmware/maximum_objects vmware
vmware/pbm_default_policy vmware
@ -732,9 +737,16 @@ vmware/vlan_interface network
vmware/vnc_port vnc
vmware/vnc_port_total vnc
vmware/wsdl_location vmware
vnc/enabled vnc
vnc/keymap vnc
vnc/novncproxy_base_url vnc
vnc/vncserver_listen vnc
vnc/vncserver_proxyclient_address vnc
vnc/xvpvncproxy_base_url vnc
workarounds/destroy_after_evacuate common
workarounds/disable_libvirt_livesnapshot common
workarounds/disable_rootwrap common
workarounds/handle_virt_lifecycle_events common
xenserver/agent_path xen
xenserver/agent_resetnetwork_timeout xen
xenserver/agent_timeout xen