MGMT-2212: propagate annotations and labels from OpenshiftAssistedControlplane to its machine's OpenshiftAssistedConfig (#458)

Signed-off-by: Riccardo Piccoli <[email protected]>

Author: rccrdpccl

controlplane/internal/controller/openshiftassistedcontrolplane_controller.go

@@ -779,18 +779,41 @@ func (r *OpenshiftAssistedControlPlaneReconciler) computeInfraRef(ctx context.Co
 	return infraRef, nil
 }
 
-func (r *OpenshiftAssistedControlPlaneReconciler) generateOpenshiftAssistedConfig(acp *controlplanev1alpha2.OpenshiftAssistedControlPlane, clusterName string, name string) *bootstrapv1alpha1.OpenshiftAssistedConfig {
+func (r *OpenshiftAssistedControlPlaneReconciler) generateOpenshiftAssistedConfig(oacp *controlplanev1alpha2.OpenshiftAssistedControlPlane, clusterName string, name string) *bootstrapv1alpha1.OpenshiftAssistedConfig {
+	labels := util.ControlPlaneMachineLabelsForCluster(oacp, clusterName)
+
+	// Merge in labels from the OpenshiftAssistedControlPlane itself
+	// This allows users to set labels on the control plane that will be propagated to the configs
+	for k, v := range oacp.Labels {
+		if _, exists := labels[k]; !exists {
+			labels[k] = v
+		}
+	}
+
+	annotations := make(map[string]string)
+	for k, v := range oacp.Spec.MachineTemplate.ObjectMeta.Annotations {
+		annotations[k] = v
+	}
+
+	// Merge in annotations from the OpenshiftAssistedControlPlane itself
+	// This allows propagation of discovery-ignition-override and other annotations
+	for k, v := range oacp.Annotations {
+		if _, exists := annotations[k]; !exists {
+			annotations[k] = v
+		}
+	}
+
 	bootstrapConfig := &bootstrapv1alpha1.OpenshiftAssistedConfig{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:        name,
-			Namespace:   acp.Namespace,
-			Labels:      util.ControlPlaneMachineLabelsForCluster(acp, clusterName),
-			Annotations: acp.Spec.MachineTemplate.ObjectMeta.Annotations,
+			Namespace:   oacp.Namespace,
+			Labels:      labels,
+			Annotations: annotations,
 		},
-		Spec: *acp.Spec.OpenshiftAssistedConfigSpec.DeepCopy(),
+		Spec: *oacp.Spec.OpenshiftAssistedConfigSpec.DeepCopy(),
 	}
 
-	_ = controllerutil.SetOwnerReference(acp, bootstrapConfig, r.Scheme)
+	_ = controllerutil.SetOwnerReference(oacp, bootstrapConfig, r.Scheme)
 	return bootstrapConfig
 }
 

controlplane/internal/controller/openshiftassistedcontrolplane_controller_test.go

@@ -42,6 +42,7 @@ import (
 	fakeclient "sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
+	bootstrapv1alpha1 "github.com/openshift-assisted/cluster-api-provider-openshift-assisted/bootstrap/api/v1alpha1"
 	controlplanev1alpha2 "github.com/openshift-assisted/cluster-api-provider-openshift-assisted/controlplane/api/v1alpha2"
 	testutils "github.com/openshift-assisted/cluster-api-provider-openshift-assisted/test/utils"
 	corev1 "k8s.io/api/core/v1"
@@ -871,6 +872,98 @@ var _ = Describe("Scale operations and machine updates", func() {
 			Expect(oacp.Status.UpdatedReplicas).To(Equal(int32(0)))
 		})
 	})
