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

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_nova_compute">
    <caption>Description of Compute 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>compute_available_monitors</option> = <replaceable>None</replaceable></td>
        <td>(MultiStrOpt) Monitor classes available to the compute which may be specified more than once. This option is DEPRECATED and no longer used. Use setuptools entry points to list available monitor plugins.</td>
      </tr>
      <tr>
        <td><option>compute_driver</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Driver to use for controlling virtualization. Options include: libvirt.LibvirtDriver, xenapi.XenAPIDriver, fake.FakeDriver, ironic.IronicDriver, vmwareapi.VMwareVCDriver, hyperv.HyperVDriver</td>
      </tr>
      <tr>
        <td><option>compute_manager</option> = <replaceable>nova.compute.manager.ComputeManager</replaceable></td>
        <td>(StrOpt) Full class name for the Manager for compute</td>
      </tr>
      <tr>
        <td><option>compute_monitors</option> = <replaceable></replaceable></td>
        <td>(ListOpt) A list of monitors that can be used for getting compute metrics. You can use the alias/name from the setuptools entry points for nova.compute.monitors.* namespaces. If no namespace is supplied, the "cpu." namespace is assumed for backwards-compatibility. An example value that would enable both the CPU and NUMA memory bandwidth monitors that used the virt driver variant: ["cpu.virt_driver", "numa_mem_bw.virt_driver"]</td>
      </tr>
      <tr>
        <td><option>compute_resources</option> = <replaceable>vcpu</replaceable></td>
        <td>(ListOpt) The names of the extra resources to track.</td>
      </tr>
      <tr>
        <td><option>compute_stats_class</option> = <replaceable>nova.compute.stats.Stats</replaceable></td>
        <td>(StrOpt) Class that will manage stats for the local compute host</td>
      </tr>
      <tr>
        <td><option>console_host</option> = <replaceable>localhost</replaceable></td>
        <td>(StrOpt) Console proxy host to use to connect to instances on this host.</td>
      </tr>
      <tr>
        <td><option>console_manager</option> = <replaceable>nova.console.manager.ConsoleProxyManager</replaceable></td>
        <td>(StrOpt) Full class name for the Manager for console proxy</td>
      </tr>
      <tr>
        <td><option>default_flavor</option> = <replaceable>m1.small</replaceable></td>
        <td>(StrOpt) Default flavor to use for the EC2 API only. The Nova API does not support a default flavor.</td>
      </tr>
      <tr>
        <td><option>default_notification_level</option> = <replaceable>INFO</replaceable></td>
        <td>(StrOpt) Default notification level for outgoing notifications</td>
      </tr>
      <tr>
        <td><option>enable_instance_password</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Enables returning of the instance password by the relevant server API calls such as create, rebuild or rescue, If the hypervisor does not support password injection then the password returned will not be correct</td>
      </tr>
      <tr>
        <td><option>heal_instance_info_cache_interval</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Number of seconds between instance network information cache updates</td>
      </tr>
      <tr>
        <td><option>image_cache_manager_interval</option> = <replaceable>2400</replaceable></td>
        <td>(IntOpt) Number of seconds to wait between runs of the image cache manager. Set to -1 to disable. Setting this to 0 will run at the default rate.</td>
      </tr>
      <tr>
        <td><option>image_cache_subdirectory_name</option> = <replaceable>_base</replaceable></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><option>instance_build_timeout</option> = <replaceable>0</replaceable></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>
      </tr>
      <tr>
        <td><option>instance_delete_interval</option> = <replaceable>300</replaceable></td>
        <td>(IntOpt) Interval in seconds for retrying failed instance file deletes. Set to -1 to disable. Setting this to 0 will run at the default rate.</td>
      </tr>
      <tr>
        <td><option>instance_usage_audit</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Generate periodic compute.instance.exists notifications</td>
      </tr>
      <tr>
        <td><option>instance_usage_audit_period</option> = <replaceable>month</replaceable></td>
        <td>(StrOpt) Time period to generate instance usages for.  Time period must be hour, day, month or year</td>
      </tr>
      <tr>
        <td><option>instances_path</option> = <replaceable>$state_path/instances</replaceable></td>
        <td>(StrOpt) Where instances are stored on disk</td>
      </tr>
      <tr>
        <td><option>max_concurrent_builds</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Maximum number of instance builds to run concurrently</td>
      </tr>
      <tr>
        <td><option>maximum_instance_delete_attempts</option> = <replaceable>5</replaceable></td>
        <td>(IntOpt) The number of times to attempt to reap an instance's files.</td>
      </tr>
      <tr>
        <td><option>reboot_timeout</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Automatically hard reboot an instance if it has been stuck in a rebooting state longer than N seconds. Set to 0 to disable.</td>
      </tr>
      <tr>
        <td><option>reclaim_instance_interval</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Interval in seconds for reclaiming deleted instances</td>
      </tr>
      <tr>
        <td><option>rescue_timeout</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Automatically unrescue an instance after N seconds. Set to 0 to disable.</td>
      </tr>
      <tr>
        <td><option>resize_confirm_window</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Automatically confirm resizes after N seconds. Set to 0 to disable.</td>
      </tr>
      <tr>
        <td><option>resume_guests_state_on_host_boot</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to start guests that were running before the host rebooted</td>
      </tr>
      <tr>
        <td><option>running_deleted_instance_action</option> = <replaceable>reap</replaceable></td>
        <td>(StrOpt) Action to take if a running deleted instance is detected.Set to 'noop' to take no action.</td>
      </tr>
      <tr>
        <td><option>running_deleted_instance_poll_interval</option> = <replaceable>1800</replaceable></td>
        <td>(IntOpt) Number of seconds to wait between runs of the cleanup task.</td>
      </tr>
      <tr>
        <td><option>running_deleted_instance_timeout</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Number of seconds after being deleted when a running instance should be considered eligible for cleanup.</td>
      </tr>
      <tr>
        <td><option>shelved_offload_time</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Time in seconds before a shelved instance is eligible for removing from a host. -1 never offload, 0 offload immediately when shelved</td>
      </tr>
      <tr>
        <td><option>shelved_poll_interval</option> = <replaceable>3600</replaceable></td>
        <td>(IntOpt) Interval in seconds for polling shelved instances to offload. Set to -1 to disable.Setting this to 0 will run at the default rate.</td>
      </tr>
      <tr>
        <td><option>shutdown_timeout</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Total amount of time to wait in seconds for an instance to perform a clean shutdown.</td>
      </tr>
      <tr>
        <td><option>sync_power_state_interval</option> = <replaceable>600</replaceable></td>
        <td>(IntOpt) Interval to sync power states between the database and the hypervisor. Set to -1 to disable. Setting this to 0 will run at the default rate.</td>
      </tr>
      <tr>
        <td><option>update_resources_interval</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Interval in seconds for updating compute resources. A number less than 0 means to disable the task completely. Leaving this at the default of 0 will cause this to run at the default periodic interval. Setting it to any positive value will cause it to run at approximately that number of seconds.</td>
      </tr>
      <tr>
        <td><option>vif_plugging_is_fatal</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Fail instance boot if vif plugging fails</td>
      </tr>
      <tr>
        <td><option>vif_plugging_timeout</option> = <replaceable>300</replaceable></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>