propagate labels and annotations from ClusterClass and Cluster topology to KCP and MD

Author: Maksim Fedotov

api/v1beta1/cluster_types.go

@@ -101,7 +101,7 @@ type Topology struct {
 
 // ControlPlaneTopology specifies the parameters for the control plane nodes in the cluster.
 type ControlPlaneTopology struct {
-	// Metadata is the metadata applied to the machines of the ControlPlane.
+	// Metadata is the metadata applied to ControlPlane and the machines of the ControlPlane.
 	// At runtime this metadata is merged with the corresponding metadata from the ClusterClass.
 	//
 	// This field is supported if and only if the control plane provider template
@@ -133,7 +133,7 @@ type WorkersTopology struct {
 // MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology.
 // This set of nodes is managed by a MachineDeployment object whose lifecycle is managed by the Cluster controller.
 type MachineDeploymentTopology struct {
-	// Metadata is the metadata applied to the machines of the MachineDeployment.
+	// Metadata is the metadata applied to the MachineDeployment and the machines of the MachineDeployment.
 	// At runtime this metadata is merged with the corresponding metadata from the ClusterClass.
 	// +optional
 	Metadata ObjectMeta `json:"metadata,omitempty"`

config/crd/bases/cluster.x-k8s.io_clusters.yaml

@@ -203,6 +203,13 @@ func (c *ControlPlaneContract) IsScaling(obj *unstructured.Unstructured) (bool,
 	return false, nil
 }
 
+// Metadata provides access to the metadata of a ControlPlane object.
+func (c *ControlPlaneContract) Metadata() *Metadata {
+	return &Metadata{
+		path: Path{"metadata"},
+	}
+}
+
 // ControlPlaneMachineTemplate provides a helper struct for working with MachineTemplate in ClusterClass.
 type ControlPlaneMachineTemplate struct{}
 

internal/contract/controlplane.go

@@ -176,11 +176,21 @@ func (r *Reconciler) computeControlPlane(ctx context.Context, s *scope.Scope, in
 	cluster := s.Current.Cluster
 	currentRef := cluster.Spec.ControlPlaneRef
 
+	// Compute the labels and annotations to be applied to KubeadmControlPlane and Machines.
+	// We merge the labels and annotations from topology and ClusterClass.
+	topologyMetadata := s.Blueprint.Topology.ControlPlane.Metadata
+	clusterClassMetadata := s.Blueprint.ClusterClass.Spec.ControlPlane.Metadata
+
+	machineLabels := mergeMap(topologyMetadata.Labels, clusterClassMetadata.Labels)
+	machineAnnotations := mergeMap(topologyMetadata.Annotations, clusterClassMetadata.Annotations)
+
 	controlPlane, err := templateToObject(templateToInput{
 		template:              template,
 		templateClonedFromRef: templateClonedFromRef,
 		cluster:               cluster,
 		namePrefix:            fmt.Sprintf("%s-", cluster.Name),
+		labels:                machineLabels,
+		annotations:           machineAnnotations,
 		currentObjectRef:      currentRef,
 		// Note: It is not possible to add an ownerRef to Cluster at this stage, otherwise the provisioning
 		// of the ControlPlane starts no matter of the object being actually referenced by the Cluster itself.
@@ -205,13 +215,7 @@ func (r *Reconciler) computeControlPlane(ctx context.Context, s *scope.Scope, in
 			return nil, errors.Wrap(err, "failed to spec.machineTemplate.infrastructureRef in the ControlPlane object")
 		}
 
-		// Compute the labels and annotations to be applied to ControlPlane machines.
-		// We merge the labels and annotations from topology and ClusterClass.
-		// We also add the cluster-name and the topology owned labels, so they are propagated down to Machines.
-		topologyMetadata := s.Blueprint.Topology.ControlPlane.Metadata
-		clusterClassMetadata := s.Blueprint.ClusterClass.Spec.ControlPlane.Metadata
-
-		machineLabels := mergeMap(topologyMetadata.Labels, clusterClassMetadata.Labels)
+		// Add the cluster-name and the topology owned labels, so they are propagated down to Machines.
 		if machineLabels == nil {
 			machineLabels = map[string]string{}
 		}
@@ -220,7 +224,7 @@ func (r *Reconciler) computeControlPlane(ctx context.Context, s *scope.Scope, in
 		if err := contract.ControlPlane().MachineTemplate().Metadata().Set(controlPlane,
 			&clusterv1.ObjectMeta{
 				Labels:      machineLabels,
-				Annotations: mergeMap(topologyMetadata.Annotations, clusterClassMetadata.Annotations),
+				Annotations: machineAnnotations,
 			}); err != nil {
 			return nil, errors.Wrap(err, "failed to set spec.machineTemplate.metadata in the ControlPlane object")
 		}
@@ -512,6 +516,10 @@ func computeMachineDeployment(_ context.Context, s *scope.Scope, desiredControlP
 		return nil, errors.Wrapf(err, "failed to compute version for %s", machineDeploymentTopology.Name)
 	}
 
+	// Compute labels for MachineDeployment and Machines
+	machineLabels := mergeMap(machineDeploymentTopology.Metadata.Labels, machineDeploymentBlueprint.Metadata.Labels)
+	machineAnnotations := mergeMap(machineDeploymentTopology.Metadata.Annotations, machineDeploymentBlueprint.Metadata.Annotations)
+
 	// Compute the MachineDeployment object.
 	gv := clusterv1.GroupVersion
 	desiredMachineDeploymentObj := &clusterv1.MachineDeployment{
@@ -527,8 +535,8 @@ func computeMachineDeployment(_ context.Context, s *scope.Scope, desiredControlP
 			ClusterName: s.Current.Cluster.Name,
 			Template: clusterv1.MachineTemplateSpec{
 				ObjectMeta: clusterv1.ObjectMeta{
-					Labels:      mergeMap(machineDeploymentTopology.Metadata.Labels, machineDeploymentBlueprint.Metadata.Labels),
-					Annotations: mergeMap(machineDeploymentTopology.Metadata.Annotations, machineDeploymentBlueprint.Metadata.Annotations),
+					Labels:      machineLabels,
+					Annotations: machineAnnotations,
 				},
 				Spec: clusterv1.MachineSpec{
 					ClusterName:       s.Current.Cluster.Name,
@@ -562,7 +570,10 @@ func computeMachineDeployment(_ context.Context, s *scope.Scope, desiredControlP
 	labels[clusterv1.ClusterLabelName] = s.Current.Cluster.Name
 	labels[clusterv1.ClusterTopologyOwnedLabel] = ""
 	labels[clusterv1.ClusterTopologyMachineDeploymentLabelName] = machineDeploymentTopology.Name
-	desiredMachineDeploymentObj.SetLabels(labels)
+	desiredMachineDeploymentObj.SetLabels(mergeMap(labels, machineLabels))
+
+	// Apply Annotations
+	desiredMachineDeploymentObj.SetAnnotations(machineAnnotations)
 
 	// Set the selector with the subset of labels identifying controlled machines.
 	// NOTE: this prevents the web hook to add cluster.x-k8s.io/deployment-name label, that is
@@ -710,6 +721,8 @@ type templateToInput struct {
 	cluster               *clusterv1.Cluster
 	namePrefix            string
 	currentObjectRef      *corev1.ObjectReference
+	labels                map[string]string
+	annotations           map[string]string
 	// OwnerRef is an optional OwnerReference to attach to the cloned object.
 	ownerRef *metav1.OwnerReference
 }
@@ -724,14 +737,17 @@ func templateToObject(in templateToInput) (*unstructured.Unstructured, error) {
 	labels[clusterv1.ClusterLabelName] = in.cluster.Name
 	labels[clusterv1.ClusterTopologyOwnedLabel] = ""
 
+	templateLabels := mergeMap(labels, in.labels)
+
 	// Generate the object from the template.
 	// NOTE: OwnerRef can't be set at this stage; other controllers are going to add OwnerReferences when
 	// the object is actually created.
 	object, err := external.GenerateTemplate(&external.GenerateTemplateInput{
 		Template:    in.template,
 		TemplateRef: in.templateClonedFromRef,
 		Namespace:   in.cluster.Namespace,
-		Labels:      labels,
+		Labels:      templateLabels,
+		Annotations: in.annotations,
 		ClusterName: in.cluster.Name,
 		OwnerRef:    in.ownerRef,
 	})

internal/controllers/topology/cluster/desired_state.go

@@ -308,6 +308,8 @@ func TestComputeControlPlane(t *testing.T) {
 			cluster:     scope.Current.Cluster,
 			templateRef: blueprint.ClusterClass.Spec.ControlPlane.Ref,
 			template:    blueprint.ControlPlane.Template,
+			labels:      mergeMap(blueprint.Topology.ControlPlane.Metadata.Labels, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Labels),
+			annotations: mergeMap(blueprint.Topology.ControlPlane.Metadata.Annotations, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Annotations),
 			currentRef:  nil,
 			obj:         obj,
 		})
@@ -349,6 +351,8 @@ func TestComputeControlPlane(t *testing.T) {
 			cluster:     scope.Current.Cluster,
 			templateRef: blueprint.ClusterClass.Spec.ControlPlane.Ref,
 			template:    blueprint.ControlPlane.Template,
+			labels:      mergeMap(blueprint.Topology.ControlPlane.Metadata.Labels, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Labels),
+			annotations: mergeMap(blueprint.Topology.ControlPlane.Metadata.Annotations, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Annotations),
 			currentRef:  nil,
 			obj:         obj,
 		})
@@ -391,18 +395,38 @@ func TestComputeControlPlane(t *testing.T) {
 			cluster:     scope.Current.Cluster,
 			templateRef: blueprint.ClusterClass.Spec.ControlPlane.Ref,
 			template:    blueprint.ControlPlane.Template,
+			labels:      mergeMap(blueprint.Topology.ControlPlane.Metadata.Labels, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Labels),
+			annotations: mergeMap(blueprint.Topology.ControlPlane.Metadata.Annotations, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Annotations),
 			currentRef:  nil,
 			obj:         obj,
 		})
-		gotMetadata, err := contract.ControlPlane().MachineTemplate().Metadata().Get(obj)
+
+		gotMachineTemplateMetadata, err := contract.ControlPlane().MachineTemplate().Metadata().Get(obj)
+		g.Expect(err).ToNot(HaveOccurred())
+
+		gotControlPlaneMetadata, err := contract.ControlPlane().Metadata().Get(obj)
 		g.Expect(err).ToNot(HaveOccurred())
 
 		expectedLabels := mergeMap(scope.Current.Cluster.Spec.Topology.ControlPlane.Metadata.Labels, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Labels)
 		expectedLabels[clusterv1.ClusterLabelName] = cluster.Name
 		expectedLabels[clusterv1.ClusterTopologyOwnedLabel] = ""
-		g.Expect(gotMetadata).To(Equal(&clusterv1.ObjectMeta{
+
+		expectedAnnotations := mergeMap(scope.Current.Cluster.Spec.Topology.ControlPlane.Metadata.Annotations, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Annotations)
+
+		defaultControlPlaneAnnotations := map[string]string{
+			clusterv1.TemplateClonedFromNameAnnotation:      blueprint.ClusterClass.Spec.ControlPlane.Ref.Name,
+			clusterv1.TemplateClonedFromGroupKindAnnotation: blueprint.ClusterClass.Spec.ControlPlane.Ref.GroupVersionKind().GroupKind().String(),
+		}
+		expectedControlPlaneAnnotations := mergeMap(defaultControlPlaneAnnotations, expectedAnnotations)
+
+		g.Expect(gotMachineTemplateMetadata).To(Equal(&clusterv1.ObjectMeta{
+			Labels:      expectedLabels,
+			Annotations: expectedAnnotations,
+		}))
+
+		g.Expect(gotControlPlaneMetadata).To(Equal(&clusterv1.ObjectMeta{
 			Labels:      expectedLabels,
-			Annotations: mergeMap(scope.Current.Cluster.Spec.Topology.ControlPlane.Metadata.Annotations, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Annotations),
+			Annotations: expectedControlPlaneAnnotations,
 		}))
 
 		assertNestedField(g, obj, version, contract.ControlPlane().Version().Path()...)
@@ -444,6 +468,8 @@ func TestComputeControlPlane(t *testing.T) {
 			templateRef: blueprint.ClusterClass.Spec.ControlPlane.Ref,
 			template:    blueprint.ControlPlane.Template,
 			currentRef:  scope.Current.Cluster.Spec.ControlPlaneRef,
+			labels:      mergeMap(blueprint.Topology.ControlPlane.Metadata.Labels, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Labels),
+			annotations: mergeMap(blueprint.Topology.ControlPlane.Metadata.Annotations, blueprint.ClusterClass.Spec.ControlPlane.Metadata.Annotations),
 			obj:         obj,
 		})
 	})
@@ -1361,6 +1387,9 @@ func TestComputeMachineDeployment(t *testing.T) {
 
 		g.Expect(actualMd.Labels).To(HaveKeyWithValue(clusterv1.ClusterTopologyMachineDeploymentLabelName, "big-pool-of-machines"))
 		g.Expect(actualMd.Labels).To(HaveKey(clusterv1.ClusterTopologyOwnedLabel))
+		g.Expect(actualMd.Labels).To(HaveKeyWithValue("foo", "baz"))
+		g.Expect(actualMd.Labels).To(HaveKeyWithValue("fizz", "buzz"))
+		g.Expect(actualMd.Annotations).To(HaveKeyWithValue("annotation-1", "annotation-1-val"))
 		g.Expect(controllerutil.ContainsFinalizer(actualMd, clusterv1.MachineDeploymentTopologyFinalizer)).To(BeTrue())
 
 		g.Expect(actualMd.Spec.Selector.MatchLabels).To(HaveKey(clusterv1.ClusterTopologyOwnedLabel))
@@ -1369,6 +1398,7 @@ func TestComputeMachineDeployment(t *testing.T) {
 		g.Expect(actualMd.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("foo", "baz"))
 		g.Expect(actualMd.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("fizz", "buzz"))
 		g.Expect(actualMd.Spec.Template.ObjectMeta.Labels).To(HaveKey(clusterv1.ClusterTopologyOwnedLabel))
+		g.Expect(actualMd.Spec.Template.ObjectMeta.Annotations).To(HaveKeyWithValue("annotation-1", "annotation-1-val"))
 		g.Expect(actualMd.Spec.Template.Spec.InfrastructureRef.Name).ToNot(Equal("linux-worker-inframachinetemplate"))
 		g.Expect(actualMd.Spec.Template.Spec.Bootstrap.ConfigRef.Name).ToNot(Equal("linux-worker-bootstraptemplate"))
 	})
@@ -1415,11 +1445,15 @@ func TestComputeMachineDeployment(t *testing.T) {
 
 		g.Expect(actualMd.Labels).To(HaveKeyWithValue(clusterv1.ClusterTopologyMachineDeploymentLabelName, "big-pool-of-machines"))
 		g.Expect(actualMd.Labels).To(HaveKey(clusterv1.ClusterTopologyOwnedLabel))
+		g.Expect(actualMd.Labels).To(HaveKeyWithValue("foo", "baz"))
+		g.Expect(actualMd.Labels).To(HaveKeyWithValue("fizz", "buzz"))
+		g.Expect(actualMd.Annotations).To(HaveKeyWithValue("annotation-1", "annotation-1-val"))
 		g.Expect(controllerutil.ContainsFinalizer(actualMd, clusterv1.MachineDeploymentTopologyFinalizer)).To(BeFalse())
 
 		g.Expect(actualMd.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("foo", "baz"))
 		g.Expect(actualMd.Spec.Template.ObjectMeta.Labels).To(HaveKeyWithValue("fizz", "buzz"))
 		g.Expect(actualMd.Spec.Template.ObjectMeta.Labels).To(HaveKey(clusterv1.ClusterTopologyOwnedLabel))
+		g.Expect(actualMd.Spec.Template.ObjectMeta.Annotations).To(HaveKeyWithValue("annotation-1", "annotation-1-val"))
 		g.Expect(actualMd.Spec.Template.Spec.InfrastructureRef.Name).To(Equal("linux-worker-inframachinetemplate"))
 		g.Expect(actualMd.Spec.Template.Spec.Bootstrap.ConfigRef.Name).To(Equal("linux-worker-bootstraptemplate"))
 	})