openstack/openstack-manuals
Code Issues Proposed changes

update nova flags and tables

Browse Source 
Removed docker references (the driver has been removed from nova).

Update confilcting pages including tables to use xrefs instead.

Add a rpc_all section to handle conflicts in the training-guides.

Closes-Bug: #1291138
Closes-Bug: #1292612
Change-Id: I67ad31c3913cae4c2e9e3d2ce41302717af5d839
This commit is contained in:
Gauvain Pocentek 2014-03-11 19:00:22 +01:00
parent 1d5442ceb8
commit 590bb27b37
76 changed files with 498 additions and 304 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/common/section_compute-configure-ec2.xml
View File

@ -11,7 +11,7 @@
configuration file to control which network address and port the
EC2 API listens on, the formatting of some API responses, and
authentication related options.</para>
<para>To customize these options for OpenStack EC2 API, use these
configuration option settings:</para>
<xi:include href="../common/tables/nova-ec2.xml"/>
<para>To customize these options for OpenStack EC2 API, use the configuration
option settings documented in <xref
linkend="config_table_nova_ec2"/>.</para>
</section>

5
doc/common/section_compute-configure-spice.xml
View File

@ -19,7 +19,6 @@
<para>VNC must be explicitly disabled to get access to the SPICE console.
Set the <option>vnc_enabled</option> option to <literal>False</literal> in
the <literal>[DEFAULT]</literal> section to disable the VNC console.</para>
<para>The following table shows the options to configure SPICE as
the console for OpenStack Compute:</para>
<xi:include href="../common/tables/nova-spice.xml"/>
<para><xref linkend="config_table_nova_spice"/> documents the options to
configure SPICE as the console for OpenStack Compute.</para>
</section>

3
doc/common/section_compute-configure-vnc.xml
View File

@ -118,7 +118,8 @@
</section>
<section xml:id="vnc-configuration-options">
<title>VNC configuration options</title>
<xi:include href="../common/tables/nova-vnc.xml"/>
<para>To customize the VNC console, use the configuration option settings
documented in <xref linkend="config_table_nova_vnc"/>.</para>
<note>
<para>To support <link
xlink:href="http://docs.openstack.org/trunk/config-reference/content/configuring-openstack-compute-basics.html#section_configuring-compute-migrations"

4
doc/common/section_compute_config-api.xml
View File

