libvirt/docs/manpages
Benjamin Taubmann a39dd25715 Extend libvirt-guests to shutdown only persistent VMs
At the moment, there is no configuration option for the libvirt-guests
service that allows users to define that only persistent virtual machines
should be shutdown on host shutdown.

Currently, the service config allows to choose between two ON_SHUTDOWN
actions that are executed on running virtual machines when the host goes
down: shutdown, suspend.
The ON_SHUTDOWN action should be orthogonal to the type of the virtual
machine. However, the existing implementation, does not suspend
transient virtual machines.
This is the matrix of actions that is executed on virtual machines based
on the configured ON_SHUTDOWN action and the type of a virtual machine.

         | persistent | transient
shutdown | shutdown   | shutdown (what we want to change)
suspend  | suspend    | nothing

Add config option PERSISTENT_ONLY to libvirt-guests config that allows
users to define if the ON_SHUTDOWN action should be applied only on
persistent virtual machines. PERSISTENT_ONLY can be set to true, false,
default. The default option will implement the already existing logic.

Case 1: PERSISTENT_ONLY=default
         | persistent | transient
shutdown | shutdown   | shutdown
suspend  | suspend    | nothing

Case 2: PERSISTENT_ONLY=true
         | persistent | transient
shutdown | shutdown   | nothing
suspend  | suspend    | nothing

Case 3: PERSISTENT_ONLY=false
         | persistent | transient
shutdown | shutdown   | shutdown
suspend  | suspend    | suspend

Signed-off-by: Benjamin Taubmann <benjamin.taubmann@nutanix.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
2024-04-04 09:10:00 +02:00
..
index.rst docs: manpages: Add missing manpages to index 2023-02-15 12:38:45 +01:00
libvirt-guests.rst Extend libvirt-guests to shutdown only persistent VMs 2024-04-04 09:10:00 +02:00
libvirtd.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
meson.build meson: Use initconfdir 2023-05-05 15:08:25 +02:00
virsh.rst vsh: Allow non-interactive use of 'cd' command 2024-04-02 14:24:30 +02:00
virt-admin.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
virt-host-validate.rst docs: convert virt-host-validate man page from pod to rst 2019-12-11 14:28:41 +00:00
virt-login-shell.rst docs: use "::" instead of ".. code-block::" 2020-10-05 13:05:47 +01:00
virt-pki-query-dn.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
virt-pki-validate.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
virt-qemu-qmp-proxy.rst tools: add virt-qemu-qmp-proxy for proxying QMP via libvirt QEMU guests 2022-10-07 14:32:36 +01:00
virt-qemu-run.rst virt-qemu-run: Improve manual page 2021-12-10 18:39:56 +01:00
virt-qemu-sev-validate.rst Use 'libvirt.org' instead of 'www.libvirt.org' 2023-04-03 09:19:05 +02:00
virt-sanlock-cleanup.rst man: fix section of virt-sanlock-cleanup 2020-01-17 15:34:10 +01:00
virt-ssh-helper.rst virt-ssh-helper: Move manual page to section 8 2022-01-13 16:07:56 +01:00
virt-xml-validate.rst virt-xml-validate: Add more XML formats support 2022-05-13 17:15:24 +02:00
virtbhyved.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtinterfaced.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtlockd.rst docs: don't hardcode an ancient version in manpage examples 2021-01-15 19:08:00 +00:00
virtlogd.rst docs: don't hardcode an ancient version in manpage examples 2021-01-15 19:08:00 +00:00
virtlxcd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtnetworkd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtnodedevd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtnwfilterd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtproxyd.rst docs: manpages: State that TCP connection is insecure in 'virtproxyd' man page 2023-04-24 12:57:17 +02:00
virtqemud.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtsecretd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtstoraged.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtvboxd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtvzd.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00
virtxend.rst docs: manpages: Clarify that only TLS/TCP remote access needs 'virtproxyd' 2023-04-24 12:57:17 +02:00