Skip to content

Commit 65efdcb

Browse files
committed
fix docs
Signed-off-by: Daniil Antoshin <[email protected]>
1 parent bf73c87 commit 65efdcb

File tree

2 files changed

+115
-56
lines changed

2 files changed

+115
-56
lines changed

docs/USER_GUIDE.md

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1389,62 +1389,6 @@ How to perform the operation in the web interface:
13891389
- Select the desired virtual machine from the list and click the ellipsis button.
13901390
- In the pop-up menu, you can select possible operations for the VM.
13911391

1392-
### VMOP Restore Operations
1393-
1394-
The `VirtualMachineOperation` with `type: Restore` provides advanced restore capabilities beyond the basic `VirtualMachineRestore` resource, offering real-time monitoring and enhanced control during restore operations.
1395-
1396-
#### Basic Restore Operation
1397-
1398-
```yaml
1399-
apiVersion: virtualization.deckhouse.io/v1alpha2
1400-
kind: VirtualMachineOperation
1401-
metadata:
1402-
generateName: restore-linux-vm-
1403-
spec:
1404-
virtualMachineName: linux-vm
1405-
type: Restore
1406-
restoreSpec:
1407-
virtualMachineSnapshotName: linux-vm-snapshot
1408-
restoreMode: Strict
1409-
```
1410-
1411-
#### Restore Modes
1412-
1413-
**Strict Mode** (default) - Ensures complete validation and consistency:
1414-
- All referenced resources must exist
1415-
- Operation fails if any dependency is missing
1416-
- VM is automatically placed in maintenance mode during restore
1417-
- Use for production environments
1418-
1419-
**BestEffort Mode** - Provides flexible restore with graceful degradation:
1420-
- Skips missing non-critical resources
1421-
- Continues restore even with missing dependencies
1422-
- Higher success rate in complex environments
1423-
- Use for development/testing environments
1424-
1425-
```yaml
1426-
spec:
1427-
type: Restore
1428-
restoreSpec:
1429-
restoreMode: BestEffort
1430-
virtualMachineSnapshotName: my-vm-snapshot
1431-
```
1432-
1433-
#### Monitoring Restore Progress
1434-
1435-
```bash
1436-
# Check operation status
1437-
kubectl get vmop
1438-
1439-
# View detailed progress
1440-
kubectl describe vmop restore-linux-vm-abc123
1441-
```
1442-
1443-
Operations progress through phases: `Pending` → `InProgress` → `Completed`/`Failed`.
1444-
1445-
{{< alert level="info" >}}
1446-
During VMOP Restore operations, the target VM is automatically placed in maintenance mode to ensure safe restore operations. The maintenance mode is automatically removed when the operation completes.
1447-
{{< /alert >}}
14481392

14491393
### Change virtual machine configuration
14501394