@ -179,7 +179,7 @@ limits =(POST, "*", .*, 10, MINUTE);(POST, "*/servers", ^/servers, 50, DAY);(PUT
</simplesect>
<simplesect xml:id="compute_config_options">
<title>Configuration reference</title>
<para>The following table lists the Compute API configuration options:</para>
<xi:include href="tables/nova-api.xml"/>
<para>The Compute API configuration options are documented in <xref
linkend="config_table_nova_api"/>.</para>
</simplesect>
</section>

4
doc/common/section_trusted-compute-pools.xml
View File

@ -138,7 +138,9 @@ auth_blob=i-am-openstack</programlisting>
</procedure>
<section xml:id="config_ref">
<title>Configuration reference</title>
<xi:include href="tables/nova-trustedcomputing.xml"/>
<para>To customize the trusted compute pools, use the configuration
option settings documented in <xref
linkend="config_table_nova_trustedcomputing"/>.</para>
</section>
</section>
<section xml:id="trusted_flavors">

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_api">
<caption>Description of configuration options for api</caption>
<col width="50%"/>
<col width="50%"/>
@ -90,13 +90,6 @@
<td>use_forwarded_for = False</td>
<td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
</tbody>
</table>
</para>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_apiv3">
<caption>Description of configuration options for apiv3</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_authentication">
<caption>Description of configuration options for authentication</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_availabilityzones">
<caption>Description of configuration options for availabilityzones</caption>
<col width="50%"/>
<col width="50%"/>

6
doc/common/tables/nova-baremetal.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_baremetal">
<caption>Description of configuration options for baremetal</caption>
<col width="50%"/>
<col width="50%"/>
@ -56,7 +56,7 @@
</tr>
<tr>
<td>pxe_bootfile_name = pxelinux.0</td>
<td>(StrOpt) This gets passed to Neutron as the bootfile dhcp parameter when the dhcp_options_enabled is set.</td>
<td>(StrOpt) This gets passed to Neutron as the bootfile dhcp parameter.</td>
</tr>
<tr>
<td>pxe_config_template = $pybasedir/nova/virt/baremetal/pxe_config.template</td>
@ -71,7 +71,7 @@
<td>(BoolOpt) If set, pass the network configuration details to the initramfs via cmdline.</td>
</tr>
<tr>
<td>sql_connection = sqlite:///$state_path/baremetal_$sqlite_db</td>
<td>sql_connection = sqlite:///$state_path/baremetal_nova.sqlite</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the bare-metal database</td>
</tr>
<tr>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_ca">
<caption>Description of configuration options for ca</caption>
<col width="50%"/>
<col width="50%"/>
@ -63,15 +63,15 @@
</tr>
<tr>
<td>ca_file = None</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients.</td>
</tr>
<tr>
<td>cert_file = None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
<td>(StrOpt) Certificate file to use when starting the server securely.</td>
</tr>
<tr>
<td>key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
<td>(StrOpt) Private key file to use when starting the server securely.</td>
</tr>
</tbody>
</table>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_cells">
<caption>Description of configuration options for cells</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_common">
<caption>Description of configuration options for common</caption>
<col width="50%"/>
<col width="50%"/>
@ -56,11 +56,11 @@
</tr>
<tr>
<td>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
</tr>
<tr>
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>notify_api_faults = False</td>
@ -91,7 +91,7 @@
<td>(IntOpt) Maximum time since last check-in for up service</td>
</tr>
<tr>
<td>state_path = /var/lib/nova</td>
<td>state_path = $pybasedir</td>
<td>(StrOpt) Top-level directory for maintaining nova's state</td>
</tr>
<tr>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_compute">
<caption>Description of configuration options for compute</caption>
<col width="50%"/>
<col width="50%"/>
@ -74,6 +74,10 @@
<td>image_cache_subdirectory_name = _base</td>
<td>(StrOpt) Where cached images are stored under $instances_path. This is NOT the full path - just a folder name. For per-compute-host cached images, set to _base_$my_ip</td>
</tr>
<tr>
<td>image_handlers = download</td>
<td>(ListOpt) Specifies which image handler extension names to use for handling images. The first extension in the list which can handle the image with a suitable location will be used.</td>
</tr>
<tr>
<td>instance_build_timeout = 0</td>
<td>(IntOpt) Amount of time in seconds an instance can be in BUILD before going into ERROR status.Set to 0 to disable.</td>
@ -138,6 +142,14 @@
<td>sync_power_state_interval = 600</td>
<td>(IntOpt) Interval to sync power states between the database and the hypervisor</td>
</tr>
<tr>
<td>vif_plugging_is_fatal = True</td>
<td>(BoolOpt) Fail instance boot if vif plugging fails</td>
</tr>
<tr>
<td>vif_plugging_timeout = 300</td>
<td>(IntOpt) Number of seconds to wait for neutron vif plugging events to arrive before continuing or failing (see vif_plugging_is_fatal). If this is set to zero and vif_plugging_is_fatal is False, events should not be expected to arrive at all.</td>
</tr>
</tbody>
</table>
</para>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_conductor">
<caption>Description of configuration options for conductor</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_configdrive">
<caption>Description of configuration options for configdrive</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_console">
<caption>Description of configuration options for console</caption>
<col width="50%"/>
<col width="50%"/>

46
doc/common/tables/nova-db.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_db">
<caption>Description of configuration options for db</caption>
<col width="50%"/>
<col width="50%"/>
@ -22,14 +22,6 @@
<td>db_driver = nova.db</td>
<td>(StrOpt) The driver to use for database access</td>
</tr>
<tr>
<td>sqlite_db = nova.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<th colspan="2">[cells]</th>
</tr>
@ -45,7 +37,7 @@
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = sqlite:////usr/lib/python/site-packages/nova/openstack/common/db/$sqlite_db</td>
<td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr>
<tr>
@ -56,6 +48,22 @@
<td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
@ -76,6 +84,10 @@
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>mysql_sql_mode = None</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions (default is empty, meaning do not override any server-side SQL mode setting)</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
@ -85,9 +97,21 @@
<td>(IntOpt) Interval between retries of opening a sql connection</td>
</tr>
<tr>
<td>slave_connection = </td>
<td>slave_connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
</tr>
<tr>
<td>sqlite_db = nova.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr>
</tbody>
</table>
</para>

27
doc/common/tables/nova-docker.xml
View File

@ -1,27 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for docker</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">[docker]</th>
</tr>
<tr>
<td>registry_default_port = 5042</td>
<td>(IntOpt) Default TCP port to find the docker-registry container</td>
</tr>
</tbody>
</table>
</para>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_ec2">
<caption>Description of configuration options for ec2</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_fping">
<caption>Description of configuration options for fping</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_glance">
<caption>Description of configuration options for glance</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_hyperv">
<caption>Description of configuration options for hyperv</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_hypervisor">
<caption>Description of configuration options for hypervisor</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_ipv6">
<caption>Description of configuration options for ipv6</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_keymgr">
<caption>Description of configuration options for keymgr</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_kombu">
<caption>Description of configuration options for kombu</caption>
<col width="50%"/>
<col width="50%"/>
@ -18,21 +18,25 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
</tbody>
</table>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_ldap">
<caption>Description of configuration options for ldap</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_libvirt">
<caption>Description of configuration options for libvirt</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_livemigration">
<caption>Description of configuration options for livemigration</caption>
<col width="50%"/>
<col width="50%"/>

10
doc/common/tables/nova-logging.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_logging">
<caption>Description of configuration options for logging</caption>
<col width="50%"/>
<col width="50%"/>
@ -86,6 +86,10 @@
<td>syslog-log-facility = LOG_USER</td>
<td>(StrOpt) syslog facility to receive log lines</td>
</tr>
<tr>
<td>use_stderr = True</td>
<td>(BoolOpt) Log output to standard error</td>
</tr>
<tr>
<td>use-syslog = False</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
@ -94,10 +98,6 @@
<td>use-syslog-rfc-format = False</td>
<td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
</tr>
<tr>
<td>use_stderr = True</td>
<td>(BoolOpt) Log output to standard error</td>
</tr>
<tr>
<td>verbose = False</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_metadata">
<caption>Description of configuration options for metadata</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_network">
<caption>Description of configuration options for network</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_neutron">
<caption>Description of configuration options for neutron</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_pci">
<caption>Description of configuration options for pci</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_periodic">
<caption>Description of configuration options for periodic</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_policy">
<caption>Description of configuration options for policy</caption>
<col width="50%"/>
<col width="50%"/>

20
doc/common/tables/nova-qpid.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_qpid">
<caption>Description of configuration options for qpid</caption>
<col width="50%"/>
<col width="50%"/>
@ -20,35 +20,35 @@
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = oslo</td>
<td>(StrOpt) Qpid broker hostname</td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
<td>(ListOpt) Qpid HA cluster host:port pairs</td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection</td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
@ -56,7 +56,7 @@
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection</td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
</tbody>
</table>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_quota">
<caption>Description of configuration options for quota</caption>
<col width="50%"/>
<col width="50%"/>

26
doc/common/tables/nova-rabbitmq.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_rabbitmq">
<caption>Description of configuration options for rabbitmq</caption>
<col width="50%"/>
<col width="50%"/>
@ -24,43 +24,47 @@
</tr>
<tr>
<td>rabbit_host = oslo</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_login_method = AMQPLAIN</td>
<td>(StrOpt) the RabbitMQ login method</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count)</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) The RabbitMQ password</td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ</td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ</td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
</tbody>
</table>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_rdp">
<caption>Description of configuration options for rdp</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_redis">
<caption>Description of configuration options for redis</caption>
<col width="50%"/>
<col width="50%"/>
@ -20,7 +20,7 @@
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<th colspan="2">[remote_debug]</th>

