NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

qemu: conf: Improve the foo_image_format setting descriptions

Browse Source 
The current description of the various foo_image_format settings can
be construded to imply the setting is only used to control compression
of the image. Improve the documentation to clarify that format describes
the representation of guest memory blocks on disk, which includes
compression among other possible layouts.

Signed-off-by: Jim Fehlig <jfehlig@suse.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
This commit is contained in:
Jim Fehlig 2024-08-15 16:52:57 -06:00
parent 07467e2719
commit b0dc8a923d
1 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/qemu/qemu.conf.in
View File

@ -578,27 +578,35 @@
# "/dev/infiniband/uverbs0" # "/dev/infiniband/uverbs0"
# The default format for QEMU/KVM guest save images is raw; that is, the # The libvirt QEMU driver supports serveral different save image formats.
# memory from the domain is dumped out directly to a file. If you have # The term "format" is used loosely to describe how the save image data is
# guests with a large amount of memory, however, this can take up quite # represented on disk. It could be a continguous stream of guest memory blocks,
# a bit of space. If you would like to compress the images while they # or a stream of compressed memory blocks.
# are being saved to disk, you can also set "zstd", "lzop", "gzip", "bzip2",
# or "xz" for save_image_format. Note that this means you slow down the process
# of saving a domain in order to save disk space.
# #
# save_image_format is used when you use 'virsh save' or 'virsh managedsave' # A continguous stream of guest memory blocks is the default format for QEMU/KVM
# at scheduled saving, and it is an error if the specified save_image_format # guest save images and is termed "raw". The raw format can consume considerable
# is not valid, or the requested compression program can't be found. # disk space when saving large memory guests. Various compression formats are
# available for specifying a save image compressed by the named algorithm.
# Supported compression formats are "zstd", "lzop", "gzip", "bzip2", and "xz".
# save_image_format can be used to select the desired save format. "raw" is
# the traditional format used by libvirt and is also the default. The
# compression formats can be used to save disk space, although this typically
# results in longer save and restore times.
# #
# dump_image_format is used when you use 'virsh dump' at emergency # save_image_format is used with 'virsh save' or 'virsh managedsave'. It is
# crashdump, and if the specified dump_image_format is not valid, or # an error if the specified save_image_format is not valid, or cannot be
# the requested compression program can't be found, this falls # supported by the system.
# back to "raw" compression.
# #
# snapshot_image_format specifies the compression algorithm of the memory save # dump_image_format is analogous to save_image_format and is used with
# 'virsh dump' at emergency crashdump. If the specified dump_image_format is
# not valid or cannot be supported by the system, this falls back to the
# "raw" format.
#
# Likewise, snapshot_image_format specifies the format of the memory save
# image when an external snapshot of a domain is taken. This does not apply # image when an external snapshot of a domain is taken. This does not apply
# on disk image format. It is an error if the specified format isn't valid, # on disk image format. It is an error if the specified format isn't valid,
# or the requested compression program can't be found. # or the system cannot support the requested format.
# #
#save_image_format = "raw" #save_image_format = "raw"
#dump_image_format = "raw" #dump_image_format = "raw"