+
+	Context("Label propagation", func() {
+		BeforeEach(func() {
+			oacp.Spec.Replicas = 1
+			// Add custom labels to the OpenshiftAssistedControlPlane
+			oacp.Labels = map[string]string{
+				"custom-label":       "custom-value",
+				"discovery-ignition": "enabled",
+				"test-label":         "test-value",
+			}
+			Expect(k8sClient.Create(ctx, oacp)).To(Succeed())
+		})
+
+		It("should copy labels from OpenshiftAssistedControlPlane to OpenshiftAssistedConfig", func() {
+			// Reconcile to create machines and bootstrap configs
+			result, err := controllerReconciler.Reconcile(ctx, reconcile.Request{NamespacedName: typeNamespacedName})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result).To(Equal(ctrlruntime.Result{}))
+
+			// Get the created bootstrap configs
+			bootstrapConfigList := &bootstrapv1alpha1.OpenshiftAssistedConfigList{}
+			Expect(k8sClient.List(ctx, bootstrapConfigList, client.InNamespace(namespace))).To(Succeed())
+			Expect(bootstrapConfigList.Items).To(HaveLen(1))
+
+			bootstrapConfig := &bootstrapConfigList.Items[0]
+
+			// Verify that custom labels from oacp are present in the bootstrap config
+			Expect(bootstrapConfig.Labels).To(HaveKeyWithValue("custom-label", "custom-value"))
+			Expect(bootstrapConfig.Labels).To(HaveKeyWithValue("discovery-ignition", "enabled"))
+			Expect(bootstrapConfig.Labels).To(HaveKeyWithValue("test-label", "test-value"))
+
+			// Verify that standard control plane labels are also present
+			Expect(bootstrapConfig.Labels).To(HaveKeyWithValue(clusterv1.ClusterNameLabel, clusterName))
+			Expect(bootstrapConfig.Labels).To(HaveKey(clusterv1.MachineControlPlaneLabel))
+			Expect(bootstrapConfig.Labels).To(HaveKey(clusterv1.MachineControlPlaneNameLabel))
+		})
+
+		It("should not override standard control plane labels with custom labels", func() {
+			// Update oacp with labels that would conflict with standard labels
+			Expect(k8sClient.Get(ctx, typeNamespacedName, oacp)).To(Succeed())
+			oacp.Labels[clusterv1.ClusterNameLabel] = "wrong-cluster-name"
+			Expect(k8sClient.Update(ctx, oacp)).To(Succeed())
+
+			// Reconcile to create machines and bootstrap configs
+			result, err := controllerReconciler.Reconcile(ctx, reconcile.Request{NamespacedName: typeNamespacedName})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result).To(Equal(ctrlruntime.Result{}))
+
+			// Get the created bootstrap configs
+			bootstrapConfigList := &bootstrapv1alpha1.OpenshiftAssistedConfigList{}
+			Expect(k8sClient.List(ctx, bootstrapConfigList, client.InNamespace(namespace))).To(Succeed())
+			Expect(bootstrapConfigList.Items).To(HaveLen(1))
+
+			bootstrapConfig := &bootstrapConfigList.Items[0]
+
+			// Verify that the standard cluster name label is NOT overridden by the custom label
+			Expect(bootstrapConfig.Labels).To(HaveKeyWithValue(clusterv1.ClusterNameLabel, clusterName))
+			Expect(bootstrapConfig.Labels).NotTo(HaveKeyWithValue(clusterv1.ClusterNameLabel, "wrong-cluster-name"))
+		})
+	})
+
+	Context("Annotation propagation for discovery ignition", func() {
+		BeforeEach(func() {
+			oacp.Spec.Replicas = 1
+		})
+
+		It("should propagate discovery-ignition-override annotation from OpenshiftAssistedControlPlane to OpenshiftAssistedConfig", func() {
+			// Add discovery-ignition-override annotation to the OpenshiftAssistedControlPlane
+			discoveryIgnitionOverride := `{"ignition":{"version":"3.2.0"},"storage":{"files":[{"path":"/etc/test","contents":{"source":"data:,test"}}]}}`
+			oacp.Annotations = map[string]string{
+				bootstrapv1alpha1.DiscoveryIgnitionOverrideAnnotation: discoveryIgnitionOverride,
+				"custom-annotation": "custom-value",
+			}
+			Expect(k8sClient.Create(ctx, oacp)).To(Succeed())
+
+			// Reconcile to create machines and bootstrap configs
+			result, err := controllerReconciler.Reconcile(ctx, reconcile.Request{NamespacedName: typeNamespacedName})
+			Expect(err).NotTo(HaveOccurred())
+			Expect(result).To(Equal(ctrlruntime.Result{}))
+
+			// Get the created bootstrap configs
+			bootstrapConfigList := &bootstrapv1alpha1.OpenshiftAssistedConfigList{}
+			Expect(k8sClient.List(ctx, bootstrapConfigList, client.InNamespace(namespace))).To(Succeed())
+			Expect(bootstrapConfigList.Items).To(HaveLen(1))
+
+			bootstrapConfig := &bootstrapConfigList.Items[0]
+
+			// Verify that annotations from oacp are present in the bootstrap config
+			Expect(bootstrapConfig.Annotations).To(HaveKeyWithValue(bootstrapv1alpha1.DiscoveryIgnitionOverrideAnnotation, discoveryIgnitionOverride))
+			Expect(bootstrapConfig.Annotations).To(HaveKeyWithValue("custom-annotation", "custom-value"))
+		})
+	})
 })
 
 // Create dummy machine template