openstack/openstack-manuals
Code Issues Proposed changes
d09bb5c8d4
openstack-manuals/doc/config-reference/source/tables/nova-libvirt.rst
KATO Tomoyuki 467eb1431a [config-ref] update compute config options for Newton 
Change-Id: I4b7f182daf7bc101a59ddfdb98055ffcd719e3bd
2016-09-30 09:47:45 +00:00

349 lines
18 KiB
ReStructuredText
Raw Blame History

..
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.
.. _nova-libvirt:
.. list-table:: Description of Libvirt configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``remove_unused_base_images`` = ``True``
- (Boolean) Should unused base images be removed?
* - ``remove_unused_original_minimum_age_seconds`` = ``86400``
- (Integer) Unused unresized base images younger than this will not be removed
* - **[libvirt]**
-
* - ``checksum_base_images`` = ``False``
- (Boolean) DEPRECATED: Write a checksum for files in _base to disk The image cache no longer periodically calculates checksums of stored images. Data integrity can be checked at the block or filesystem level.
* - ``checksum_interval_seconds`` = ``3600``
- (Integer) DEPRECATED: How frequently to checksum base images The image cache no longer periodically calculates checksums of stored images. Data integrity can be checked at the block or filesystem level.
* - ``connection_uri`` =
- (String) Overrides the default libvirt URI of the chosen virtualization type.
If set, Nova will use this URI to connect to libvirt.
Possible values:
* An URI like ``qemu:///system`` or ``xen+ssh://oirase/`` for example. This is only necessary if the URI differs to the commonly known URIs for the chosen virtualization type.
Related options:
* ``virt_type``: Influences what is used as default value here.
* - ``cpu_mode`` = ``None``
- (String) Is used to set the CPU mode an instance should have.
If virt_type="kvm|qemu", it will default to "host-model", otherwise it will default to "none".
Possible values:
* ``host-model``: Clones the host CPU feature flags.
* ``host-passthrough``: Use the host CPU model exactly;
* ``custom``: Use a named CPU model;
* ``none``: Not set any CPU model.
Related options:
* ``cpu_model``: If ``custom`` is used for ``cpu_mode``, set this config option too, otherwise this would result in an error and the instance won't be launched.
* - ``cpu_model`` = ``None``
- (String) Set the name of the libvirt CPU model the instance should use.
Possible values:
* The names listed in /usr/share/libvirt/cpu_map.xml
Related options:
* ``cpu_mode``: Don't set this when ``cpu_mode`` is NOT set to ``custom``. This would result in an error and the instance won't be launched.
* ``virt_type``: Only the virtualization types ``kvm`` and ``qemu`` use this.
* - ``disk_cachemodes`` =
- (List) Specific cachemodes to use for different disk types e.g: file=directsync,block=none
* - ``disk_prefix`` = ``None``
- (String) Override the default disk prefix for the devices attached to an instance.
If set, this is used to identify a free disk device name for a bus.
Possible values:
* Any prefix which will result in a valid disk device name like 'sda' or 'hda' for example. This is only necessary if the device names differ to the commonly known device name prefixes for a virtualization type such as: sd, xvd, uvd, vd.
Related options:
* ``virt_type``: Influences which device type is used, which determines the default disk prefix.
* - ``enabled_perf_events`` =
- (List) This is a performance event list which could be used as monitor. These events will be passed to libvirt domain xml while creating a new instances. Then event statistics data can be collected from libvirt. The minimum libvirt version is 2.0.0. For more information about `Performance monitoring events`, refer https://libvirt.org/formatdomain.html#elementsPerf .
* Possible values: A string list. For example: ``enabled_perf_events = cmt, mbml, mbmt``
The supported events list can be found in https://libvirt.org/html/libvirt-libvirt-domain.html , which you may need to search key words ``VIR_PERF_PARAM_*``
* Services that use this:
``nova-compute``
* Related options: None
* - ``gid_maps`` =
- (List) List of guid targets and ranges.Syntax is guest-gid:host-gid:countMaximum of 5 allowed.
* - ``hw_disk_discard`` = ``None``
- (String) Discard option for nova managed disks. Need Libvirt(1.0.6) Qemu1.5 (raw format) Qemu1.6(qcow2 format)
* - ``hw_machine_type`` = ``None``
- (List) 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
* - ``image_info_filename_pattern`` = ``$instances_path/$image_cache_subdirectory_name/%(image)s.info``
- (String) DEPRECATED: Allows image information files to be stored in non-standard locations Image info files are no longer used by the image cache
* - ``images_rbd_ceph_conf`` =
- (String) Path to the ceph configuration file to use
* - ``images_rbd_pool`` = ``rbd``
- (String) The RADOS pool in which rbd volumes are stored
* - ``images_type`` = ``default``
- (String) VM Images format. If default is specified, then use_cow_images flag is used instead of this one.
* - ``images_volume_group`` = ``None``
- (String) LVM Volume Group that is used for VM images, when you specify images_type=lvm.
* - ``inject_key`` = ``False``
- (Boolean) Allow the injection of an SSH key at boot time.
There is no agent needed within the image to do this. If *libguestfs* is available on the host, it will be used. Otherwise *nbd* is used. The file system of the image will be mounted and the SSH key, which is provided in the REST API call will be injected as SSH key for the root user and appended to the ``authorized_keys`` of that user. The SELinux context will be set if necessary. Be aware that the injection is *not* possible when the instance gets launched from a volume.
This config option will enable directly modifying the instance disk and does not affect what cloud-init may do using data from config_drive option or the metadata service.
Related options:
* ``inject_partition``: That option will decide about the discovery and usage of the file system. It also can disable the injection at all.
* - ``inject_partition`` = ``-2``
- (Integer) Determines the way how the file system is chosen to inject data into it.
*libguestfs* will be used a first solution to inject data. If that's not available on the host, the image will be locally mounted on the host as a fallback solution. If libguestfs is not able to determine the root partition (because there are more or less than one root partition) or cannot mount the file system it will result in an error and the instance won't be boot.
Possible values:
* -2 => disable the injection of data.
* -1 => find the root partition with the file system to mount with libguestfs
* 0 => The image is not partitioned
* >0 => The number of the partition to use for the injection
Related options:
* ``inject_key``: If this option allows the injection of a SSH key it depends on value greater or equal to -1 for ``inject_partition``.
* ``inject_password``: If this option allows the injection of an admin password it depends on value greater or equal to -1 for ``inject_partition``.
* ``guestfs`` You can enable the debug log level of libguestfs with this config option. A more verbose output will help in debugging issues.
* ``virt_type``: If you use ``lxc`` as virt_type it will be treated as a single partition image
* - ``inject_password`` = ``False``
- (Boolean) Allow the injection of an admin password for instance only at ``create`` and ``rebuild`` process.
There is no agent needed within the image to do this. If *libguestfs* is available on the host, it will be used. Otherwise *nbd* is used. The file system of the image will be mounted and the admin password, which is provided in the REST API call will be injected as password for the root user. If no root user is available, the instance won't be launched and an error is thrown. Be aware that the injection is *not* possible when the instance gets launched from a volume.
Possible values:
* True: Allows the injection.
* False (default): Disallows the injection. Any via the REST API provided admin password will be silently ignored.
Related options:
* ``inject_partition``: That option will decide about the discovery and usage of the file system. It also can disable the injection at all.
* - ``iscsi_iface`` = ``None``
- (String) The iSCSI transport iface to use to connect to target in case offload support is desired. Default format is of the form <transport_name>.<hwaddress> where <transport_name> is one of (be2iscsi, bnx2i, cxgb3i, cxgb4i, qla4xxx, ocs) and <hwaddress> is the MAC address of the interface and can be generated via the iscsiadm -m iface command. Do not confuse the iscsi_iface parameter to be provided here with the actual transport name.
* - ``iser_use_multipath`` = ``False``
- (Boolean) Use multipath connection of the iSER volume
* - ``mem_stats_period_seconds`` = ``10``
- (Integer) A number of seconds to memory usage statistics period. Zero or negative value mean to disable memory usage statistics.
* - ``realtime_scheduler_priority`` = ``1``
- (Integer) In a realtime host context vCPUs for guest will run in that scheduling priority. Priority depends on the host kernel (usually 1-99)
* - ``remove_unused_resized_minimum_age_seconds`` = ``3600``
- (Integer) Unused resized base images younger than this will not be removed
* - ``rescue_image_id`` = ``None``
- (String) The ID of the image to boot from to rescue data from a corrupted instance.
If the rescue REST API operation doesn't provide an ID of an image to use, the image which is referenced by this ID is used. If this option is not set, the image from the instance is used.
Possible values:
* An ID of an image or nothing. If it points to an *Amazon Machine Image* (AMI), consider to set the config options ``rescue_kernel_id`` and ``rescue_ramdisk_id`` too. If nothing is set, the image of the instance is used.
Related options:
* ``rescue_kernel_id``: If the chosen rescue image allows the separate definition of its kernel disk, the value of this option is used, if specified. This is the case when *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.
* ``rescue_ramdisk_id``: If the chosen rescue image allows the separate definition of its RAM disk, the value of this option is used if, specified. This is the case when *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.
* - ``rescue_kernel_id`` = ``None``
- (String) The ID of the kernel (AKI) image to use with the rescue image.
If the chosen rescue image allows the separate definition of its kernel disk, the value of this option is used, if specified. This is the case when *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.
Possible values:
* An ID of an kernel image or nothing. If nothing is specified, the kernel disk from the instance is used if it was launched with one.
Related options:
* ``rescue_image_id``: If that option points to an image in *Amazon*'s AMI/AKI/ARI image format, it's useful to use ``rescue_kernel_id`` too.
* - ``rescue_ramdisk_id`` = ``None``
- (String) The ID of the RAM disk (ARI) image to use with the rescue image.
If the chosen rescue image allows the separate definition of its RAM disk, the value of this option is used, if specified. This is the case when *Amazon*'s AMI/AKI/ARI image format is used for the rescue image.
Possible values:
* An ID of a RAM disk image or nothing. If nothing is specified, the RAM disk from the instance is used if it was launched with one.
Related options:
* ``rescue_image_id``: If that option points to an image in *Amazon*'s AMI/AKI/ARI image format, it's useful to use ``rescue_ramdisk_id`` too.
* - ``rng_dev_path`` = ``None``
- (String) A path to a device that will be used as source of entropy on the host. Permitted options are: /dev/random or /dev/hwrng
* - ``snapshot_compression`` = ``False``
- (Boolean) Compress snapshot images when possible. This currently applies exclusively to qcow2 images
* - ``snapshot_image_format`` = ``None``
- (String) Snapshot image format. Defaults to same as source image
* - ``snapshots_directory`` = ``$instances_path/snapshots``
- (String) Location where libvirt driver will store snapshots before uploading them to image service
* - ``sparse_logical_volumes`` = ``False``
- (Boolean) Create sparse logical volumes (with virtualsize) if this flag is set to True.
* - ``sysinfo_serial`` = ``auto``
- (String) The data source used to the populate the host "serial" UUID exposed to guest in the virtual BIOS.
* - ``uid_maps`` =
- (List) List of uid targets and ranges.Syntax is guest-uid:host-uid:countMaximum of 5 allowed.
* - ``use_usb_tablet`` = ``True``
- (Boolean) DEPRECATED: Enable a mouse cursor within a graphical VNC or SPICE sessions.
This will only be taken into account if the VM is fully virtualized and VNC and/or SPICE is enabled. If the node doesn't support a graphical framebuffer, then it is valid to set this to False.
Related options:
* ``[vnc]enabled``: If VNC is enabled, ``use_usb_tablet`` will have an effect.
* ``[spice]enabled`` + ``[spice].agent_enabled``: If SPICE is enabled and the spice agent is disabled, the config value of ``use_usb_tablet`` will have an effect. This option is being replaced by the 'pointer_model' option.
* - ``use_virtio_for_bridges`` = ``True``
- (Boolean) Use virtio for bridge interfaces with KVM/QEMU
* - ``virt_type`` = ``kvm``
- (String) Describes the virtualization type (or so called domain type) libvirt should use.
The choice of this type must match the underlying virtualization strategy you have chosen for this host.
Possible values:
* See the predefined set of case-sensitive values.
Related options:
* ``connection_uri``: depends on this
* ``disk_prefix``: depends on this
* ``cpu_mode``: depends on this
* ``cpu_model``: depends on this
* - ``volume_clear`` = ``zero``
- (String) Method used to wipe old volumes.
* - ``volume_clear_size`` = ``0``
- (Integer) Size in MiB to wipe at start of old volumes. 0 => all
* - ``volume_use_multipath`` = ``False``
- (Boolean) Use multipath connection of the iSCSI or FC volume
* - ``vzstorage_cache_path`` = ``None``
- (String) Path to the SSD cache file.
You can attach an SSD drive to a client and configure the drive to store a local cache of frequently accessed data. By having a local cache on a client's SSD drive, you can increase the overall cluster performance by up to 10 and more times. WARNING! There is a lot of SSD models which are not server grade and may loose arbitrary set of data changes on power loss. Such SSDs should not be used in Vstorage and are dangerous as may lead to data corruptions and inconsistencies. Please consult with the manual on which SSD models are known to be safe or verify it using vstorage-hwflush-check(1) utility.
This option defines the path which should include "%(cluster_name)s" template to separate caches from multiple shares.
* Services that use this:
``nova-compute``
* Related options:
vzstorage_mount_opts may include more detailed cache options.
* - ``vzstorage_log_path`` = ``/var/log/pstorage/%(cluster_name)s/nova.log.gz``
- (String) Path to vzstorage client log.
This option defines the log of cluster operations, it should include "%(cluster_name)s" template to separate logs from multiple shares.
* Services that use this:
``nova-compute``
* Related options:
vzstorage_mount_opts may include more detailed logging options.
* - ``vzstorage_mount_group`` = ``qemu``
- (String) Mount owner group name.
This option defines the owner group of Vzstorage cluster mountpoint.
* Services that use this:
``nova-compute``
* Related options:
vzstorage_mount_* group of parameters
* - ``vzstorage_mount_opts`` =
- (List) Extra mount options for pstorage-mount
For full description of them, see https://static.openvz.org/vz-man/man1/pstorage-mount.1.gz.html Format is a python string representation of arguments list, like: "['-v', '-R', '500']" Shouldn't include -c, -l, -C, -u, -g and -m as those have explicit vzstorage_* options.
* Services that use this:
``nova-compute``
* Related options:
All other vzstorage_* options
* - ``vzstorage_mount_perms`` = ``0770``
- (String) Mount access mode.
This option defines the access bits of Vzstorage cluster mountpoint, in the format similar to one of chmod(1) utility, like this: 0770. It consists of one to four digits ranging from 0 to 7, with missing lead digits assumed to be 0's.
* Services that use this:
``nova-compute``
* Related options:
vzstorage_mount_* group of parameters
* - ``vzstorage_mount_point_base`` = ``$state_path/mnt``
- (String) Directory where the Virtuozzo Storage clusters are mounted on the compute node.
This option defines non-standard mountpoint for Vzstorage cluster.
* Services that use this:
``nova-compute``
* Related options:
vzstorage_mount_* group of parameters
* - ``vzstorage_mount_user`` = ``stack``
- (String) Mount owner user name.
This option defines the owner user of Vzstorage cluster mountpoint.
* Services that use this:
``nova-compute``
* Related options:
vzstorage_mount_* group of parameters
* - ``wait_soft_reboot_seconds`` = ``120``
- (Integer) 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.
View Git Blame Copy Permalink