Skip to content

Commit b5fdfc1

Browse files
fl64Roman Sysoev
andauthored
docs: update due v0.23.0 (#1204)
update docs due v0.23.0 --------- Signed-off-by: Pavel Tishkov <[email protected]> Signed-off-by: Roman Sysoev <[email protected]> Co-authored-by: Roman Sysoev <[email protected]>
1 parent 2bc1d90 commit b5fdfc1

File tree

2 files changed

+146
-110
lines changed

2 files changed

+146
-110
lines changed

docs/USER_GUIDE.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2312,17 +2312,31 @@ The `VirtualMachineRestore` resource is used to restore a virtual machine from a
23122312
- VirtualMachine - the main VM resource with the configuration from the snapshot.
23132313
- VirtualDisk - disks connected to the VM at the moment of snapshot creation.
23142314
- VirtualBlockDeviceAttachment - disk connections to the VM (if they existed in the original configuration).
2315+
- VirtualMachineIPAddress — the IP address of the virtual machine (if the `keepIPAddress: Always` parameter was specified at the time of snapshot creation).
23152316
- Secret - secrets with cloud-init or sysprep settings (if they were involved in the original VM).
23162317
23172318
Important: resources are created only if they were present in the VM configuration at the time the snapshot was created. This ensures that an exact copy of the environment is restored, including all dependencies and settings.
23182319
23192320
#### Restore a virtual machine
23202321
2322+
There are two modes used for restoring a virtual machine. They are defined by the restoreMode parameter of the VirtualMachineRestore resource:
2323+
```yaml
2324+
spec:
2325+
restoreMode: Safe | Forced
2326+
```
2327+
`Safe` is used by default.
2328+
23212329
{{< alert level="warning">}}
2322-
To restore a virtual machine, you must delete its current configuration and all associated disks. This is because the restore process returns the virtual machine and its disks to the state that was fixed at the time the backup snapshot was created.
2330+
To restore a virtual machine in `Safe` mode, you must delete its current configuration and all associated disks. This is because the restoration process returns the virtual machine and its disks to the state recorded at the snapshot's creation time.
23232331
{{< /alert >}}
23242332
2325-
Example manifest for restoring a virtual machine from a snapshot:
2333+
The `Forced` mode is used to bring an already existing virtual machine to the state at the time of the snapshot.
2334+
2335+
{{< alert level="warning" >}}
2336+
`Forced` may disrupt the operation of the existing virtual machine because it will be stopped during restoration, and `VirtualDisks` and `VirtualMachineBlockDeviceAttachments` resources will be deleted for subsequent restoration.
2337+
{{< /alert >}}
2338+
2339+
Example manifest for restoring a virtual machine from a snapshot in `Safe` mode:
23262340
23272341
```yaml
23282342
d8 k apply -f - <<EOF
@@ -2331,6 +2345,7 @@ kind: VirtualMachineRestore
23312345
metadata:
23322346
name: <restore name>
23332347
spec:
2348+
restoreMode: Safe
23342349
virtualMachineSnapshotName: <virtual machine snapshot name>
23352350
EOF
23362351
```

0 commit comments

Comments
 (0)