Skip to content

Commit 1bf23f4

Browse files
author
Shikha Jhala
committed
CNV-7494 Documented interface for offline VM snapshots
1 parent 5b3bfd3 commit 1bf23f4

File tree

4 files changed

+98
-0
lines changed

4 files changed

+98
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc
4+
5+
[id="virt-creating-offline-vm-snapshot-web_{context}"]
6+
= Creating an offline virtual machine snapshot in the web console
7+
8+
You can create a virtual machine (VM) snapshot by using the web console.
9+
10+
[NOTE]
11+
====
12+
The VM snapshot only includes disks that meet the following requirements:
13+
14+
* Must be either a data volume or persistent volume claim
15+
* Belong to a storage class that supports Container Storage Interface (CSI) volume snapshots
16+
17+
If your VM storage includes disks that do not support snapshots, you can either edit them or contact your cluster administrator.
18+
====
19+
20+
.Procedure
21+
22+
. Click *Workloads* → *Virtualization* from the side menu.
23+
24+
. Click the *Virtual Machines* tab.
25+
26+
. Select a virtual machine to open the *Virtual Machine Overview* screen.
27+
28+
. If the virtual machine is running, click *Actions* → *Stop Virtual Machine* to power it down.
29+
30+
. Click the *Snapshots* tab and then click *Take Snapshot*.
31+
32+
. Fill in the *Snapshot Name* and optional *Description* fields.
33+
34+
. Expand *Disks included in this Snapshot* to see the storage volumes to be included in the snapshot.
35+
36+
. If your VM has disks that cannot be included in the snapshot and you still wish to proceed, select the *I am aware of this warning and wish to proceed* checkbox.
37+
38+
. Click *Save*.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc
4+
5+
[id="virt-deleting-vm-snapshot-web_{context}"]
6+
= Deleting a virtual machine snapshot in the web console
7+
8+
You can delete an existing virtual machine snapshot by using the web console.
9+
10+
.Procedure
11+
12+
. Click *Workloads* → *Virtualization* from the side menu.
13+
14+
. Click the *Virtual Machines* tab.
15+
16+
. Select a virtual machine to open the *Virtual Machine Overview* screen.
17+
18+
. Click the *Snapshots* tab. The page displays a list of snapshots associated with the virtual machine.
19+
20+
. Choose one of the following methods to delete a virtual machine snapshot:
21+
22+
.. Click the Options menu {kebab} of the virtual machine snapshot that you want to delete and select *Delete Virtual Machine Snapshot*.
23+
24+
.. Select a snapshot to open the *Snapshot Details* screen and click *Actions* → *Delete Virtual Machine Snapshot*.
25+
26+
. In the confirmation pop-up window, click *Delete* to delete the snapshot.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc
4+
5+
[id="virt-restoring-vm-from-snapshot-web_{context}"]
6+
= Restoring a virtual machine from a snapshot in the web console
7+
8+
You can restore a virtual machine (VM) to a previous configuration represented by a snapshot in the web console.
9+
10+
.Procedure
11+
12+
. Click *Workloads* → *Virtualization* from the side menu.
13+
14+
. Click the *Virtual Machines* tab.
15+
16+
. Select a virtual machine to open the *Virtual Machine Overview* screen.
17+
18+
. If the virtual machine is running, click *Actions* → *Stop Virtual Machine* to power it down.
19+
20+
. Click the *Snapshots* tab. The page displays a list of snapshots associated with the virtual machine.
21+
22+
. Choose one of the following methods to restore a VM snapshot:
23+
24+
.. For the snapshot that you want to use as the source to restore the VM, click *Restore*.
25+
26+
.. Select a snapshot to open the *Snapshot Details* screen and click *Actions* → *Restore Virtual Machine Snapshot*.
27+
28+
. In the confirmation pop-up window, click *Restore* to restore the VM to its previous configuration represented by the snapshot.

virt/virtual_machines/virtual_disks/virt-managing-offline-vm-snapshots.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,16 @@ offline VM snapshots on:
1212

1313
include::modules/virt-about-vm-snapshots.adoc[leveloffset=+1]
1414

15+
include::modules/virt-creating-offline-vm-snapshot-web.adoc[leveloffset=+1]
16+
1517
include::modules/virt-creating-offline-vm-snapshot-cli.adoc[leveloffset=+1]
1618

19+
include::modules/virt-restoring-vm-from-snapshot-web.adoc[leveloffset=+1]
20+
1721
include::modules/virt-restoring-vm-from-snapshot-cli.adoc[leveloffset=+1]
1822

23+
include::modules/virt-deleting-vm-snapshot-web.adoc[leveloffset=+1]
24+
1925
include::modules/virt-deleting-vm-snapshot-cli.adoc[leveloffset=+1]
2026

2127
== Additional resources

0 commit comments

Comments
 (0)