12
doc/common/tables/nova-rpc.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_rpc">
<caption>Description of configuration options for rpc</caption>
<col width="50%"/>
<col width="50%"/>
@ -32,7 +32,7 @@
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency</td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
@ -48,15 +48,15 @@
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call</td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool</td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
<tr>
<th colspan="2">[cells]</th>
@ -70,7 +70,7 @@
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
<tr>
<th colspan="2">[upgrade_levels]</th>

220
doc/common/tables/nova-rpc_all.xml Normal file
View File

@ -0,0 +1,220 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all" xml:id="config_table_nova_rpc_all">
<caption>Description of configuration options for rpc_all</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>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = oslo</td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = oslo</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_login_method = AMQPLAIN</td>
<td>(StrOpt) the RabbitMQ login method</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool.</td>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog = None</td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
<tr>
<th colspan="2">[cells]</th>
</tr>
<tr>
<td>rpc_driver_queue_base = cells.intercell</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">[matchmaker_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
<tr>
<th colspan="2">[upgrade_levels]</th>
</tr>
<tr>
<td>baseapi = None</td>
<td>(StrOpt) Set a version cap for messages sent to the base api in any service</td>
</tr>
</tbody>
</table>
</para>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_s3">
<caption>Description of configuration options for s3</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_scheduling">
<caption>Description of configuration options for scheduling</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_spice">
<caption>Description of configuration options for spice</caption>
<col width="50%"/>
<col width="50%"/>

