update nova flags and tables

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
openstack · Mar 23, 2014 · 590bb27 · 590bb27
1 parent 1d5442c
commit 590bb27
Show file tree

Hide file tree

Showing 76 changed files with 498 additions and 304 deletions.
diff --git a/doc/common/section_compute-configure-ec2.xml b/doc/common/section_compute-configure-ec2.xml
@@ -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>
diff --git a/doc/common/section_compute-configure-spice.xml b/doc/common/section_compute-configure-spice.xml
@@ -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>
diff --git a/doc/common/section_compute-configure-vnc.xml b/doc/common/section_compute-configure-vnc.xml
@@ -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"

diff --git a/doc/common/section_compute_config-api.xml b/doc/common/section_compute_config-api.xml
@@ -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>
diff --git a/doc/common/section_trusted-compute-pools.xml b/doc/common/section_trusted-compute-pools.xml
@@ -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">

diff --git a/doc/common/tables/nova-api.xml b/doc/common/tables/nova-api.xml
@@ -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>
diff --git a/doc/common/tables/nova-apiv3.xml b/doc/common/tables/nova-apiv3.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-authentication.xml b/doc/common/tables/nova-authentication.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-availabilityzones.xml b/doc/common/tables/nova-availabilityzones.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-baremetal.xml b/doc/common/tables/nova-baremetal.xml
@@ -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>

diff --git a/doc/common/tables/nova-ca.xml b/doc/common/tables/nova-ca.xml
@@ -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>

diff --git a/doc/common/tables/nova-cells.xml b/doc/common/tables/nova-cells.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-common.xml b/doc/common/tables/nova-common.xml
@@ -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>

diff --git a/doc/common/tables/nova-compute.xml b/doc/common/tables/nova-compute.xml
@@ -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>
diff --git a/doc/common/tables/nova-conductor.xml b/doc/common/tables/nova-conductor.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-configdrive.xml b/doc/common/tables/nova-configdrive.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-console.xml b/doc/common/tables/nova-console.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-db.xml b/doc/common/tables/nova-db.xml
@@ -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>
diff --git a/doc/common/tables/nova-docker.xml b/doc/common/tables/nova-docker.xml
diff --git a/doc/common/tables/nova-ec2.xml b/doc/common/tables/nova-ec2.xml
@@ -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%"/>

diff --git a/doc/common/tables/nova-fping.xml b/doc/common/tables/nova-fping.xml
@@ -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%"/>