@@ -2815,3 +2759,60 @@ d8 k vm get <vmname> -o json | jq ‘.status.conditions’
28152759
```
28162760

28172761
Check the output for errors related to missing or changed resources. Manually update the VM configuration to remove dependencies that are no longer available in the cluster.
2762+
2763+
### Vitrual Machine Restore Operations
2764+
2765+
The `VirtualMachineOperation` with `type: Restore` provides advanced restore capabilities beyond the basic `VirtualMachineRestore` resource, offering real-time monitoring and enhanced control during restore operations.
2766+
2767+
#### Basic Restore Operation
2768+
2769+
```yaml
2770+
apiVersion: virtualization.deckhouse.io/v1alpha2
2771+
kind: VirtualMachineOperation
2772+
metadata:
2773+
generateName: restore-linux-vm-
2774+
spec:
2775+
virtualMachineName: linux-vm
2776+
type: Restore
2777+
restoreSpec:
2778+
virtualMachineSnapshotName: linux-vm-snapshot
2779+
restoreMode: Strict
2780+
```
2781+
2782+
#### Restore Modes
2783+
2784+
**Strict Mode** (default) - Ensures complete validation and consistency:
2785+
- All referenced resources must exist
2786+
- Operation fails if any dependency is missing
2787+
- VM is automatically placed in maintenance mode during restore
2788+
- Use for production environments
2789+
2790+
**BestEffort Mode** - Provides flexible restore with graceful degradation:
2791+
- Skips missing non-critical resources
2792+
- Continues restore even with missing dependencies
2793+
- Higher success rate in complex environments
2794+
- Use for development/testing environments
2795+
2796+
```yaml
2797+
spec:
2798+
type: Restore
2799+
restoreSpec:
2800+
restoreMode: BestEffort
2801+
virtualMachineSnapshotName: my-vm-snapshot
2802+
```
2803+
2804+
#### Monitoring Restore Progress
2805+
2806+
```bash
2807+
# Check operation status
2808+
kubectl get vmop
2809+
2810+
# View detailed progress
2811+
kubectl describe vmop restore-linux-vm-abc123
2812+
```
2813+
2814+
Operations progress through phases: `Pending` → `InProgress` → `Completed`/`Failed`.
2815+
2816+
{{< alert level="info" >}}
2817+
During VMOP Restore operations, the target VM is automatically placed in maintenance mode to ensure safe restore operations. The maintenance mode is automatically removed when the operation completes.
2818+
{{< /alert >}}

docs/USER_GUIDE.ru.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2790,3 +2790,61 @@ d8 k vm get <vmname> -o json | jq '.status.conditions'
27902790
```
27912791

27922792
Проверьте вывод на наличие ошибок, связанных с отсутствующими или изменёнными ресурсами. Вручную обновите конфигурацию ВМ, чтобы устранить зависимости, которые больше не доступны в кластере.
2793+
2794+
### Virtual Machine Restore Operations
2795+
2796+
The `VirtualMachineOperation` with `type: Restore` provides advanced restore capabilities beyond the basic `VirtualMachineRestore` resource, offering real-time monitoring and enhanced control during restore operations.
2797+
2798+
#### Basic Restore Operation
2799+
2800+
```yaml
2801+
apiVersion: virtualization.deckhouse.io/v1alpha2
2802+
kind: VirtualMachineOperation
2803+
metadata:
2804+
generateName: restore-linux-vm-
2805+
spec:
2806+
virtualMachineName: linux-vm
2807+
type: Restore
2808+
restoreSpec:
2809+
virtualMachineSnapshotName: linux-vm-snapshot
2810+
restoreMode: Strict
2811+
```
2812+
2813+
#### Restore Modes
2814+
2815+
**Strict Mode** (default) - Ensures complete validation and consistency:
2816+
- All referenced resources must exist
2817+
- Operation fails if any dependency is missing
2818+
- VM is automatically placed in maintenance mode during restore
2819+
- Use for production environments
2820+
2821+
**BestEffort Mode** - Provides flexible restore with graceful degradation:
2822+
- Skips missing non-critical resources
2823+
- Continues restore even with missing dependencies
2824+
- Higher success rate in complex environments
2825+
- Use for development/testing environments
2826+
2827+
```yaml
2828+
spec:
2829+
type: Restore
2830+
restoreSpec:
2831+
restoreMode: BestEffort
2832+
virtualMachineSnapshotName: my-vm-snapshot
2833+
```
2834+
2835+
#### Monitoring Restore Progress
2836+
2837+
```bash
2838+
# Check operation status
2839+
kubectl get vmop
2840+
2841+
# View detailed progress
2842+
kubectl describe vmop restore-linux-vm-abc123
2843+
```
2844+
2845+
Operations progress through phases: `Pending` → `InProgress` → `Completed`/`Failed`.
2846+
2847+
{{< alert level="info" >}}
2848+
During VMOP Restore operations, the target VM is automatically placed in maintenance mode to ensure safe restore operations. The maintenance mode is automatically removed when the operation completes.
2849+
{{< /alert >}}
2850+

0 commit comments

Comments
 (0)