apiVersion: snapshot.kubevirt.io/v1alpha1
kind: VirtualMachineSnapshot
metadata:
name: <snapshot_name>
spec:
source:
apiGroup: kubevirt.io
kind: VirtualMachine
name: <vm_name>
You can back up and restore virtual machines (VMs) by using snapshots. Snapshots are supported by the following storage providers:
Red Hat OpenShift Data Foundation
Any other cloud storage provider with the Container Storage Interface (CSI) driver that supports the Kubernetes Volume Snapshot API
Online snapshots have a default time deadline of five minutes (5m
) that can be changed, if needed.
Online snapshots are supported for virtual machines that have hot plugged virtual disks. However, hot plugged disks that are not in the virtual machine specification are not included in the snapshot. |
To create snapshots of an online (Running state) VM with the highest integrity, install the QEMU guest agent if it is not included with your operating system. The QEMU guest agent is included with the default Red Hat templates.
The QEMU guest agent takes a consistent snapshot by attempting to quiesce the VM file system as much as possible, depending on the system workload. This ensures that in-flight I/O is written to the disk before the snapshot is taken. If the guest agent is not present, quiescing is not possible and a best-effort snapshot is taken. The conditions under which the snapshot was taken are reflected in the snapshot indications that are displayed in the web console or CLI.
A snapshot represents the state and data of a virtual machine (VM) at a specific point in time. You can use a snapshot to restore an existing VM to a previous state (represented by the snapshot) for backup and disaster recovery or to rapidly roll back to a previous development version.
A VM snapshot is created from a VM that is powered off (Stopped state) or powered on (Running state).
When taking a snapshot of a running VM, the controller checks that the QEMU guest agent is installed and running. If so, it freezes the VM file system before taking the snapshot, and thaws the file system after the snapshot is taken.
The snapshot stores a copy of each Container Storage Interface (CSI) volume attached to the VM and a copy of the VM specification and metadata. Snapshots cannot be changed after creation.
You can perform the following snapshot actions:
Create a new snapshot
Create a copy of a virtual machine from a snapshot
List all snapshots attached to a specific VM
Restore a VM from a snapshot
Delete an existing VM snapshot
The VM snapshot feature introduces three new API objects defined as custom resource definitions (CRDs) for managing snapshots:
VirtualMachineSnapshot
: Represents a user request to create a snapshot. It contains information about the current state of the VM.
VirtualMachineSnapshotContent
: Represents a provisioned resource on the cluster (a snapshot). It is created by the VM snapshot controller and contains references to all resources required to restore the VM.
VirtualMachineRestore
: Represents a user request to restore a VM from a snapshot.
The VM snapshot controller binds a VirtualMachineSnapshotContent
object with the VirtualMachineSnapshot
object for which it was created, with a one-to-one mapping.
You can create snapshots of virtual machines (VMs) by using the OpenShift Container Platform web console or the command line.
You can create a snapshot of a virtual machine (VM) by using the OpenShift Container Platform web console.
The VM snapshot includes disks that meet the following requirements:
Either a data volume or a persistent volume claim
Belong to a storage class that supports Container Storage Interface (CSI) volume snapshots
Navigate to Virtualization → VirtualMachines in the web console.
Select a VM to open the VirtualMachine details page.
If the VM is running, click the options menu and select Stop to power it down.
Click the Snapshots tab and then click Take Snapshot.
Enter the snapshot name.
Expand Disks included in this Snapshot to see the storage volumes to be included in the snapshot.
If your VM has disks that cannot be included in the snapshot and you wish to proceed, select I am aware of this warning and wish to proceed.
Click Save.
You can create a virtual machine (VM) snapshot for an offline or online VM by creating a VirtualMachineSnapshot
object.
Ensure that the persistent volume claims (PVCs) are in a storage class that supports Container Storage Interface (CSI) volume snapshots.
Install the OpenShift CLI (oc
).
Optional: Power down the VM for which you want to create a snapshot.
Create a YAML file to define a VirtualMachineSnapshot
object that specifies the name of the new VirtualMachineSnapshot
and the name of the source VM as in the following example:
apiVersion: snapshot.kubevirt.io/v1alpha1
kind: VirtualMachineSnapshot
metadata:
name: <snapshot_name>
spec:
source:
apiGroup: kubevirt.io
kind: VirtualMachine
name: <vm_name>
Create the VirtualMachineSnapshot
object:
$ oc create -f <snapshot_name>.yaml
The snapshot controller creates a VirtualMachineSnapshotContent
object, binds it to the VirtualMachineSnapshot
, and updates the status
and readyToUse
fields of the VirtualMachineSnapshot
object.
Optional: If you are taking an online snapshot, you can use the wait
command and monitor the status of the snapshot:
Enter the following command:
$ oc wait <vm_name> <snapshot_name> --for condition=Ready
Verify the status of the snapshot:
InProgress
- The online snapshot operation is still in progress.
Succeeded
- The online snapshot operation completed successfully.
Failed
- The online snapshot operaton failed.
Online snapshots have a default time deadline of five minutes ( To change the default time deadline, add the To set no deadline, you can specify If you do not specify a unit of time such as |
Verify that the VirtualMachineSnapshot
object is created and bound with VirtualMachineSnapshotContent
and that the readyToUse
flag is set to true
:
$ oc describe vmsnapshot <snapshot_name>
apiVersion: snapshot.kubevirt.io/v1alpha1
kind: VirtualMachineSnapshot
metadata:
creationTimestamp: "2020-09-30T14:41:51Z"
finalizers:
- snapshot.kubevirt.io/vmsnapshot-protection
generation: 5
name: mysnap
namespace: default
resourceVersion: "3897"
selfLink: /apis/snapshot.kubevirt.io/v1alpha1/namespaces/default/virtualmachinesnapshots/my-vmsnapshot
uid: 28eedf08-5d6a-42c1-969c-2eda58e2a78d
spec:
source:
apiGroup: kubevirt.io
kind: VirtualMachine
name: my-vm
status:
conditions:
- lastProbeTime: null
lastTransitionTime: "2020-09-30T14:42:03Z"
reason: Operation complete
status: "False" (1)
type: Progressing
- lastProbeTime: null
lastTransitionTime: "2020-09-30T14:42:03Z"
reason: Operation complete
status: "True" (2)
type: Ready
creationTime: "2020-09-30T14:42:03Z"
readyToUse: true (3)
sourceUID: 355897f3-73a0-4ec4-83d3-3c2df9486f4f
virtualMachineSnapshotContentName: vmsnapshot-content-28eedf08-5d6a-42c1-969c-2eda58e2a78d (4)
1 | The status field of the Progressing condition specifies if the snapshot is still being created. |
2 | The status field of the Ready condition specifies if the snapshot creation process is complete. |
3 | Specifies if the snapshot is ready to be used. |
4 | Specifies that the snapshot is bound to a VirtualMachineSnapshotContent object created by the snapshot controller. |
Check the spec:volumeBackups
property of the VirtualMachineSnapshotContent
resource to verify that the expected PVCs are included in the snapshot.
Snapshot indications are contextual information about online virtual machine (VM) snapshot operations. Indications are not available for offline virtual machine (VM) snapshot operations. Indications are helpful in describing details about the online snapshot creation.
You must have attempted to create an online VM snapshot.
Display the output from the snapshot indications by performing one of the following actions:
Use the command line to view indicator output in the status
stanza of the VirtualMachineSnapshot
object YAML.
In the web console, click VirtualMachineSnapshot → Status in the Snapshot details screen.
Verify the status of your online VM snapshot by viewing the values of the status.indications
parameter:
Online
indicates that the VM was running during online snapshot creation.
GuestAgent
indicates that the QEMU guest agent was running during online snapshot creation.
NoGuestAgent
indicates that the QEMU guest agent was not running during online snapshot creation. The QEMU guest agent could not be used to freeze and thaw the file system, either because the QEMU guest agent was not installed or running or due to another error.
You can restore virtual machines (VMs) from snapshots by using the OpenShift Container Platform web console or the command line.
You can restore a virtual machine (VM) to a previous configuration represented by a snapshot in the OpenShift Container Platform web console.
Navigate to Virtualization → VirtualMachines in the web console.
Select a VM to open the VirtualMachine details page.
If the VM is running, click the options menu and select Stop to power it down.
Click the Snapshots tab to view a list of snapshots associated with the VM.
Select a snapshot to open the Snapshot Details screen.
Click the options menu and select Restore VirtualMachineSnapshot.
Click Restore.
You can restore an existing virtual machine (VM) to a previous configuration by using the command line. You can only restore from an offline VM snapshot.
Power down the VM you want to restore.
Create a YAML file to define a VirtualMachineRestore
object that specifies the name of the VM you want to restore and the name of the snapshot to be used as the source as in the following example:
apiVersion: snapshot.kubevirt.io/v1alpha1
kind: VirtualMachineRestore
metadata:
name: <vm_restore>
spec:
target:
apiGroup: kubevirt.io
kind: VirtualMachine
name: <vm_name>
virtualMachineSnapshotName: <snapshot_name>
Create the VirtualMachineRestore
object:
$ oc create -f <vm_restore>.yaml
The snapshot controller updates the status fields of the VirtualMachineRestore
object and replaces the existing VM configuration with the snapshot content.
Verify that the VM is restored to the previous state represented by the snapshot and that the complete
flag is set to true
:
$ oc get vmrestore <vm_restore>
apiVersion: snapshot.kubevirt.io/v1alpha1
kind: VirtualMachineRestore
metadata:
creationTimestamp: "2020-09-30T14:46:27Z"
generation: 5
name: my-vmrestore
namespace: default
ownerReferences:
- apiVersion: kubevirt.io/v1
blockOwnerDeletion: true
controller: true
kind: VirtualMachine
name: my-vm
uid: 355897f3-73a0-4ec4-83d3-3c2df9486f4f
resourceVersion: "5512"
selfLink: /apis/snapshot.kubevirt.io/v1alpha1/namespaces/default/virtualmachinerestores/my-vmrestore
uid: 71c679a8-136e-46b0-b9b5-f57175a6a041
spec:
target:
apiGroup: kubevirt.io
kind: VirtualMachine
name: my-vm
virtualMachineSnapshotName: my-vmsnapshot
status:
complete: true (1)
conditions:
- lastProbeTime: null
lastTransitionTime: "2020-09-30T14:46:28Z"
reason: Operation complete
status: "False" (2)
type: Progressing
- lastProbeTime: null
lastTransitionTime: "2020-09-30T14:46:28Z"
reason: Operation complete
status: "True" (3)
type: Ready
deletedDataVolumes:
- test-dv1
restoreTime: "2020-09-30T14:46:28Z"
restores:
- dataVolumeName: restore-71c679a8-136e-46b0-b9b5-f57175a6a041-datavolumedisk1
persistentVolumeClaim: restore-71c679a8-136e-46b0-b9b5-f57175a6a041-datavolumedisk1
volumeName: datavolumedisk1
volumeSnapshotName: vmsnapshot-28eedf08-5d6a-42c1-969c-2eda58e2a78d-volume-datavolumedisk1
1 | Specifies if the process of restoring the VM to the state represented by the snapshot is complete. |
2 | The status field of the Progressing condition specifies if the VM is still being restored. |
3 | The status field of the Ready condition specifies if the VM restoration process is complete. |
You can delete snapshots of virtual machines (VMs) by using the OpenShift Container Platform web console or the command line.
You can delete an existing virtual machine (VM) snapshot by using the web console.
Navigate to Virtualization → VirtualMachines in the web console.
Select a VM to open the VirtualMachine details page.
Click the Snapshots tab to view a list of snapshots associated with the VM.
Click the options menu beside a snapshot and select Delete VirtualMachineSnapshot.
Click Delete.
You can delete an existing virtual machine (VM) snapshot by deleting the appropriate VirtualMachineSnapshot
object.
Install the OpenShift CLI (oc
).
Delete the VirtualMachineSnapshot
object:
$ oc delete vmsnapshot <snapshot_name>
The snapshot controller deletes the VirtualMachineSnapshot
along with the associated VirtualMachineSnapshotContent
object.
Verify that the snapshot is deleted and no longer attached to this VM:
$ oc get vmsnapshot