[PATCH 8/8] kbase: Add note about preserving VM on shutdown to backup article

Peter Krempa via Devel posted 8 patches 2 days ago
[PATCH 8/8] kbase: Add note about preserving VM on shutdown to backup article
Posted by Peter Krempa via Devel 2 days ago
From: Peter Krempa <pkrempa@redhat.com>

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/kbase/live_full_disk_backup.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_disk_backup.rst
index be95d9d2e2..2b3b19772e 100644
--- a/docs/kbase/live_full_disk_backup.rst
+++ b/docs/kbase/live_full_disk_backup.rst
@@ -84,6 +84,24 @@ This requires libvirt-7.2.0 and QEMU-4.2, or higher versions.
     15M -rw-r--r--. 1 qemu qemu 15M May 10 12:22 vm1.qcow2
     21M -rw-------. 1 root root 21M May 10 12:23 vm1.qcow2.1620642185

+Shutdown of the guest OS during backup
+--------------------------------------
+
+The backup job is a long running job, potentially copying a lot of data, which
+requires the VM to be active (The backup is done by the qemu process) and
+can't be continued if the VM shuts down. This includes shut down initiated by
+the guest OS itself.
+
+Starting from ``libvirt-11.10`` the ``virDomainBackupBegin()`` supports the
+``VIR_DOMAIN_BACKUP_BEGIN_PRESERVE_SHUTDOWN_DOMAIN`` flag
+(``virsh backup-begin --preserve-domain-on-shutdown``) which instructs libvirt
+to avoid termination of the VM if the guest OS shuts down while the backup is
+still running. The VM is in that scenario reset and paused instead of terminated
+allowing the backup to finish. Once the backup finishes the VM process is
+terminated. Users can resume the VM (e.g. ``virsh resume``) which causes it
+to boot normally using the exsiting VM process and will continue to run after
+completion of the backup job.
+

 Full backup with older libvirt versions
 =======================================
-- 
2.51.1
Re: [PATCH 8/8] kbase: Add note about preserving VM on shutdown to backup article
Posted by Ján Tomko via Devel 1 day, 23 hours ago
On a Wednesday in 2025, Peter Krempa via Devel wrote:
>From: Peter Krempa <pkrempa@redhat.com>
>
>Signed-off-by: Peter Krempa <pkrempa@redhat.com>
>---
> docs/kbase/live_full_disk_backup.rst | 18 ++++++++++++++++++
> 1 file changed, 18 insertions(+)
>
>diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_disk_backup.rst
>index be95d9d2e2..2b3b19772e 100644
>--- a/docs/kbase/live_full_disk_backup.rst
>+++ b/docs/kbase/live_full_disk_backup.rst
>@@ -84,6 +84,24 @@ This requires libvirt-7.2.0 and QEMU-4.2, or higher versions.
>     15M -rw-r--r--. 1 qemu qemu 15M May 10 12:22 vm1.qcow2
>     21M -rw-------. 1 root root 21M May 10 12:23 vm1.qcow2.1620642185
>
>+Shutdown of the guest OS during backup
>+--------------------------------------
>+
>+The backup job is a long running job, potentially copying a lot of data, which
>+requires the VM to be active (The backup is done by the qemu process) and
>+can't be continued if the VM shuts down. This includes shut down initiated by
>+the guest OS itself.
>+
>+Starting from ``libvirt-11.10`` the ``virDomainBackupBegin()`` supports the

Can you use the :since: annotation for this?

>+``VIR_DOMAIN_BACKUP_BEGIN_PRESERVE_SHUTDOWN_DOMAIN`` flag
>+(``virsh backup-begin --preserve-domain-on-shutdown``) which instructs libvirt
>+to avoid termination of the VM if the guest OS shuts down while the backup is
>+still running. The VM is in that scenario reset and paused instead of terminated
>+allowing the backup to finish. Once the backup finishes the VM process is
>+terminated. Users can resume the VM (e.g. ``virsh resume``) which causes it
>+to boot normally using the exsiting VM process and will continue to run after

*existing

Jano

>+completion of the backup job.
>+
>
> Full backup with older libvirt versions
> =======================================
>-- 
>2.51.1
>
Re: [PATCH 8/8] kbase: Add note about preserving VM on shutdown to backup article
Posted by Peter Krempa via Devel 1 day, 20 hours ago
On Wed, Nov 19, 2025 at 11:26:47 +0100, Ján Tomko wrote:
> On a Wednesday in 2025, Peter Krempa via Devel wrote:
> > From: Peter Krempa <pkrempa@redhat.com>
> > 
> > Signed-off-by: Peter Krempa <pkrempa@redhat.com>
> > ---
> > docs/kbase/live_full_disk_backup.rst | 18 ++++++++++++++++++
> > 1 file changed, 18 insertions(+)
> > 
> > diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_disk_backup.rst
> > index be95d9d2e2..2b3b19772e 100644
> > --- a/docs/kbase/live_full_disk_backup.rst
> > +++ b/docs/kbase/live_full_disk_backup.rst
> > @@ -84,6 +84,24 @@ This requires libvirt-7.2.0 and QEMU-4.2, or higher versions.
> >     15M -rw-r--r--. 1 qemu qemu 15M May 10 12:22 vm1.qcow2
> >     21M -rw-------. 1 root root 21M May 10 12:23 vm1.qcow2.1620642185
> > 
> > +Shutdown of the guest OS during backup
> > +--------------------------------------
> > +
> > +The backup job is a long running job, potentially copying a lot of data, which
> > +requires the VM to be active (The backup is done by the qemu process) and
> > +can't be continued if the VM shuts down. This includes shut down initiated by
> > +the guest OS itself.
> > +
> > +Starting from ``libvirt-11.10`` the ``virDomainBackupBegin()`` supports the
> 
> Can you use the :since: annotation for this?

Yes, provided that I also add the definition of the 'since' role at the
beginning of the file:

.. role:: since

> 
> > +``VIR_DOMAIN_BACKUP_BEGIN_PRESERVE_SHUTDOWN_DOMAIN`` flag
> > +(``virsh backup-begin --preserve-domain-on-shutdown``) which instructs libvirt
> > +to avoid termination of the VM if the guest OS shuts down while the backup is
> > +still running. The VM is in that scenario reset and paused instead of terminated
> > +allowing the backup to finish. Once the backup finishes the VM process is
> > +terminated. Users can resume the VM (e.g. ``virsh resume``) which causes it
> > +to boot normally using the exsiting VM process and will continue to run after
> 
> *existing
> 
> Jano
> 
> > +completion of the backup job.
> > +
> > 
> > Full backup with older libvirt versions
> > =======================================
> > -- 
> > 2.51.1
> >