Implement component override functionality for Config resource

This commit adds the ability to mark components as unmanaged in the
bpfman-operator, preventing the operator from creating or updating
specific objects. The implementation includes:

- Added ComponentOverride struct to Config API with fields for
kind, group, namespace, name, and unmanaged flag
- Modified assureResource function to check for overrides and skip
management of unmanaged components
- Implemented isOverridden helper function to match objects against
override specifications
- Added tests to verify override functionality works correctly
across all component types

Signed-off-by: Andreas Karis <[email protected]>

Author: andreaskaris

apis/v1alpha1/config_types.go

@@ -57,6 +57,17 @@ type ConfigSpec struct {
 	// Namespace holds the namespace where bpfman-operator resources shall be
 	// deployed.
 	Namespace string `json:"namespace,omitempty"`
+
+	// overrides is list of overides for components that are managed by
+	// the operator. Marking a component unmanaged will prevent
+	// the operator from creating or updating the object.
+	// +listType=map
+	// +listMapKey=kind
+	// +listMapKey=group
+	// +listMapKey=namespace
+	// +listMapKey=name
+	// +optional
+	Overrides []ComponentOverride `json:"overrides,omitempty"`
 }
 
 // AgentSpec defines the desired state of the bpfman agent.
@@ -94,3 +105,28 @@ type ConfigList struct {
 	metav1.ListMeta `json:"metadata,omitempty"`
 	Items           []Config `json:"items"`
 }
+
+// ComponentOverride allows overriding the operator's behavior for a component.
+// +k8s:deepcopy-gen=true
+type ComponentOverride struct {
+	// kind indentifies which object to override.
+	// +required
+	Kind string `json:"kind"`
+	// group identifies the API group that the kind is in.
+	// +required
+	Group string `json:"group"`
+
+	// namespace is the component's namespace. If the resource is cluster
+	// scoped, the namespace should be empty.
+	// +required
+	Namespace string `json:"namespace"`
+	// name is the component's name.
+	// +required
+	Name string `json:"name"`
+
+	// unmanaged controls if cluster version operator should stop managing the
+	// resources in this cluster.
+	// Default: false
+	// +required
+	Unmanaged bool `json:"unmanaged"`
+}

controllers/bpfman-operator/config.go

@@ -147,15 +147,22 @@ func (r *BpfmanConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request
 }
 
 func (r *BpfmanConfigReconciler) reconcileCM(ctx context.Context, bpfmanConfig *v1alpha1.Config) error {
-	cm := &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{
-		Name:      internal.BpfmanCmName,
-		Namespace: bpfmanConfig.Spec.Namespace},
+	cm := &corev1.ConfigMap{
+		TypeMeta: metav1.TypeMeta{
+			Kind:       "ConfigMap",
+			APIVersion: "v1",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      internal.BpfmanCmName,
+			Namespace: bpfmanConfig.Spec.Namespace,
+		},
 		Data: map[string]string{
 			internal.BpfmanTOML:          bpfmanConfig.Spec.Configuration,
 			internal.BpfmanAgentLogLevel: bpfmanConfig.Spec.Agent.LogLevel,
 			internal.BpfmanLogLevel:      bpfmanConfig.Spec.LogLevel,
 		},
 	}
+
 	return assureResource(ctx, r, bpfmanConfig, cm, func(existing, desired *corev1.ConfigMap) bool {
 		return !equality.Semantic.DeepEqual(existing.Data, desired.Data)
 	})
@@ -371,6 +378,12 @@ func load[T client.Object](t T, path, name string) (T, error) {
 // Creates the resource if it doesn't exist, otherwise updates it to match the desired state.
 func assureResource[T client.Object](ctx context.Context, r *BpfmanConfigReconciler,
 	bpfmanConfig *v1alpha1.Config, resource T, needsUpdate func(existing T, desired T) bool) error {
+	if isOverridden(resource, bpfmanConfig.Spec.Overrides) {
+		r.Logger.Info("Ignoring object (override in place)",
+			"type", resource.GetObjectKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
+		return nil
+	}
+
 	if err := ctrl.SetControllerReference(bpfmanConfig, resource, r.Scheme); err != nil {
 		return err
 	}
@@ -409,6 +422,20 @@ func assureResource[T client.Object](ctx context.Context, r *BpfmanConfigReconci
 	return nil
 }
 
+// isOverridden determines if a given object shall be unmanaged.
+func isOverridden(resource client.Object, overrides []v1alpha1.ComponentOverride) bool {
+	for _, override := range overrides {
+		if override.Unmanaged &&
+			override.Kind == resource.GetObjectKind().GroupVersionKind().Kind &&
+			override.Group == resource.GetObjectKind().GroupVersionKind().Group &&
+			override.Namespace == resource.GetNamespace() &&
+			override.Name == resource.GetName() {
+			return true
+		}
+	}
+	return false
+}
+
 // handleDeletion manages the safe deletion of Config resources by
 // removing the finalizer to allow Kubernetes garbage collection to
 // proceed via owner references.