Skip to content

Commit d8fc62c

Browse files
committed
Added information about the quiesce feature
1 parent ff0f305 commit d8fc62c

File tree

2 files changed

+30
-3
lines changed

2 files changed

+30
-3
lines changed

source/adminguide/backup_and_recovery.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,8 @@ from which the backup was taken with all the data from the backup.
173173
|B&R-CreateInstanceFromBackup.png|
174174

175175
Users can also choose to configure the new Instance with different parameters similar to while deploying a new Instance.
176-
The form will be initially prefilled with the values stored in the backup.
176+
The form will be initially prefilled with the values stored in the backup. If configuring volume sizes, users have to
177+
make sure that the size of a volume in the instance is not less than the size of the corresponding volume in the backup.
177178

178179
|B&R-ConfigureInstance.png|
179180

source/adminguide/nas_plugin.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Field Value
7878
Name A suitable name to represent the Backup Repository
7979
Address URL, in case of NFS <server IP>:/path
8080
Type NFS / CIFS / CEPH
81-
label.mountopts Any mount point options to be passed while mouting this storage on the hypervisor.
81+
Mount options Any mount point options to be passed while mouting this storage on the hypervisor.
8282
Zone The zone in CloudStack with which this Backup Repository must be associated.
8383
=================== ========================
8484

@@ -98,6 +98,28 @@ For the "External ID", please specify the name of the previously created backup
9898

9999
After this has been done, you can go to any Instance view and there will be buttons available for either ad-hoc backup or a scheduled backup of the VM
100100

101+
Quiesce (Filesystem Freeze and Thaw)
102+
------------------------------------
103+
104+
Users can set quiesce to true while creating a backup or a backup schedule.
105+
When a backup is initiated with quiesce enabled, CloudStack uses QEMU guest agent
106+
to freeze the filesystem before starting backup. This operation flushes all dirty
107+
filesystem buffers to disk and quiesces new writes. The filesystem is then thawed
108+
immediately after the backup process starts, keeping the freezing window very short.
109+
110+
|NASB&R-quiesceInstance.png|
111+
112+
This enhancement brings the NAS backup plugin from crash-consistent backups closer to
113+
application-consistent backups.
114+
115+
Points to note:
116+
117+
#. The feature requires qemu-guest-agent to be installed and running on the guest instance.
118+
#. This method does not capture the memory state of the guest. Any data held in application memory
119+
that hasn’t been flushed to disk prior to the filesystem freeze will not be captured.
120+
#. For fully application-consistent backups, guest applications must implement pre-freeze hooks
121+
to flush their internal state to disk before the filesystem is frozen.
122+
101123
Support Information and Limitation
102124
----------------------------------
103125

@@ -120,8 +142,12 @@ in qcow2 format to the backup repository.
120142

121143
For restore operations, the KVM instance must be stopped in CloudStack.
122144
Currently, only volume(s) restoration is supported only to NFS and local storage
123-
based primary storage pools, and restored volumes are fully baked disks (i.e.
145+
based primary storage pools, and restored volumes are fully backed disks (i.e.
124146
not using any backing template file).
125147

126148
Backup and restore operations are not fully supported for CKS cluster instances and should
127149
be avoided.
150+
151+
.. |NASB&R-quiesceInstance.png| image:: /_static/images/NASB&R-quiesceInstance.png
152+
:alt: Quiesce option while creating backups.
153+
:width: 400 px

0 commit comments

Comments
 (0)