Implement spec.managedBy field (#249)

Author: tardieu

api/v1beta2/appwrapper_types.go

@@ -30,6 +30,9 @@ type AppWrapperSpec struct {
 	// Suspend suspends the AppWrapper when set to true
 	//+optional
 	Suspend bool `json:"suspend,omitempty"`
+
+	// ManagedBy is used to indicate the controller or entity that manages the AppWrapper.
+	ManagedBy *string `json:"managedBy,omitempty"`
 }
 
 // AppWrapperComponent describes a single wrapped Kubernetes resource
@@ -176,6 +179,8 @@ const (
 	RetryableExitCodesAnnotation           = "workload.codeflare.dev.appwrapper/retryableExitCodes"
 )
 
+const AppWrapperControllerName = "workload.codeflare.dev/appwrapper-controller"
+
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
 //+kubebuilder:printcolumn:name="Status",type="string",JSONPath=`.status.phase`

api/v1beta2/zz_generated.deepcopy.go

@@ -160,6 +160,10 @@ spec:
                   - template
                   type: object
                 type: array
+              managedBy:
+                description: ManagedBy is used to indicate the controller or entity
+                  that manages the AppWrapper.
+                type: string
               suspend:
                 description: Suspend suspends the AppWrapper when set to true
                 type: boolean

config/crd/bases/workload.codeflare.dev_appwrappers.yaml

@@ -106,6 +106,11 @@ func (r *AppWrapperReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		return ctrl.Result{}, nil
 	}
 
+	// stop reconciliation if managed by another controller
+	if aw.Spec.ManagedBy != nil && *aw.Spec.ManagedBy != workloadv1beta2.AppWrapperControllerName {
+		return ctrl.Result{}, nil
+	}
+
 	// handle deletion first
 	if !aw.DeletionTimestamp.IsZero() {
 		if controllerutil.ContainsFinalizer(aw, AppWrapperFinalizer) {

internal/controller/appwrapper/appwrapper_controller.go

@@ -89,6 +89,11 @@ func (w *AppWrapperWebhook) Default(ctx context.Context, obj runtime.Object) err
 	username := utils.SanitizeLabel(userInfo.Username)
 	aw.Labels = utilmaps.MergeKeepFirst(map[string]string{AppWrapperUsernameLabel: username, AppWrapperUserIDLabel: userInfo.UID}, aw.Labels)
 
+	// do not inject finalizer if managed by another controller
+	if aw.Spec.ManagedBy != nil && *aw.Spec.ManagedBy != workloadv1beta2.AppWrapperControllerName {
+		return nil
+	}
+
 	// inject finalizer now (avoid reconcilier errors between the AppWrapper and WorkloadControllers when it is admitted by a ClusterQueue almost immediately)
 	controllerutil.AddFinalizer(aw, awc.AppWrapperFinalizer)
 
@@ -275,6 +280,11 @@ func (w *AppWrapperWebhook) validateAppWrapperUpdate(old *workloadv1beta2.AppWra
 		allErrors = append(allErrors, field.Forbidden(field.NewPath("metadata").Child("labels").Key(AppWrapperUserIDLabel), msg))
 	}
 
+	// ensure managedBy field is immutable
+	if old.Spec.ManagedBy != new.Spec.ManagedBy {
+		allErrors = append(allErrors, field.Forbidden(field.NewPath("spec").Child("managedBy"), msg))
+	}
+
 	return allErrors
 }