Skip to content

fix(vmsnapshot): fix creating snapshot from vm with awaiting restart changes #1477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2025
Merged

fix(vmsnapshot): fix creating snapshot from vm with awaiting restart changes #1477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions api/core/v1alpha2/vmscondition/condition.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ const (

// WaitingForTheVirtualMachine signifies that the snapshot process is waiting for the virtual machine to become ready for snapshotting.
WaitingForTheVirtualMachine VirtualMachineSnapshotReadyReason = "WaitingForTheVirtualMachine"
// RestartAwaitingChanges signifies that the snapshotting process cannot begin because the virtual machine has awaiting changes.
RestartAwaitingChanges VirtualMachineSnapshotReadyReason = "RestartAwaitingChanges"
// BlockDevicesNotReady signifies that the snapshotting process cannot begin because the block devices of the virtual machine are not ready.
BlockDevicesNotReady VirtualMachineSnapshotReadyReason = "BlockDevicesNotReady"
// PotentiallyInconsistent signifies that the snapshotting process cannot begin because creating a snapshot of the running virtual machine might result in an inconsistent snapshot.
Expand Down
35 changes: 8 additions & 27 deletions images/virtualization-artifact/pkg/controller/vmsnapshot/internal/life_cycle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,25 +190,6 @@ func (h LifeCycleHandler) Handle(ctx context.Context, vmSnapshot *virtv2.Virtual
return reconcile.Result{}, err
}

// 2. Ensure there are no RestartAwaitingChanges.
if len(vm.Status.RestartAwaitingChanges) > 0 {
vmSnapshot.Status.Phase = virtv2.VirtualMachineSnapshotPhasePending
msg := fmt.Sprintf(
"Waiting for the restart and approval of changes to virtual machine %q before taking the snapshot.",
vm.Name,
)
h.recorder.Event(
vmSnapshot,
corev1.EventTypeNormal,
virtv2.ReasonVMSnapshottingPending,
msg,
)
cb.
Status(metav1.ConditionFalse).
Reason(vmscondition.RestartAwaitingChanges).Message(msg)
return reconcile.Result{}, nil
}

needToFreeze := h.needToFreeze(vm, vmSnapshot.Spec.RequiredConsistency)

isAwaitingConsistency := needToFreeze && !h.snapshotter.CanFreeze(vm) && vmSnapshot.Spec.RequiredConsistency
Expand Down Expand Up @@ -260,7 +241,7 @@ func (h LifeCycleHandler) Handle(ctx context.Context, vmSnapshot *virtv2.Virtual

var hasFrozen bool

// 3. Ensure the virtual machine is consistent for snapshotting.
// 2. Ensure the virtual machine is consistent for snapshotting.
if needToFreeze {
hasFrozen, err = h.freezeVirtualMachine(ctx, vm, vmSnapshot)
if err != nil {
Expand All @@ -278,17 +259,17 @@ func (h LifeCycleHandler) Handle(ctx context.Context, vmSnapshot *virtv2.Virtual
return reconcile.Result{}, nil
}

// 4. Create secret.
// 3. Create secret.
err = h.ensureSecret(ctx, vm, vmSnapshot)
if err != nil {
h.setPhaseConditionToFailed(cb, vmSnapshot, err)
return reconcile.Result{}, err
}

// 5. Fill status.VirtualDiskSnapshotNames.
// 4. Fill status.VirtualDiskSnapshotNames.
h.fillStatusVirtualDiskSnapshotNames(vmSnapshot, vm)

// 6. Get or Create VirtualDiskSnapshots.
// 5. Get or Create VirtualDiskSnapshots.
vdSnapshots, err := h.ensureVirtualDiskSnapshots(ctx, vmSnapshot)
switch {
case err == nil:
Expand All @@ -314,7 +295,7 @@ func (h LifeCycleHandler) Handle(ctx context.Context, vmSnapshot *virtv2.Virtual
return reconcile.Result{}, err
}

// 7. Wait for VirtualDiskSnapshots to be Ready.
// 6. Wait for VirtualDiskSnapshots to be Ready.
readyCount := h.countReadyVirtualDiskSnapshots(vdSnapshots)
msg := fmt.Sprintf(
"Waiting for the virtual disk snapshots to be taken for "+
Expand Down Expand Up @@ -351,21 +332,21 @@ func (h LifeCycleHandler) Handle(ctx context.Context, vmSnapshot *virtv2.Virtual
vmSnapshot.Status.Consistent = nil
}

// 8. Unfreeze VirtualMachine if can.
// 7. Unfreeze VirtualMachine if can.
unfrozen, err := h.unfreezeVirtualMachineIfCan(ctx, vmSnapshot, vm)
if err != nil {
h.setPhaseConditionToFailed(cb, vmSnapshot, err)
return reconcile.Result{}, err
}

// 9. Fill status resources.
// 8. Fill status resources.
err = h.fillStatusResources(ctx, vmSnapshot, vm)
if err != nil {
h.setPhaseConditionToFailed(cb, vmSnapshot, err)
return reconcile.Result{}, err
}

// 10. Move to Ready phase.
// 9. Move to Ready phase.
log.Debug("The virtual disk snapshots are taken: the virtual machine snapshot is Ready now", "unfrozen", unfrozen)

vmSnapshot.Status.Phase = virtv2.VirtualMachineSnapshotPhaseReady
Expand Down
6 changes: 3 additions & 3 deletions images/virtualization-artifact/pkg/controller/vmsnapshot/internal/life_cycle_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,11 @@ var _ = Describe("LifeCycle handler", func() {

_, err := h.Handle(testContext(), vmSnapshot)
Expect(err).To(BeNil())
Expect(vmSnapshot.Status.Phase).To(Equal(virtv2.VirtualMachineSnapshotPhasePending))
Expect(vmSnapshot.Status.Phase).To(Equal(virtv2.VirtualMachineSnapshotPhaseInProgress))
ready, _ := conditions.GetCondition(vmscondition.VirtualMachineSnapshotReadyType, vmSnapshot.Status.Conditions)
Expect(ready.Status).To(Equal(metav1.ConditionFalse))
Expect(ready.Reason).To(Equal(vmscondition.RestartAwaitingChanges.String()))
Expect(ready.Message).ToNot(BeEmpty())
Expect(ready.Reason).To(Equal(vmscondition.FileSystemFreezing.String()))
Expect(ready.Message).To(Equal("The snapshotting process has started."))
})

It("The virtual machine is potentially inconsistent", func() {
Expand Down
Loading