automatically convert from 2.2 to 2.3 finalizers (#163)

Author: dgrove-oss

internal/controller/appwrapper_controller.go

@@ -46,14 +46,15 @@ type AppWrapperReconciler struct {
 }
 
 const (
-	nameLabel            = "appwrapper.mcad.ibm.com"                  // owner name label for wrapped resources
-	namespaceLabel       = "appwrapper.mcad.ibm.com/namespace"        // owner namespace label for wrapped resources
-	assignedClusterLabel = "appwrapper.mcad.ibm.com/assignedCluster"  // cluster to which appwrapper has been assigned for execution
-	serializedStatusKey  = "appwrapper.mcad.ibm.com/serializedStatus" // annotation key for serializing status from hub to spoke
-	dispatchFinalizer    = "workload.codeflare.dev/finalizer"         // finalizer name for dispatcher
-	runnerFinalizer      = "workload.codeflare.dev/finalizer_runner"  // finalizer name for runner
-	nvidiaGpu            = "nvidia.com/gpu"                           // GPU resource name
-	specNodeName         = ".spec.nodeName"                           // key to index pods based on node placement
+	nameLabel            = "appwrapper.mcad.ibm.com"                     // owner name label for wrapped resources
+	namespaceLabel       = "appwrapper.mcad.ibm.com/namespace"           // owner namespace label for wrapped resources
+	assignedClusterLabel = "appwrapper.mcad.ibm.com/assignedCluster"     // cluster to which appwrapper has been assigned for execution
+	serializedStatusKey  = "appwrapper.mcad.ibm.com/serializedStatus"    // annotation key for serializing status from hub to spoke
+	legacyFinalizer      = "workload.codeflare.dev/finalizer"            // finalizer name used in 2.2.0 and earlier
+	dispatchFinalizer    = "workload.codeflare.dev/finalizer_dispatcher" // finalizer name for dispatcher
+	runnerFinalizer      = "workload.codeflare.dev/finalizer_runner"     // finalizer name for runner
+	nvidiaGpu            = "nvidia.com/gpu"                              // GPU resource name
+	specNodeName         = ".spec.nodeName"                              // key to index pods based on node placement
 )
 
 // Structured logger

internal/controller/runner.go

@@ -96,6 +96,18 @@ func (r *Runner) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result,
 		return ctrl.Result{}, nil
 	}
 
+	if controllerutil.ContainsFinalizer(appWrapper, legacyFinalizer) {
+		// Convert 2.2.0 and earlier single finalizer to two finalizer design
+		controllerutil.AddFinalizer(appWrapper, dispatchFinalizer)
+		controllerutil.AddFinalizer(appWrapper, runnerFinalizer)
+		controllerutil.RemoveFinalizer(appWrapper, legacyFinalizer)
+		if err := r.Update(ctx, appWrapper); err != nil {
+			return ctrl.Result{}, err
+		}
+		log.FromContext(ctx).Info("Converted 2.2 finalizer to 2.3 finalizers")
+		return ctrl.Result{Requeue: true}, nil
+	}
+
 	// handle state transitions that occur on the execution cluster
 	switch appWrapper.Status.State {
 	case mcadv1beta1.Empty: