openstack-manuals/doc/common/tables/nova-libvirt.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_libvirt">
    <caption>Description of Libvirt 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>remove_unused_base_images = True</td>
        <td>(BoolOpt) Should unused base images be removed?</td>
      </tr>
      <tr>
        <td>remove_unused_original_minimum_age_seconds = 86400</td>
        <td>(IntOpt) Unused unresized base images younger than this will not be removed</td>
      </tr>
      <tr>
        <th colspan="2">[libvirt]</th>
      </tr>
      <tr>
        <td>checksum_base_images = False</td>
        <td>(BoolOpt) Write a checksum for files in _base to disk</td>
      </tr>
      <tr>
        <td>checksum_interval_seconds = 3600</td>
        <td>(IntOpt) How frequently to checksum base images</td>
      </tr>
      <tr>
        <td>connection_uri = </td>
        <td>(StrOpt) Override the default libvirt URI (which is dependent on virt_type)</td>
      </tr>
      <tr>
        <td>cpu_mode = None</td>
        <td>(StrOpt) Set to "host-model" to clone the host CPU feature flags; to "host-passthrough" to use the host CPU model exactly; to "custom" to use a named CPU model; to "none" to not set any CPU model. If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none"</td>
      </tr>
      <tr>
        <td>cpu_model = None</td>
        <td>(StrOpt) Set to a named libvirt CPU model (see names listed in /usr/share/libvirt/cpu_map.xml). Only has effect if cpu_mode="custom" and virt_type="kvm|qemu"</td>
      </tr>
      <tr>
        <td>disk_prefix = None</td>
        <td>(StrOpt) Override the default disk prefix for the devices attached to a server, which is dependent on virt_type. (valid options are: sd, xvd, uvd, vd)</td>
      </tr>
      <tr>
        <td>hw_machine_type = None</td>
        <td>(ListOpt) For qemu or KVM guests, set this option to specify a default machine type per host architecture. You can find a list of supported machine types in your environment by checking the output of the "virsh capabilities"command. The format of the value for this config option is host-arch=machine-type. For example: x86_64=machinetype1,armv7l=machinetype2</td>
      </tr>
      <tr>
        <td>image_info_filename_pattern = $instances_path/$image_cache_subdirectory_name/%(image)s.info</td>
        <td>(StrOpt) Allows image information files to be stored in non-standard locations</td>
      </tr>
      <tr>
        <td>mem_stats_period_seconds = 10</td>
        <td>(IntOpt) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics.</td>
      </tr>
      <tr>
        <td>remove_unused_kernels = False</td>
        <td>(BoolOpt) Should unused kernel images be removed? This is only safe to enable if all compute nodes have been updated to support this option. This will be enabled by default in future.</td>
      </tr>
      <tr>
        <td>remove_unused_resized_minimum_age_seconds = 3600</td>
        <td>(IntOpt) Unused resized base images younger than this will not be removed</td>
      </tr>
      <tr>
        <td>rng_dev_path = None</td>
        <td>(StrOpt) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng</td>
      </tr>
      <tr>
        <td>snapshots_directory = $instances_path/snapshots</td>
        <td>(StrOpt) Location where libvirt driver will store snapshots before uploading them to image service</td>
      </tr>
      <tr>
        <td>sysinfo_serial = auto</td>
        <td>(StrOpt) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS. Permitted options are "hardware", "os", "none" or "auto" (default).</td>
      </tr>
      <tr>
        <td>virt_type = kvm</td>
        <td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen)</td>
      </tr>
      <tr>
        <td>volume_clear = zero</td>
        <td>(StrOpt) Method used to wipe old volumes (valid options are: none, zero, shred)</td>
      </tr>
      <tr>
        <td>volume_clear_size = 0</td>
        <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 =&gt; all</td>
      </tr>
      <tr>
        <td>volume_drivers = iscsi=nova.virt.libvirt.volume.LibvirtISCSIVolumeDriver, iser=nova.virt.libvirt.volume.LibvirtISERVolumeDriver, local=nova.virt.libvirt.volume.LibvirtVolumeDriver, fake=nova.virt.libvirt.volume.LibvirtFakeVolumeDriver, rbd=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, sheepdog=nova.virt.libvirt.volume.LibvirtNetVolumeDriver, nfs=nova.virt.libvirt.volume.LibvirtNFSVolumeDriver, aoe=nova.virt.libvirt.volume.LibvirtAOEVolumeDriver, glusterfs=nova.virt.libvirt.volume.LibvirtGlusterfsVolumeDriver, fibre_channel=nova.virt.libvirt.volume.LibvirtFibreChannelVolumeDriver, scality=nova.virt.libvirt.volume.LibvirtScalityVolumeDriver</td>
        <td>(ListOpt) Libvirt handlers for remote volumes.</td>
      </tr>
      <tr>
        <td>wait_soft_reboot_seconds = 120</td>
        <td>(IntOpt) Number of seconds to wait for instance to shut down after soft reboot request is made. We fall back to hard reboot if instance does not shutdown within this window.</td>
      </tr>
    </tbody>
  </table>
</para>