6
doc/common/tables/nova-testing.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_testing">
<caption>Description of configuration options for testing</caption>
<col width="50%"/>
<col width="50%"/>
@ -20,7 +20,7 @@
</tr>
<tr>
<td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>backdoor_port = None</td>
@ -36,7 +36,7 @@
</tr>
<tr>
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider.</td>
</tr>
<tr>
<td>monkey_patch = False</td>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_tilera">
<caption>Description of configuration options for tilera</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_trustedcomputing">
<caption>Description of configuration options for trustedcomputing</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_upgrade_levels">
<caption>Description of configuration options for upgrade_levels</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_vmware">
<caption>Description of configuration options for vmware</caption>
<col width="50%"/>
<col width="50%"/>
@ -32,7 +32,7 @@
</tr>
<tr>
<td>host_ip = None</td>
<td>(StrOpt) URL for connection to VMware ESX/VC host.</td>
<td>(StrOpt) Hostname or IP address for connection to VMware ESX/VC host.</td>
</tr>
<tr>
<td>host_password = None</td>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_vnc">
<caption>Description of configuration options for vnc</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_volumes">
<caption>Description of configuration options for volumes</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_vpn">
<caption>Description of configuration options for vpn</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_wsgi">
<caption>Description of configuration options for wsgi</caption>
<col width="50%"/>
<col width="50%"/>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_xen">
<caption>Description of configuration options for xen</caption>
<col width="50%"/>
<col width="50%"/>
@ -122,7 +122,7 @@
</tr>
<tr>
<td>introduce_vdi_retry_wait = 20</td>
<td>(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced </td>
<td>(IntOpt) Number of seconds to wait for an SR to settle if the VDI does not exist when first introduced</td>
</tr>
<tr>
<td>ipxe_boot_menu_url = None</td>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_xvpnvncproxy">
<caption>Description of configuration options for xvpnvncproxy</caption>
<col width="50%"/>
<col width="50%"/>

10
doc/common/tables/nova-zeromq.xml
View File

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_zeromq">
<caption>Description of configuration options for zeromq</caption>
<col width="50%"/>
<col width="50%"/>
@ -24,7 +24,7 @@
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
@ -32,15 +32,15 @@
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets</td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver</td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</td>
<td>(IntOpt) ZeroMQ receiver listening port</td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog = None</td>

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

@ -4,7 +4,7 @@
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<table rules="all" xml:id="config_table_nova_zookeeper">
<caption>Description of configuration options for zookeeper</caption>
<col width="50%"/>
<col width="50%"/>

26
doc/config-reference/ch_computeconfigure.xml
View File

@ -33,9 +33,9 @@
<para>You can use <filename>nova.conf</filename> file to configure
where Compute logs events, the level of logging, and log
formats.</para>
<para>To customize log formats for OpenStack Compute, use these
configuration option settings.</para>
<xi:include href="../common/tables/nova-logging.xml"/>
<para>To customize log formats for OpenStack Compute, use the
configuration option settings documented in
<xref linkend="config_table_nova_logging"/>.</para>
</section>
<section xml:id="configuring-authentication-authorization">
<title>Configure authentication and authorization</title>
@ -43,17 +43,15 @@
OpenStack Compute project, including no authentication. The
preferred system is the OpenStack Identity Service, code-named
Keystone.</para>
<para>To customize authorization settings for Compute, see these
configuration settings in <filename>nova.conf</filename>.</para>
<xi:include href="../common/tables/nova-authentication.xml"/>
<para>To customize certificate authority settings for Compute, see
these configuration settings in
<filename>nova.conf</filename>.</para>
<xi:include href="../common/tables/nova-ca.xml"/>
<para>To customize Compute and the Identity service to use LDAP as
a backend, refer to these configuration settings in
<filename>nova.conf</filename>.</para>
<xi:include href="../common/tables/nova-ldap.xml"/>
<para>To customize authorization settings for Compute, use the
configuration options documented in
<xref linkend="config_table_nova_authentication"/>.</para>
<para>To customize certificate authority settings for Compute, use the
configuration options documented in <xref
linkend="config_table_nova_ca"/>.</para>
<para>To customize Compute and the Identity service to use LDAP as a
backend, refer to the configuration options documented in <xref
linkend="config_table_nova_ldap"/>.</para>
</section>
<section xml:id="configuring-resize">
<?dbhtml stop-chunking?>

7
doc/config-reference/ch_imageservice.xml
View File

@ -14,13 +14,16 @@
(Glance), which is currently the only supported image
service.</para>
<xi:include href="../common/tables/nova-glance.xml"/>
<para>If your installation requires euca2ools to register new
images, you must run the <systemitem class="service">nova-objectstore</systemitem>
service. This service provides an Amazon S3 front-end for Glance,
which is required by euca2ools.</para>
<xi:include href="../common/tables/nova-s3.xml"/>
<para>To customize the Compute Service, use the configuration option
settings documented in <xref linkend="config_table_nova_glance"/> and
<xref linkend="config_table_nova_s3"/>.</para>
<para>You can modify many options in the OpenStack Image Service.
The following tables provide a comprehensive list.</para>
<xi:include href="../common/tables/glance-common.xml"/>

4
doc/config-reference/compute/section_compute-cells.xml
View File

@ -170,7 +170,9 @@ rabbit_virtual_host=cell1_vhost</programlisting></para>
<para>In the child cell, we would run the following, as
root:<screen><prompt>#</prompt> <userinput>nova-manage cell create --name=api --cell_type=parent --username=api1_user --password=api1_passwd --hostname=10.0.0.10 --port=5672 --virtual_host=api_vhost --woffset=1.0 --wscale=1.0
</userinput></screen></para>
<xi:include href="../../common/tables/nova-cells.xml"/>
<para>To customize the Compute cells, use the configuration option
settings documented in <xref
linkend="config_table_nova_cells"/>.</para>
</section>
<section xml:id="cell-weights-filters">
<title>Cell scheduling configuration</title>

3
doc/config-reference/compute/section_compute-conductor.xml
View File

@ -37,6 +37,7 @@
progress and graceful error handling. This will be especially
beneficial for operations that cross multiple compute nodes,
such as migrations or resizes.</para>
<xi:include href="../../common/tables/nova-conductor.xml"/>
<para>To customize the Conductor, use the configuration option settings
documented in <xref linkend="config_table_nova_conductor"/>.</para>
</section>

4
doc/config-reference/compute/section_compute-configure-db.xml
View File

@ -21,7 +21,7 @@
<systemitem class="service">nova-scheduler</systemitem>
service, although all services must be able to update
entries in the database.</para>
<para>In either case, use these settings to configure the connection
<para>In either case, use the configuration option settings documented in
<xref linkend="config_table_nova_db"/> to configure the connection
string for the nova database.</para>
<xi:include href="../../common/tables/nova-db.xml"/>
</section>

4
doc/config-reference/compute/section_compute-configure-service-groups.xml
View File

@ -79,6 +79,8 @@
[zookeeper]
address="192.168.2.1:2181,192.168.2.2:2181,192.168.2.3:2181"</programlisting>
<xi:include href="../../common/tables/nova-zookeeper.xml"/>
<para>To customize the Compute Service groups, use the configuration option
settings documented in <xref
linkend="config_table_nova_zookeeper"/>.</para>
</section>
</section>

3
doc/config-reference/compute/section_compute-configure-xen.xml
View File

@ -73,6 +73,7 @@ by using the Host Aggregates feature.</para></note>
</para></section>
<section xml:id="xen-config-reference-table">
<title>Xen configuration reference</title>
<xi:include href="../../common/tables/nova-xen.xml"/>
<para>To customize the Xen driver, use the configuration option settings
documented in <xref linkend="config_table_nova_xen"/>.</para>
</section>
</section>

13
doc/config-reference/compute/section_compute-hypervisors.xml
View File

@ -77,14 +77,6 @@
hardware through pluggable sub-drivers (for example, PXE for image
deployment, and IPMI for power management).</para>
</listitem>
<listitem>
<para><link
xlink:href="http://www.docker.io/"
>Docker</link>is an open-source engine which automates the deployment of
>applications as highly portable, self-sufficient containers which are
>independent of hardware, language, framework, packaging system and hosting
>provider.</para>
</listitem>
</itemizedlist>
<section xml:id="hypervisor-configuration-basics">
<title>Hypervisor configuration basics</title>
@ -100,9 +92,9 @@
service.</para>
<para>Here are the general <filename>nova.conf</filename>
options that are used to configure the compute node's
hypervisor. Specific options for particular hypervisors
hypervisor: <xref linkend="config_table_nova_hypervisor"/>.</para>
<para>Specific options for particular hypervisors
can be found in following sections.</para>
<xi:include href="../../common/tables/nova-hypervisor.xml"/>
</section>
<xi:include href="section_hypervisor_kvm.xml"/>
<xi:include href="section_hypervisor_qemu.xml"/>
@ -111,5 +103,4 @@
<xi:include href="section_hypervisor_vmware.xml"/>
<xi:include href="section_hypervisor_hyper-v.xml"/>
<xi:include href="section_hypervisor_baremetal.xml"/>
<xi:include href="section_hypervisor_docker.xml"/>
</section>

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

@ -27,7 +27,6 @@
<xi:include href="../../common/tables/nova-hypervisor.xml"/>
<xi:include href="../../common/tables/nova-ipv6.xml"/>
<xi:include href="../../common/tables/nova-keymgr.xml"/>
<xi:include href="../../common/tables/nova-kombu.xml"/>
<xi:include href="../../common/tables/nova-ldap.xml"/>
<xi:include href="../../common/tables/nova-libvirt.xml"/>
<xi:include href="../../common/tables/nova-livemigration.xml"/>
@ -38,12 +37,10 @@
<xi:include href="../../common/tables/nova-pci.xml"/>
<xi:include href="../../common/tables/nova-periodic.xml"/>
<xi:include href="../../common/tables/nova-policy.xml"/>
<xi:include href="../../common/tables/nova-qpid.xml"/>
<xi:include href="../../common/tables/nova-quota.xml"/>
<xi:include href="../../common/tables/nova-rabbitmq.xml"/>
<xi:include href="../../common/tables/nova-rdp.xml"/>
<xi:include href="../../common/tables/nova-redis.xml"/>
<xi:include href="../../common/tables/nova-rpc.xml"/>
<xi:include href="../../common/tables/nova-rpc_all.xml"/>
<xi:include href="../../common/tables/nova-s3.xml"/>
<xi:include href="../../common/tables/nova-scheduling.xml"/>
<xi:include href="../../common/tables/nova-spice.xml"/>
@ -57,7 +54,6 @@
<xi:include href="../../common/tables/nova-wsgi.xml"/>
<xi:include href="../../common/tables/nova-xen.xml"/>
<xi:include href="../../common/tables/nova-xvpnvncproxy.xml"/>
<xi:include href="../../common/tables/nova-zeromq.xml"/>
<xi:include href="../../common/tables/nova-zookeeper.xml"/>
</section>
<xi:include href="section_compute-sample-configuration-files.xml"/>

4
doc/config-reference/compute/section_compute-scheduler.xml
View File

@ -518,6 +518,8 @@ ram_weight_multiplier=1.0</programlisting>
href="../../common/section_cli_nova_host_aggregates.xml"/>
<section xml:id="compute-scheduler-config-ref">
<title>Configuration reference</title>
<xi:include href="../../common/tables/nova-scheduling.xml"/>
<para>To customize the Compute scheduler, use the configuration option
settings documented in <xref
linkend="config_table_nova_scheduling"/>.</para>
</section>
</section>

4
doc/config-reference/compute/section_hypervisor_baremetal.xml
View File

@ -37,5 +37,7 @@ reserved_host_memory_mb=0</programlisting>
the <link
xlink:href="https://wiki.openstack.org/wiki/Baremetal">main wiki page</link> for details and implementation suggestions.
</para>
<xi:include href="../../common/tables/nova-baremetal.xml"/>
<para>To customize the Baremetal driver, use the configuration option
settings documented in <xref
linkend="config_table_nova_baremetal"/>.</para>
</section>

45
doc/config-reference/compute/section_hypervisor_docker.xml
View File

@ -1,45 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<section 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"
xml:id="docker">
<title>Docker driver</title>
<para>The Docker driver is a hypervisor driver for OpenStack Compute, introduced with the Havana
release. Docker is an open-source engine which automates the deployment of applications as
highly portable, self-sufficient containers which are independent of hardware, language,
framework, packaging system, and hosting provider.</para>
<para>Docker extends LXC with a high level API providing a lightweight virtualization solution
that runs processes in isolation. It provides a way to automate software deployment in a
secure and repeatable environment. A standard container in Docker contains a software
component along with all of its dependencies - binaries, libraries, configuration files,
scripts, virtualenvs, jars, gems, and tarballs.</para>
<para>Docker can be run on any x86_64 Linux kernel that supports cgroups and aufs. Docker is a
way of managing LXC containers on a single machine. However used behind OpenStack Compute
makes Docker much more powerful since it is then possible to manage several hosts which will
then manage hundreds of containers. The current Docker project aims for full OpenStack
compatibility. Containers do not aim to be a replacement for VMs; they are just complementary
in the sense that they are better for specific use cases. Compute's support for VMs is
currently advanced thanks to the variety of hypervisors running VMs. However it is not the
case for containers even though libvirt/LXC is a good starting point. Docker aims to go the
second level of integration.</para>
<note><para>
Some OpenStack Compute features are not implemented by
the docker driver. See the <link
xlink:href="http://wiki.openstack.org/HypervisorSupportMatrix">
hypervisor support matrix</link> for details.
</para></note>
<important>
<para>
The Docker driver only supports Linux Bridge networking
at this time.
</para>
</important>
<para>To enable Docker, ensure the following options are set in
<filename>/etc/nova/nova-compute.conf</filename> on all hosts running the
<systemitem class="service">nova-compute</systemitem> service.
<programlisting language="ini">compute_driver=docker.DockerDriver</programlisting></para>
<para>The Image Service also needs to be configured to support the Docker container format, in
<filename>/etc/glance/glance-api.conf</filename>:
<programlisting language="ini">container_formats = ami,ari,aki,bare,ovf,docker</programlisting></para>
<xi:include href="../../common/tables/nova-docker.xml"/>
</section>

4
doc/config-reference/compute/section_hypervisor_hyper-v.xml
View File

@ -348,8 +348,8 @@ compute_driver=nova.virt.hyperv.driver.HyperVDriver
volume_api_class=nova.volume.cinder.API
[database]
connection=mysql://nova:passwd@<replaceable>IP_ADDRESS</replaceable>/nova</programlisting>
<para>The following table contains a reference of all options for hyper-v</para>
<xi:include href="../../common/tables/nova-hyperv.xml"/>
<para><xref linkend="config_table_nova_hyperv"/> contains a reference of all
options for hyper-v.</para>
</section>
<section xml:id="prepare-hyper-v-images">
<title>Prepare images for use with Hyper-V</title>

3
doc/config-reference/compute/section_hypervisor_vmware.xml
View File

@ -689,6 +689,7 @@ wsdl_location=http://127.0.0.1:8080/vmware/SDK/wsdl/vim25/vimService.wsdl</progr
</section>
<section xml:id="VMWare_config">
<title>Configuration reference</title>
<xi:include href="../../common/tables/nova-vmware.xml"/>
<para>To customize the VMware driver, use the configuration option settings
documented in <xref linkend="config_table_nova_vmware"/>.</para>
</section>
</section>

5
doc/config-reference/compute/section_nova-conf.xml
View File

@ -27,9 +27,8 @@ server=10.3.4.2</programlisting>
(<literal>#</literal>) character. For a list of
configuration options, see the tables in this guide.</para>
<para>To learn more about the <filename>nova.conf</filename>
configuration file, review these general purpose configuration
options.</para>
<xi:include href="../../common/tables/nova-common.xml"/>
configuration file, review the general purpose configuration
options documented in <xref linkend="config_table_nova_common"/>.</para>
<simplesect>
<title>Types of configuration options</title>
<para>Each configuration option has an associated data type.

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

@ -6,8 +6,8 @@ allow_resize_to_same_host policy
allow_same_net_traffic network
allowed_direct_url_schemes glance
allowed_rpc_exception_modules testing
amqp_auto_delete rpc
amqp_durable_queues rpc
amqp_auto_delete rpc rpc_all
amqp_durable_queues rpc rpc_all
api_paste_config wsgi
api_rate_limit authentication
auth_strategy authentication
@ -52,7 +52,7 @@ console_xvp_multiplex_port xen
console_xvp_pid xen
consoleauth_manager console
consoleauth_topic common
control_exchange rpc
control_exchange rpc rpc_all
cpu_allocation_ratio scheduling
create_unique_mac_address_attempts network
crl_file ca
@ -128,6 +128,7 @@ host common
image_cache_manager_interval compute
image_cache_subdirectory_name compute
image_decryption_dir s3
image_handlers compute
injected_network_template network
instance_build_timeout compute
instance_delete_interval compute
@ -149,10 +150,11 @@ isolated_images scheduling
key_file ca
keys_path ca
keystone_ec2_url ec2
kombu_ssl_ca_certs kombu
kombu_ssl_certfile kombu
kombu_ssl_keyfile kombu
kombu_ssl_version kombu
kombu_reconnect_delay kombu rpc_all
kombu_ssl_ca_certs kombu rpc_all
kombu_ssl_certfile kombu rpc_all
kombu_ssl_keyfile kombu rpc_all
kombu_ssl_version kombu rpc_all
l3_lib network
ldap_dns_base_dn ldap
ldap_dns_password ldap
@ -171,17 +173,17 @@ lock_path common
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
log_file logging
log_format logging
logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
matchmaker_heartbeat_freq rpc rpc_all
matchmaker_heartbeat_ttl rpc rpc_all
max_age policy
max_header_line api
max_instances_per_host scheduling
@ -260,16 +262,16 @@ project_cert_subject ca
public_interface network
publish_errors logging
pybasedir common
qpid_heartbeat qpid
qpid_hostname qpid
qpid_hosts qpid
qpid_password qpid
qpid_port qpid
qpid_protocol qpid
qpid_sasl_mechanisms qpid
qpid_tcp_nodelay qpid
qpid_topology_version qpid
qpid_username qpid
qpid_heartbeat qpid rpc_all
qpid_hostname qpid rpc_all
qpid_hosts qpid rpc_all
qpid_password qpid rpc_all
qpid_port qpid rpc_all
qpid_protocol qpid rpc_all
qpid_sasl_mechanisms qpid rpc_all
qpid_tcp_nodelay qpid rpc_all
qpid_topology_version qpid rpc_all
qpid_username qpid rpc_all
quota_cores quota
quota_driver quota
quota_fixed_ips quota
@ -283,17 +285,18 @@ quota_metadata_items quota
quota_ram quota
quota_security_group_rules quota
quota_security_groups quota
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
rabbit_max_retries rabbitmq
rabbit_password rabbitmq
rabbit_port rabbitmq
rabbit_retry_backoff rabbitmq
rabbit_retry_interval rabbitmq
rabbit_use_ssl rabbitmq
rabbit_userid rabbitmq
rabbit_virtual_host rabbitmq
rabbit_ha_queues rabbitmq rpc_all
rabbit_host rabbitmq rpc_all
rabbit_hosts rabbitmq rpc_all
rabbit_login_method rabbitmq rpc_all
rabbit_max_retries rabbitmq rpc_all
rabbit_password rabbitmq rpc_all
rabbit_port rabbitmq rpc_all
rabbit_retry_backoff rabbitmq rpc_all
rabbit_retry_interval rabbitmq rpc_all
rabbit_use_ssl rabbitmq rpc_all
rabbit_userid rabbitmq rpc_all
rabbit_virtual_host rabbitmq rpc_all
ram_allocation_ratio scheduling
ram_weight_multiplier scheduling
reboot_timeout compute
@ -312,18 +315,18 @@ restrict_isolated_hosts_to_isolated_images scheduling
resume_guests_state_on_host_boot compute
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
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
rpc_zmq_ipc_dir zeromq
rpc_zmq_matchmaker zeromq
rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
rpc_backend rpc rpc_all
rpc_cast_timeout rpc rpc_all
rpc_conn_pool_size rpc rpc_all
rpc_response_timeout rpc rpc_all
rpc_thread_pool_size rpc rpc_all
rpc_zmq_bind_address zeromq rpc_all
rpc_zmq_contexts zeromq rpc_all
rpc_zmq_host zeromq rpc_all
rpc_zmq_ipc_dir zeromq rpc_all
rpc_zmq_matchmaker zeromq rpc_all
rpc_zmq_port zeromq rpc_all
rpc_zmq_topic_backlog zeromq rpc_all
run_external_periodic_tasks periodic
running_deleted_instance_action compute
running_deleted_instance_poll_interval compute
@ -357,15 +360,13 @@ share_dhcp_address network
shelved_offload_time compute
shelved_poll_interval compute
snapshot_name_template api
sqlite_db db
sqlite_synchronous db
ssl_ca_file wsgi
ssl_cert_file wsgi
ssl_key_file wsgi
state_path common
stub_compute xen
sync_power_state_interval compute
syslog-log-facility logging
syslog_log_facility logging
tcp_keepidle wsgi
teardown_unused_network_gateway network
tempdir common
@ -373,8 +374,6 @@ timeout_nbd hypervisor
transport_url common
until_refresh policy
update_dns_entries network
use-syslog logging
use-syslog-rfc-format logging
use_cow_images hypervisor
use_forwarded_for api
use_ipv6 ipv6
@ -383,11 +382,15 @@ use_neutron_default_nets network
use_project_ca ca
use_single_default_gateway network
use_stderr logging
use_syslog logging
use_syslog_rfc_format logging
user_cert_subject ca
vcpu_pin_set hypervisor
vendordata_driver metadata
vendordata_jsonfile_path metadata
verbose logging
vif_plugging_is_fatal compute
vif_plugging_timeout compute
virt_mkfs hypervisor
vlan_interface network
vlan_start network
@ -461,7 +464,7 @@ cells/name cells
cells/offset_weight_multiplier cells
cells/ram_weight_multiplier scheduling
cells/reserve_percent cells
cells/rpc_driver_queue_base rpc
cells/rpc_driver_queue_base rpc rpc_all
cells/scheduler upgrade_levels
cells/scheduler_filter_classes scheduling
cells/scheduler_retries scheduling
@ -476,16 +479,22 @@ database/backend db
database/connection db
database/connection_debug db
database/connection_trace db
database/db_inc_retry_interval db
database/db_max_retries db
database/db_max_retry_interval db
database/db_retry_interval db
database/idle_timeout db
database/max_overflow db
database/max_pool_size db
database/max_retries db
database/min_pool_size db
database/mysql_sql_mode db
database/pool_timeout db
database/retry_interval db
database/slave_connection db
database/use_tpool api
docker/registry_default_port docker
database/sqlite_db db
database/sqlite_synchronous db
database/use_db_reconnect db
hyperv/config_drive_cdrom configdrive
hyperv/config_drive_inject_password configdrive
hyperv/dynamic_memory_ratio hyperv
@ -554,7 +563,7 @@ libvirt/volume_clear_size libvirt
libvirt/volume_drivers libvirt
libvirt/wait_soft_reboot_seconds libvirt
libvirt/xen_hvmloader_path xen
matchmaker_ring/ringfile rpc
matchmaker_ring/ringfile rpc rpc_all
metrics/required scheduling
metrics/weight_multiplier scheduling
metrics/weight_of_unavailable scheduling
@ -581,7 +590,7 @@ trusted_computing/attestation_auth_timeout trustedcomputing
trusted_computing/attestation_port trustedcomputing
trusted_computing/attestation_server trustedcomputing
trusted_computing/attestation_server_ca_file trustedcomputing
upgrade_levels/baseapi rpc
upgrade_levels/baseapi rpc rpc_all
upgrade_levels/cells upgrade_levels
upgrade_levels/cert upgrade_levels
upgrade_levels/compute upgrade_levels