feat(core): add VMOP restore

Signed-off-by: Daniil Antoshin <[email protected]>

Author: danilrwx

api/core/v1alpha2/events.go

@@ -40,6 +40,9 @@ const (
 	// ReasonVMStartFailed is an event reason indicating that the start of the VM failed.
 	ReasonVMStartFailed = "Failed"
 
+	// ReasonVMStopFailed is an event reason indicating that the stop of the VM failed.
+	ReasonVMStopFailed = "Failed"
+
 	// ReasonVMLastAppliedSpecIsInvalid is event reason that JSON in last-applied-spec annotation is invalid.
 	ReasonVMLastAppliedSpecIsInvalid = "LastAppliedSpecIsInvalid"
 

api/core/v1alpha2/virtual_machine_operation.go

@@ -45,6 +45,7 @@ type VirtualMachineOperation struct {
 // +kubebuilder:validation:XValidation:rule="self == oldSelf",message=".spec is immutable"
 // +kubebuilder:validation:XValidation:rule="self.type == 'Start' ? !has(self.force) || !self.force : true",message="The `Start` operation cannot be performed forcibly."
 // +kubebuilder:validation:XValidation:rule="self.type == 'Migrate' ? !has(self.force) || !self.force : true",message="The `Migrate` operation cannot be performed forcibly."
+// +kubebuilder:validation:XValidation:rule="self.type == 'Restore' ? has(self.restore) : true",message="Restore requires restore field."
 type VirtualMachineOperationSpec struct {
 	Type VMOPType `json:"type"`
 	// Name of the virtual machine the operation is performed for.
@@ -54,14 +55,77 @@ type VirtualMachineOperationSpec struct {
 	// * Effect on `Restart` and `Stop`: operation performs immediately.
 	// * Effect on `Evict` and `Migrate`: enable the AutoConverge feature to force migration via CPU throttling if the `PreferSafe` or `PreferForced` policies are used for live migration.
 	Force *bool `json:"force,omitempty"`
+	// Restore defines the restore operation.
+	Restore *VirtualMachineOperationRestoreSpec `json:"restore,omitempty"`
 }
 
+// VirtualMachineOperationRestoreSpec defines the restore operation.
+type VirtualMachineOperationRestoreSpec struct {
+	Mode VMOPRestoreMode `json:"mode"`
+	// VirtualMachineSnapshotName defines the source of the restore operation.
+	VirtualMachineSnapshotName string `json:"virtualMachineSnapshotName"`
+}
+
+// VMOPRestoreMode defines the kind of the restore operation.
+// * `DryRun`: DryRun run without any changes. Compatibility shows in status.
+// * `Strict`: Strict restore as is in the snapshot.
+// * `BestEffort`: BestEffort restore without deleted external missing dependencies.
+// +kubebuilder:validation:Enum={DryRun,Strict,BestEffort}
+type VMOPRestoreMode string
+
+const (
+	VMOPRestoreModeDryRun     VMOPRestoreMode = "DryRun"
+	VMOPRestoreModeStrict     VMOPRestoreMode = "Strict"
+	VMOPRestoreModeBestEffort VMOPRestoreMode = "BestEffort"
+)
+
 type VirtualMachineOperationStatus struct {
 	Phase VMOPPhase `json:"phase"`
 	// The latest detailed observations of the VirtualMachineOperation resource.
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 	//  Resource generation last processed by the controller.
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
+	// Resources contains the list of resources that are affected by the snapshot operation.
+	Resources []VirtualMachineOperationResource `json:"resources,omitempty"`
+}
+
+// VMOPResourceKind defines the kind of the resource affected by the operation.
+// * `VirtualDisk`: VirtualDisk resource.
+// * `VirtualMachine`: VirtualMachine resource.
+// * `VirtualImage`: VirtualImage resource.
+// * `ClusterVirtualImage`: ClusterVirtualImage resource.
+// * `VirtualMachineIPAddress`: VirtualMachineIPAddress resource.
+// * `VirtualMachineIPAddressLease`: VirtualMachineIPAddressLease resource.
+// * `VirtualMachineClass`: VirtualMachineClass resource.
+// * `VirtualMachineOperation`: VirtualMachineOperation resource.
+// +kubebuilder:validation:Enum={VMOPResourceSecret,VMOPResourceNetwork,VMOPResourceVirtualDisk,VMOPResourceVirtualImage,VMOPResourceVirtualMachine,VMOPResourceClusterNetwork,VMOPResourceClusterVirtualImage,VMOPResourceVirtualMachineIPAddress,VMOPResourceVirtualMachineMacAddress,VMOPResourceVirtualMachineBlockDeviceAttachment}
+type VMOPResourceKind string
+
+const (
+	VMOPResourceSecret                              VMOPResourceKind = "Secret"
+	VMOPResourceNetwork                             VMOPResourceKind = "Network"
+	VMOPResourceVirtualDisk                         VMOPResourceKind = "VirtualDisk"
+	VMOPResourceVirtualImage                        VMOPResourceKind = "VirtualImage"
+	VMOPResourceVirtualMachine                      VMOPResourceKind = "VirtualMachine"
+	VMOPResourceClusterNetwork                      VMOPResourceKind = "ClusterNetwork"
+	VMOPResourceClusterVirtualImage                 VMOPResourceKind = "ClusterVirtualImage"
+	VMOPResourceVirtualMachineIPAddress             VMOPResourceKind = "VirtualMachineIPAddress"
+	VMOPResourceVirtualMachineMacAddress            VMOPResourceKind = "VirtualMachineMacAddress"
+	VMOPResourceVirtualMachineBlockDeviceAttachment VMOPResourceKind = "VirtualMachineBlockDeviceAttachment"
+)
+
+// VirtualMachineOperationResource defines the resource affected by the operation.
+type VirtualMachineOperationResource struct {
+	// API version of the resource.
+	APIVersion string `json:"apiVersion"`
+	// Name of the resource.
+	Name string `json:"name"`
+	// Kind of the resource.
+	Kind string `json:"kind"`
+	// Status of the resource.
+	Status string `json:"status"`
+	// Message about the resource.
+	Message string `json:"message"`
 }
 
 // VirtualMachineOperationList contains a list of VirtualMachineOperation resources.
@@ -95,7 +159,8 @@ const (
 // * `Restart`: Restart the virtual machine.
 // * `Migrate` (deprecated): Migrate the virtual machine to another node where it can be started.
 // * `Evict`: Migrate the virtual machine to another node where it can be started.
-// +kubebuilder:validation:Enum={Restart,Start,Stop,Migrate,Evict}
+// * `Restore`: Restore the virtual machine from a snapshot.
+// +kubebuilder:validation:Enum={Restart,Start,Stop,Migrate,Evict,Restore}
 type VMOPType string
 
 const (
@@ -104,4 +169,5 @@ const (
 	VMOPTypeStop    VMOPType = "Stop"
 	VMOPTypeMigrate VMOPType = "Migrate"
 	VMOPTypeEvict   VMOPType = "Evict"
+	VMOPTypeRestore VMOPType = "Restore"
 )

api/core/v1alpha2/vmopcondition/condition.go

@@ -28,6 +28,12 @@ const (
 
 	// TypeSignalSent is a type for condition that indicates operation signal has been sent.
 	TypeSignalSent Type = "SignalSent"
+
+	// TypeRestoreCompleted is a type for condition that indicates success of restore.
+	TypeRestoreCompleted Type = "RestoreCompleted"
+
+	// TypeMaintenanceMode is a type for condition that indicates VMOP has put VM in maintenance mode.
+	TypeMaintenanceMode Type = "MaintenanceMode"
 )
 
 // ReasonCompleted represents specific reasons for the 'Completed' condition type.
@@ -62,6 +68,9 @@ const (
 	// ReasonStopInProgress is a ReasonCompleted indicating that the stop signal has been sent and stop is in progress.
 	ReasonStopInProgress ReasonCompleted = "StopInProgress"
 
+	// ReasonRestoreInProgress is a ReasonCompleted indicating that the restore operation is in progress.
+	ReasonRestoreInProgress ReasonCompleted = "RestoreInProgress"
+
 	// ReasonMigrationPending is a ReasonCompleted indicating that the migration process has been initiated but not yet started.
 	ReasonMigrationPending ReasonCompleted = "MigrationPending"
 
@@ -87,6 +96,27 @@ const (
 	ReasonOperationCompleted ReasonCompleted = "OperationCompleted"
 )
 
+// ReasonRestoreCompleted represents specific reasons for the 'RestoreCompleted' condition type.
+type ReasonRestoreCompleted string
+
+func (r ReasonRestoreCompleted) String() string {
+	return string(r)
+}
+
+const (
+	// ReasonRestoreInProgress is a ReasonRestoreCompleted indicating that the restore operation is in progress.
+	ReasonRestoreOperationInProgress ReasonRestoreCompleted = "RestoreInProgress"
+
+	// ReasonRestoreOperationCompleted is a ReasonRestoreCompleted indicating that the restore operation has completed successfully.
+	ReasonRestoreOperationCompleted ReasonRestoreCompleted = "RestoreCompleted"
+
+	// ReasonDryRunOperationCompleted is a ReasonRestoreCompleted indicating that the restore dry run operation has completed successfully.
+	ReasonDryRunOperationCompleted ReasonRestoreCompleted = "RestoreDryRunCompleted"
+
+	// ReasonRestoreOperationFailed is a ReasonRestoreCompleted indicating that operation has failed.
+	ReasonRestoreOperationFailed ReasonRestoreCompleted = "RestoreFailed"
+)
+
 // ReasonCompleted represents specific reasons for the 'SignalSent' condition type.
 type ReasonSignalSent string
 
@@ -101,3 +131,21 @@ const (
 	// ReasonSignalSentSuccess is a ReasonCompleted indicating that signal is sent to the VM.
 	ReasonSignalSentSuccess ReasonSignalSent = "SignalSentSuccess"
 )
+
+// ReasonMaintenanceMode represents specific reasons for the 'MaintenanceMode' condition type.
+type ReasonMaintenanceMode string
+
+func (r ReasonMaintenanceMode) String() string {
+	return string(r)
+}
+
+const (
+	// ReasonMaintenanceModeEnabled is a ReasonMaintenanceMode indicating that VM is in maintenance mode for restore operation.
+	ReasonMaintenanceModeEnabled ReasonMaintenanceMode = "MaintenanceModeEnabled"
+
+	// ReasonMaintenanceModeDisabled is a ReasonMaintenanceMode indicating that VM has exited maintenance mode.
+	ReasonMaintenanceModeDisabled ReasonMaintenanceMode = "MaintenanceModeDisabled"
+
+	// ReasonMaintenanceModeFailure is a ReasonMaintenanceMode indicating that maintenance mode operation failed.
+	ReasonMaintenanceModeFailure ReasonMaintenanceMode = "MaintenanceModeFailure"
+)