Cancel value in request

Signed-off-by: Joseph <[email protected]>

Author: Joeavaikath

design/backup_cancellation.md

@@ -46,6 +46,23 @@
 - The existing `backup_finalizer_controller` will handle cancelled backups by cleaning up backup data while preserving logs, then transitioning to `BackupPhaseFailed`
 
 
+- Extend the backup request struct to include:
+    - `Cancel` (bool): reflects whether cancellation has been requested.
+    - `LastCancelCheck` (timestamp): records the last time cancellation status was checked.
+
+- Cancellation check logic:
+    1. If `LastCancelCheck` is zero, set it to the current time and continue as usual.
+    2. If more than a configured interval (e.g., 1–3 seconds) has passed since `LastCancelCheck`:
+        - Update `LastCancelCheck` to now.
+        - Retrieve the latest backup object from the API.
+        - Set `request.Cancel` to the current value of `backup.Spec.Cancel`.
+    3. Always use the current value of `request.Cancel` to determine if cancellation is requested.
+
+- If backup processing is concurrent (multi-threaded), protect access to `request.Cancel` and `LastCancelCheck` with read/write mutexes to avoid race conditions.
+    
+     
+
+
 ## Detailed Design
 
 ### API Changes

pkg/backup/backup.go

@@ -89,6 +89,15 @@ type Backupper interface {
 		volumeSnapshotterGetter VolumeSnapshotterGetter,
 	) error
 
+	// BackupWithResolvers performs the core Kubernetes backup operation, creating a gzipped tar archive
+	// of selected cluster resources with plugin transformations applied.
+	//
+	// It discovers resources based on the backup spec, applies BackupItemAction and ItemBlockAction
+	// plugins, handles volume snapshots, executes backup hooks, and writes everything to a compressed
+	// tar archive. Accepts pre-resolved plugin actions for efficiency.
+	//
+	// Returns an error only for complete backup failures. Individual resource failures are logged
+	// but don't stop the backup process.
 	BackupWithResolvers(
 		log logrus.FieldLogger,
 		backupRequest *Request,
@@ -98,6 +107,13 @@ type Backupper interface {
 		volumeSnapshotterGetter VolumeSnapshotterGetter,
 	) error
 
+	// FinalizeBackup completes the backup process by updating resources that were modified
+	// during async operations and creating the final backup archive.
+	//
+	// It reads the original backup archive, collects resources specified in PostOperationItems
+	// from completed async operations, re-backs up those resources with their updated state,
+	// and writes a new archive with the updated content. This ensures the backup contains
+	// the final state of resources after async operations (like volume snapshots) complete.
 	FinalizeBackup(
 		log logrus.FieldLogger,
 		backupRequest *Request,

pkg/controller/backup_finalizer_controller.go

@@ -87,11 +87,12 @@ func NewBackupFinalizerReconciler(
 // +kubebuilder:rbac:groups=velero.io,resources=backups/status,verbs=get;update;patch
 
 func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	
+	// LOG
 	log := r.log.WithFields(logrus.Fields{
 		"controller": "backup-finalizer",
 		"backup":     req.NamespacedName,
 	})
-
 	// Fetch the Backup instance.
 	log.Debug("Getting Backup")
 	backup := &velerov1api.Backup{}
@@ -105,6 +106,7 @@ func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 		return ctrl.Result{}, errors.WithStack(err)
 	}
 
+	// Check phase, only process if phase matches
 	switch backup.Status.Phase {
 	case velerov1api.BackupPhaseFinalizing, velerov1api.BackupPhaseFinalizingPartiallyFailed:
 		// only process backups finalizing after  plugin operations are complete
@@ -113,6 +115,7 @@ func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 		return ctrl.Result{}, nil
 	}
 
+	// Defer func to patch backup object and status after each reconciliation
 	original := backup.DeepCopy()
 	defer func() {
 		switch backup.Status.Phase {
@@ -133,7 +136,9 @@ func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 			return
 		}
 	}()
-
+	
+	// Get the operations associated with the backup
+	// BackupLocation -> backupStore -> backupItemOperations
 	location := &velerov1api.BackupStorageLocation{}
 	if err := r.client.Get(ctx, kbclient.ObjectKey{
 		Namespace: backup.Namespace,
@@ -163,8 +168,11 @@ func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 		SkippedPVTracker: pkgbackup.NewSkipPVTracker(),
 		BackedUpItems:    pkgbackup.NewBackedUpItemsMap(),
 	}
+
 	var outBackupFile *os.File
 	if len(operations) > 0 {
+
+		// File inits
 		log.Info("Setting up finalized backup temp file")
 		inBackupFile, err := downloadToTempFile(backup.Name, backupStore, log)
 		if err != nil {
@@ -178,6 +186,7 @@ func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 		}
 		defer closeAndRemoveFile(outBackupFile, log)
 
+		// Get all possible plugin actions
 		log.Info("Getting backup item actions")
 		actions, err := pluginManager.GetBackupItemActionsV2()
 		if err != nil {
@@ -201,6 +210,8 @@ func (r *backupFinalizerReconciler) Reconcile(ctx context.Context, req ctrl.Requ
 			return ctrl.Result{}, errors.WithStack(err)
 		}
 	}
+
+	
 	backupScheduleName := backupRequest.GetLabels()[velerov1api.ScheduleNameLabel]
 	switch backup.Status.Phase {
 	case velerov1api.BackupPhaseFinalizing: