refactor: make component label configurable (#101)

maximiliantech · web-flow · commit 88dce65b7c07 · 2025-08-21T09:18:28.000+02:00
* chore: update Taskfile

* chore: update build submodule

* refactor: component label

* chore: upgrade ocm

* feat: release v0.1.13
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -15,7 +15,6 @@ includes:
     flatten: true
     excludes: []
     vars:
-      NESTED_MODULES: api
       API_DIRS: '{{.ROOT_DIR}}/api/v1beta1/...'
       MANIFEST_OUT: '{{.ROOT_DIR}}/api/crds/manifests'
       CODE_DIRS: '{{.ROOT_DIR}}/... {{.ROOT_DIR}}/cmd/... {{.ROOT_DIR}}/internal/... {{.ROOT_DIR}}/test/... {{.ROOT_DIR}}/api/v1beta1/...'
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v0.1.12-dev
+v0.1.13
diff --git a/charts/control-plane-operator/Chart.yaml b/charts/control-plane-operator/Chart.yaml
@@ -2,8 +2,8 @@ apiVersion: v2
 name: control-plane-operator
 description: A Helm chart for the Cloud Orchestration Control Plane Operator
 type: application
-version: v0.1.12
-appVersion: v0.1.12
+version: v0.1.13
+appVersion: v0.1.13
 home: https://github.com/openmcp-project/control-plane-operator
 sources:
   - https://github.com/openmcp-project/control-plane-operator
diff --git a/charts/control-plane-operator/values.yaml b/charts/control-plane-operator/values.yaml
@@ -8,7 +8,7 @@ image:
   repository: ghcr.io/openmcp-project/images/control-plane-operator
   pullPolicy: IfNotPresent
   # Overrides the image tag whose default is the chart appVersion.
-  tag: v0.1.12
+  tag: v0.1.13
 
 imagePullSecrets: []
 nameOverride: ""
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/hack/common b/hack/common
@@ -1 +1 @@
-Subproject commit 3c4928466d3b7aa051f14733815f3cbc2bac147f
+Subproject commit 739f11e620669205e2cc3b5b88ca3d0593049df3
diff --git a/internal/controller/controlplane_controller.go b/internal/controller/controlplane_controller.go
@@ -335,7 +335,7 @@ func (r *ControlPlaneReconciler) newJuggler(ctx context.Context, cp *corev1beta1
 }
 
 func (r *ControlPlaneReconciler) registerReconcilers(juggler *juggler.Juggler, logger logr.Logger, remoteClient client.Client) {
-	fr := fluxcd.NewFluxReconciler(logger, r.Client, remoteClient)
+	fr := fluxcd.NewFluxReconciler(logger, r.Client, remoteClient, utils.LabelComponentName)
 	fr.RegisterType(
 		&components.BTPServiceOperator{},
 		&components.CertManager{},
@@ -346,7 +346,7 @@ func (r *ControlPlaneReconciler) registerReconcilers(juggler *juggler.Juggler, l
 	)
 	juggler.RegisterReconciler(fr)
 
-	or := object.NewReconciler(logger, remoteClient)
+	or := object.NewReconciler(logger, remoteClient, utils.LabelComponentName)
 	or.RegisterType(
 		&components.ClusterRole{},
 		&components.CrossplaneProvider{},
diff --git a/pkg/controlplane/components/clusterrole_component.go b/pkg/controlplane/components/clusterrole_component.go
@@ -60,7 +60,7 @@ func (*ClusterRole) OrphanDetectorContext() object.DetectorContext {
 		ListType: &rbacv1.ClusterRoleList{},
 		FilterCriteria: object.FilterCriteria{
 			utils.IsManaged(),
-			object.HasComponentLabel(),
+			utils.HasComponentLabel(),
 		},
 		ConvertFunc: func(list client.ObjectList) []juggler.Component {
 			clusterRoles := []juggler.Component{}
diff --git a/pkg/controlplane/components/crossplanedeploymentruntimeconfig_component.go b/pkg/controlplane/components/crossplanedeploymentruntimeconfig_component.go
@@ -104,7 +104,7 @@ func (c *CrossplaneDeploymentRuntimeConfig) OrphanDetectorContext() object.Detec
 		ListType: &crossplanev1beta1.DeploymentRuntimeConfigList{},
 		FilterCriteria: object.FilterCriteria{
 			utils.IsManaged(),
-			object.HasComponentLabel(),
+			utils.HasComponentLabel(),
 		},
 		ConvertFunc: func(list client.ObjectList) []juggler.Component {
 			cdrcs := []juggler.Component{}
diff --git a/pkg/controlplane/components/crossplaneprovider_component.go b/pkg/controlplane/components/crossplaneprovider_component.go
@@ -63,7 +63,7 @@ func (*CrossplaneProvider) OrphanDetectorContext() object.DetectorContext {
 		ListType: &crossplanev1.ProviderList{},
 		FilterCriteria: object.FilterCriteria{
 			utils.IsManaged(),
-			object.HasComponentLabel(),
+			utils.HasComponentLabel(),
 		},
 		ConvertFunc: func(list client.ObjectList) []juggler.Component {
 			providers := []juggler.Component{}
diff --git a/pkg/controlplane/components/secret_component.go b/pkg/controlplane/components/secret_component.go
@@ -71,7 +71,7 @@ func (*Secret) OrphanDetectorContext() object.DetectorContext {
 		ListType: &corev1.SecretList{},
 		FilterCriteria: object.FilterCriteria{
 			utils.IsManaged(),
-			object.HasComponentLabel(),
+			utils.HasComponentLabel(),
 		},
 		ConvertFunc: func(list client.ObjectList) []juggler.Component {
 			secrets := []juggler.Component{}
diff --git a/pkg/juggler/fluxcd/flux_reconciler.go b/pkg/juggler/fluxcd/flux_reconciler.go
@@ -17,30 +17,28 @@ import (
 	"github.com/openmcp-project/control-plane-operator/pkg/utils"
 )
 
-const (
-	labelComponentName = "controlplane.core.orchestrate.cloud.sap/component"
-)
-
 var (
 	errNotFluxComponent = errors.New("not a flux component")
 )
 
 var _ juggler.ComponentReconciler = &FluxReconciler{}
 
-func NewFluxReconciler(logger logr.Logger, localClient client.Client, remoteClient client.Client) *FluxReconciler {
+func NewFluxReconciler(logger logr.Logger, localClient client.Client, remoteClient client.Client, labelComponentName string) *FluxReconciler {
 	return &FluxReconciler{
-		logger:       logger,
-		localClient:  localClient,
-		remoteClient: remoteClient,
-		knownTypes:   sets.Set[reflect.Type]{},
+		logger:             logger,
+		localClient:        localClient,
+		remoteClient:       remoteClient,
+		knownTypes:         sets.Set[reflect.Type]{},
+		labelComponentName: labelComponentName,
 	}
 }
 
 type FluxReconciler struct {
-	localClient  client.Client
-	remoteClient client.Client
-	logger       logr.Logger
-	knownTypes   sets.Set[reflect.Type]
+	localClient        client.Client
+	remoteClient       client.Client
+	logger             logr.Logger
+	knownTypes         sets.Set[reflect.Type]
+	labelComponentName string
 }
 
 // KnownTypes implements juggler.ComponentReconciler.
@@ -218,7 +216,7 @@ func (r *FluxReconciler) installOrUpdateManifesto(ctx context.Context, fluxCompo
 		}
 
 		utils.SetManagedBy(obj)
-		utils.SetLabel(obj, labelComponentName, fluxComponent.GetName())
+		utils.SetLabel(obj, r.labelComponentName, fluxComponent.GetName())
 		return nil
 	})
 
@@ -245,7 +243,7 @@ func (r *FluxReconciler) installOrUpdateSource(ctx context.Context, fluxComponen
 		}
 
 		utils.SetManagedBy(obj)
-		utils.SetLabel(obj, labelComponentName, fluxComponent.GetName())
+		utils.SetLabel(obj, r.labelComponentName, fluxComponent.GetName())
 		return nil
 	})
 
diff --git a/pkg/juggler/fluxcd/flux_reconciler_test.go b/pkg/juggler/fluxcd/flux_reconciler_test.go
@@ -21,6 +21,8 @@ import (
 
 var errBoom = errors.New("boom")
 
+const testLabelComponentName = "flux.juggler.test.io/component"
+
 func TestNewFluxReconciler(t *testing.T) {
 	tests := []struct {
 		name         string
@@ -56,7 +58,7 @@ func TestNewFluxReconciler(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			actual := NewFluxReconciler(tt.logger, tt.localClient, tt.remoteClient)
+			actual := NewFluxReconciler(tt.logger, tt.localClient, tt.remoteClient, "")
 			if !assert.Equal(t, actual, tt.expected) {
 				t.Errorf("NewReconciler() = %v, want %v", actual, tt.expected)
 			}
@@ -361,7 +363,7 @@ func TestFluxReconciler_Observe(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 
-			r := NewFluxReconciler(logr.Logger{}, fake.NewClientBuilder().WithScheme(scheme).WithObjects(tt.localObjects...).Build(), nil)
+			r := NewFluxReconciler(logr.Logger{}, fake.NewClientBuilder().WithScheme(scheme).WithObjects(tt.localObjects...).Build(), nil, testLabelComponentName)
 			actualObservation, actualError := r.Observe(context.TODO(), tt.obj)
 			if !assert.Equal(t, tt.expectedObservation, actualObservation) {
 				t.Errorf("ObjectReconciler.Observe() = %v, want %v", actualObservation, tt.expectedObservation)
@@ -613,7 +615,7 @@ func TestFluxReconciler_Uninstall(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			r := NewFluxReconciler(logr.Logger{}, fake.NewClientBuilder().WithScheme(scheme).WithObjects(tt.localObjects...).Build(), nil)
+			r := NewFluxReconciler(logr.Logger{}, fake.NewClientBuilder().WithScheme(scheme).WithObjects(tt.localObjects...).Build(), nil, testLabelComponentName)
 			actual := r.Uninstall(context.TODO(), tt.obj)
 			if !errors.Is(actual, tt.expected) {
 				t.Errorf("ObjectReconciler.Uninstall() = %v, want %v", actual, tt.expected)
@@ -672,7 +674,7 @@ func TestFluxReconciler_Install(t *testing.T) {
 				}
 				if !assert.Equal(t, helmRepo.GetLabels(), map[string]string{
 					"app.kubernetes.io/managed-by": "control-plane-operator",
-					labelComponentName:             component.GetName(),
+					testLabelComponentName:         component.GetName(),
 				}) {
 					return errors.New("labels not equal")
 				}
@@ -717,7 +719,7 @@ func TestFluxReconciler_Install(t *testing.T) {
 				}
 				if !assert.Equal(t, helmRelease.GetLabels(), map[string]string{
 					"app.kubernetes.io/managed-by": "control-plane-operator",
-					labelComponentName:             component.GetName(),
+					testLabelComponentName:         component.GetName(),
 				}) {
 					return errors.New("labels not equal")
 				}
@@ -729,7 +731,7 @@ func TestFluxReconciler_Install(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			fakeLocalClient := fake.NewClientBuilder().WithScheme(scheme).Build()
-			r := NewFluxReconciler(logr.Logger{}, fakeLocalClient, nil)
+			r := NewFluxReconciler(logr.Logger{}, fakeLocalClient, nil, testLabelComponentName)
 			ctx := context.TODO()
 			actual := r.Install(ctx, tt.obj)
 
@@ -747,7 +749,7 @@ func TestFluxReconciler_Install(t *testing.T) {
 }
 
 func Test_FluxReconciler_Types(t *testing.T) {
-	r := NewFluxReconciler(logr.Logger{}, nil, nil)
+	r := NewFluxReconciler(logr.Logger{}, nil, nil, "")
 	r.RegisterType(FakeFluxComponent{}, FakeFluxComponent{})
 	assert.Len(t, r.KnownTypes(), 1)
 	assert.Equal(t, r.KnownTypes()[0], reflect.TypeOf(FakeFluxComponent{}))
diff --git a/pkg/juggler/object/object_component.go b/pkg/juggler/object/object_component.go
@@ -51,7 +51,3 @@ type DetectorContext struct {
 type OrphanedObjectsDetector interface {
 	OrphanDetectorContext() DetectorContext
 }
-
-func HasComponentLabel() client.ListOption {
-	return client.HasLabels{labelComponentName}
-}
diff --git a/pkg/juggler/object/object_reconciler.go b/pkg/juggler/object/object_reconciler.go
@@ -15,29 +15,27 @@ import (
 	"github.com/openmcp-project/control-plane-operator/pkg/utils"
 )
 
-const (
-	labelComponentName = "controlplane.core.orchestrate.cloud.sap/component"
-)
-
 var (
 	errNotObjectComponent = errors.New("not an object component")
 )
 
 var _ juggler.ComponentReconciler = &ObjectReconciler{}
 var _ juggler.OrphanedComponentsDetector = &ObjectReconciler{}
 
-func NewReconciler(logger logr.Logger, remoteClient client.Client) *ObjectReconciler {
+func NewReconciler(logger logr.Logger, remoteClient client.Client, labelComponentName string) *ObjectReconciler {
 	return &ObjectReconciler{
-		logger:       logger,
-		remoteClient: remoteClient,
-		knownTypes:   sets.Set[reflect.Type]{},
+		logger:             logger,
+		remoteClient:       remoteClient,
+		knownTypes:         sets.Set[reflect.Type]{},
+		labelComponentName: labelComponentName,
 	}
 }
 
 type ObjectReconciler struct {
-	logger       logr.Logger
-	remoteClient client.Client
-	knownTypes   sets.Set[reflect.Type]
+	logger             logr.Logger
+	remoteClient       client.Client
+	knownTypes         sets.Set[reflect.Type]
+	labelComponentName string
 }
 
 // DetectOrphanedComponents implements juggler.OrphanedComponentsDetector.
@@ -200,7 +198,7 @@ func (r *ObjectReconciler) applyObject(ctx context.Context, component juggler.Co
 
 	_, err = controllerutil.CreateOrUpdate(ctx, r.remoteClient, obj, func() error {
 		utils.SetManagedBy(obj)
-		utils.SetLabel(obj, labelComponentName, component.GetName())
+		utils.SetLabel(obj, r.labelComponentName, component.GetName())
 		return objectComponent.ReconcileObject(ctx, obj)
 	})
 	return err
diff --git a/pkg/juggler/object/object_reconciler_test.go b/pkg/juggler/object/object_reconciler_test.go
@@ -26,6 +26,8 @@ import (
 
 var errBoom = errors.New("boom")
 
+const testLabelComponentName = "object.juggler.test.io/component"
+
 func TestObjectReconciler_Install(t *testing.T) {
 	tests := []struct {
 		name          string
@@ -77,7 +79,7 @@ func TestObjectReconciler_Install(t *testing.T) {
 				}
 				if !assert.Equal(t, secret.GetLabels(), map[string]string{
 					"app.kubernetes.io/managed-by": "control-plane-operator",
-					labelComponentName:             comp.GetName(),
+					testLabelComponentName:         comp.GetName(),
 				}) {
 					return errors.New("labels not equal")
 				}
@@ -117,7 +119,7 @@ func TestObjectReconciler_Install(t *testing.T) {
 				}
 				if !assert.Equal(t, secret.GetLabels(), map[string]string{
 					"app.kubernetes.io/managed-by": "control-plane-operator",
-					labelComponentName:             comp.GetName(),
+					testLabelComponentName:         comp.GetName(),
 				}) {
 					return errors.New("labels not equal")
 				}
@@ -131,7 +133,7 @@ func TestObjectReconciler_Install(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			fakeRemoteClient := fake.NewClientBuilder().WithObjects(tt.remoteObjects...).Build()
-			r := NewReconciler(logr.Logger{}, fakeRemoteClient)
+			r := NewReconciler(logr.Logger{}, fakeRemoteClient, testLabelComponentName)
 			ctx := context.TODO()
 			actual := r.Install(ctx, tt.obj)
 			if !errors.Is(actual, tt.error) {
@@ -368,7 +370,7 @@ func TestObjectReconciler_Uninstall(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			fakeClient := fake.NewClientBuilder().WithObjects(tt.remoteObjects...).Build()
-			r := NewReconciler(logr.Logger{}, fakeClient)
+			r := NewReconciler(logr.Logger{}, fakeClient, testLabelComponentName)
 			ctx := context.TODO()
 			actual := r.Uninstall(ctx, tt.obj)
 			if !errors.Is(actual, tt.expected) {
@@ -413,7 +415,7 @@ func TestNewReconciler(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			actual := NewReconciler(tt.logger, tt.remoteClient)
+			actual := NewReconciler(tt.logger, tt.remoteClient, "")
 			if !assert.Equal(t, tt.expected, actual) {
 				t.Errorf("NewReconciler() = %v, want %v", actual, tt.expected)
 			}
@@ -528,7 +530,7 @@ func TestObjectReconciler_Observe(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			r := NewReconciler(logr.Logger{}, fake.NewClientBuilder().WithObjects(tt.remoteObjects...).Build())
+			r := NewReconciler(logr.Logger{}, fake.NewClientBuilder().WithObjects(tt.remoteObjects...).Build(), testLabelComponentName)
 			ctx := context.TODO()
 			actualObservation, actualError := r.Observe(ctx, tt.obj)
 			if !assert.Equal(t, tt.expectedObservation, actualObservation) {
@@ -542,7 +544,7 @@ func TestObjectReconciler_Observe(t *testing.T) {
 }
 
 func Test_ObjectReconciler_Types(t *testing.T) {
-	r := NewReconciler(logr.Logger{}, nil)
+	r := NewReconciler(logr.Logger{}, nil, "")
 	r.RegisterType(FakeObjectComponent{}, FakeObjectComponent{})
 	assert.Len(t, r.KnownTypes(), 1)
 	assert.Equal(t, r.KnownTypes()[0], reflect.TypeOf(FakeObjectComponent{}))
@@ -622,7 +624,7 @@ func Test_ObjectReconciler_DetectOrphanedComponents(t *testing.T) {
 	for _, tC := range testCases {
 		t.Run(tC.desc, func(t *testing.T) {
 			fakeClient := fake.NewClientBuilder().WithObjects(tC.initObjs...).WithInterceptorFuncs(tC.interceptorFuncs).Build()
-			r := NewReconciler(logr.Logger{}, fakeClient)
+			r := NewReconciler(logr.Logger{}, fakeClient, testLabelComponentName)
 			for _, cc := range tC.configuredComponents {
 				r.RegisterType(cc.(ObjectComponent))
 			}
diff --git a/pkg/utils/meta.go b/pkg/utils/meta.go
@@ -8,6 +8,7 @@ import (
 const (
 	labelManagedBy      = "app.kubernetes.io/managed-by"
 	labelManagedByValue = "control-plane-operator"
+	LabelComponentName  = "controlplane.core.orchestrate.cloud.sap/component"
 )
 
 func SetLabel(obj v1.Object, label string, value string) {
@@ -26,3 +27,7 @@ func SetManagedBy(obj v1.Object) {
 func IsManaged() client.MatchingLabels {
 	return client.MatchingLabels{labelManagedBy: labelManagedByValue}
 }
+
+func HasComponentLabel() client.ListOption {
+	return client.HasLabels{LabelComponentName}
+}
diff --git a/pkg/utils/meta_test.go b/pkg/utils/meta_test.go
@@ -86,3 +86,8 @@ func TestIsManaged(t *testing.T) {
 	got := IsManaged()
 	assert.DeepEqual(t, got, client.MatchingLabels{labelManagedBy: labelManagedByValue})
 }
+
+func TestHasComponentLabel(t *testing.T) {
+	got := HasComponentLabel()
+	assert.DeepEqual(t, got, client.HasLabels{LabelComponentName})
+}
