openstack-manuals/doc/common/tables/nova-common.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!--
###################################################################
 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################

     Warning: Do not edit this file. It is automatically
     generated from the software project's code and your changes
     will be overwritten.

     The tool to generate this file lives in openstack-doc-tools
     repository.

     Please make any changes needed in the code, then run the
     autogenerate-config-doc tool from the openstack-doc-tools
     repository, or ask for help on the documentation mailing list,
     IRC channel or meeting.

###################################################################
 WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
  <table rules="all" xml:id="config_table_nova_common">
    <caption>Description of common configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[DEFAULT]</th>
      </tr>
      <tr>
        <td><option>bindir</option> = <replaceable>/usr/local/bin</replaceable></td>
        <td>(StrOpt) Directory where nova binaries are installed</td>
      </tr>
      <tr>
        <td><option>compute_topic</option> = <replaceable>compute</replaceable></td>
        <td>(StrOpt) The topic compute nodes listen on</td>
      </tr>
      <tr>
        <td><option>console_topic</option> = <replaceable>console</replaceable></td>
        <td>(StrOpt) The topic console proxy nodes listen on</td>
      </tr>
      <tr>
        <td><option>consoleauth_topic</option> = <replaceable>consoleauth</replaceable></td>
        <td>(StrOpt) The topic console auth proxy nodes listen on</td>
      </tr>
      <tr>
        <td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
        <td>(IntOpt) Size of executor thread pool.</td>
      </tr>
      <tr>
        <td><option>host</option> = <replaceable>localhost</replaceable></td>
        <td>(StrOpt) Name of this node.  This can be an opaque identifier.  It is not necessarily a hostname, FQDN, or IP address. However, the node name must be valid within an AMQP key, and if using ZeroMQ, a valid hostname, FQDN, or IP address</td>
      </tr>
      <tr>
        <td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
        <td>(ListOpt) Memcached servers or None for in process cache.</td>
      </tr>
      <tr>
        <td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
        <td>(StrOpt) IP address of this host</td>
      </tr>
      <tr>
        <td><option>notify_api_faults</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) If set, send api.fault notifications on caught exceptions in the API service.</td>
      </tr>
      <tr>
        <td><option>notify_on_state_change</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) If set, send compute.instance.update notifications on instance state changes.  Valid values are None for no notifications, "vm_state" for notifications on VM state changes, or "vm_and_task_state" for notifications on VM and task state changes.</td>
      </tr>
      <tr>
        <td><option>pybasedir</option> = <replaceable>/usr/lib/python/site-packages/nova</replaceable></td>
        <td>(StrOpt) Directory where the nova python module is installed</td>
      </tr>
      <tr>
        <td><option>report_interval</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Seconds between nodes reporting state to datastore</td>
      </tr>
      <tr>
        <td><option>rootwrap_config</option> = <replaceable>/etc/nova/rootwrap.conf</replaceable></td>
        <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
      </tr>
      <tr>
        <td><option>service_down_time</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Maximum time since last check-in for up service</td>
      </tr>
      <tr>
        <td><option>state_path</option> = <replaceable>$pybasedir</replaceable></td>
        <td>(StrOpt) Top-level directory for maintaining nova's state</td>
      </tr>
      <tr>
        <td><option>tempdir</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Explicitly specify the temporary working directory</td>
      </tr>
      <tr>
        <td><option>use_rootwrap_daemon</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Start and use a daemon that can run the commands that need to be run with root privileges. This option is usually enabled on nodes that run nova compute processes</td>
      </tr>
      <tr>
        <th colspan="2">[keystone_authtoken]</th>
      </tr>
      <tr>
        <td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
        <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
      </tr>
      <tr>
        <th colspan="2">[workarounds]</th>
      </tr>
      <tr>
        <td><option>destroy_after_evacuate</option> = <replaceable>True</replaceable></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 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>