[release-1.7] ✨ Extend ControlPlane/ MD / MP builtin to include metadata

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

@@ -535,19 +535,20 @@ referenced in patches:
 - `builtin.cluster.{name,namespace,uid}`
 - `builtin.cluster.topology.{version,class}`
 - `builtin.cluster.network.{serviceDomain,services,pods,ipFamily}`
-- `builtin.controlPlane.{replicas,version,name}`
+    - Note: ipFamily is deprecated and will be removed in a future release. see https://github.com/kubernetes-sigs/cluster-api/issues/7521.
+- `builtin.controlPlane.{replicas,version,name,metadata.labels,metadata.annotations}`
     - Please note, these variables are only available when patching control plane or control plane 
       machine templates.
 - `builtin.controlPlane.machineTemplate.infrastructureRef.name`
     - Please note, these variables are only available when using a control plane with machines and 
       when patching control plane or control plane machine templates.
-- `builtin.machineDeployment.{replicas,version,class,name,topologyName}`
+- `builtin.machineDeployment.{replicas,version,class,name,topologyName,metadata.labels,metadata.annotations}`
     - Please note, these variables are only available when patching the templates of a MachineDeployment 
       and contain the values of the current `MachineDeployment` topology.
 - `builtin.machineDeployment.{infrastructureRef.name,bootstrap.configRef.name}`
     - Please note, these variables are only available when patching the templates of a MachineDeployment
       and contain the values of the current `MachineDeployment` topology.
-- `builtin.machinePool.{replicas,version,class,name,topologyName}`
+- `builtin.machinePool.{replicas,version,class,name,topologyName,metadata.labels,metadata.annotations}`
     - Please note, these variables are only available when patching the templates of a MachinePool 
       and contain the values of the current `MachinePool` topology.
 - `builtin.machinePool.{infrastructureRef.name,bootstrap.configRef.name}`

exp/runtime/hooks/api/v1alpha1/topologymutation_variable_types.go

@@ -16,7 +16,11 @@ limitations under the License.
 
 package v1alpha1
 
-import "k8s.io/apimachinery/pkg/types"
+import (
+	"k8s.io/apimachinery/pkg/types"
+
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+)
 
 // BuiltinsName is the name of the builtin variable.
 const BuiltinsName = "builtin"
@@ -81,6 +85,9 @@ type ControlPlaneBuiltins struct {
 	// being orchestrated.
 	Version string `json:"version,omitempty"`
 
+	// Metadata is the metadata set on the ControlPlane object.
+	Metadata *clusterv1.ObjectMeta `json:"metadata,omitempty"`
+
 	// Name is the name of the ControlPlane,
 	// to which the current template belongs to.
 	Name string `json:"name,omitempty"`
@@ -115,6 +122,9 @@ type MachineDeploymentBuiltins struct {
 	// being orchestrated.
 	Version string `json:"version,omitempty"`
 
+	// Metadata is the metadata set on the MachineDeployment.
+	Metadata *clusterv1.ObjectMeta `json:"metadata,omitempty"`
+
 	// Class is the class name of the MachineDeployment,
 	// to which the current template belongs to.
 	Class string `json:"class,omitempty"`
@@ -148,6 +158,9 @@ type MachinePoolBuiltins struct {
 	// being orchestrated.
 	Version string `json:"version,omitempty"`
 
+	// Metadata is the metadata set on the MachinePool.
+	Metadata *clusterv1.ObjectMeta `json:"metadata,omitempty"`
+
 	// Class is the class name of the MachinePool,
 	// to which the current template belongs to.
 	Class string `json:"class,omitempty"`

internal/controllers/topology/cluster/patches/engine_test.go

@@ -1139,7 +1139,7 @@ func setupTestObjects() (*scope.ClusterBlueprint, *scope.ClusterState) {
 				Workers: &clusterv1.WorkersTopology{
 					MachineDeployments: []clusterv1.MachineDeploymentTopology{
 						{
-							Metadata: clusterv1.ObjectMeta{},
+							Metadata: clusterv1.ObjectMeta{Labels: map[string]string{"foo": "bar"}, Annotations: map[string]string{"fizz": "buzz"}},
 							Class:    "default-worker",
 							Name:     "default-worker-topo1",
 							Variables: &clusterv1.MachineDeploymentVariables{
@@ -1161,7 +1161,7 @@ func setupTestObjects() (*scope.ClusterBlueprint, *scope.ClusterState) {
 					},
 					MachinePools: []clusterv1.MachinePoolTopology{
 						{
-							Metadata: clusterv1.ObjectMeta{},
+							Metadata: clusterv1.ObjectMeta{Labels: map[string]string{"foo": "bar"}, Annotations: map[string]string{"fizz": "buzz"}},
 							Class:    "default-mp-worker",
 							Name:     "default-mp-worker-topo1",
 							Variables: &clusterv1.MachinePoolVariables{

internal/controllers/topology/cluster/patches/variables/variables.go

@@ -129,6 +129,12 @@ func ControlPlane(cpTopology *clusterv1.ControlPlaneTopology, cp, cpInfrastructu
 		}
 		builtin.ControlPlane.Replicas = replicas
 	}
+	if cp.GetLabels() != nil || cp.GetAnnotations() != nil {
+		builtin.ControlPlane.Metadata = &clusterv1.ObjectMeta{
+			Annotations: cp.GetAnnotations(),
+			Labels:      cp.GetLabels(),
+		}
+	}
 
 	version, err := contract.ControlPlane().Version().Get(cp)
 	if err != nil {
@@ -182,6 +188,12 @@ func MachineDeployment(mdTopology *clusterv1.MachineDeploymentTopology, md *clus
 	if md.Spec.Replicas != nil {
 		builtin.MachineDeployment.Replicas = ptr.To[int64](int64(*md.Spec.Replicas))
 	}
+	if md.Labels != nil || md.Annotations != nil {
+		builtin.MachineDeployment.Metadata = &clusterv1.ObjectMeta{
+			Annotations: md.Annotations,
+			Labels:      md.Labels,
+		}
+	}
 
 	if mdBootstrapTemplate != nil {
 		builtin.MachineDeployment.Bootstrap = &runtimehooksv1.MachineBootstrapBuiltins{
@@ -235,6 +247,12 @@ func MachinePool(mpTopology *clusterv1.MachinePoolTopology, mp *expv1.MachinePoo
 	if mp.Spec.Replicas != nil {
 		builtin.MachinePool.Replicas = ptr.To[int64](int64(*mp.Spec.Replicas))
 	}
+	if mp.Labels != nil || mp.Annotations != nil {
+		builtin.MachinePool.Metadata = &clusterv1.ObjectMeta{
+			Annotations: mp.Annotations,
+			Labels:      mp.Labels,
+		}
+	}
 
 	if mpBootstrapObject != nil {
 		builtin.MachinePool.Bootstrap = &runtimehooksv1.MachineBootstrapBuiltins{

internal/controllers/topology/cluster/patches/variables/variables_test.go

@@ -445,6 +445,8 @@ func TestControlPlane(t *testing.T) {
 			controlPlane: builder.ControlPlane(metav1.NamespaceDefault, "controlPlane1").
 				WithReplicas(3).
 				WithVersion("v1.21.1").
+				WithLabels(map[string]string{"foo": "bar"}).
+				WithAnnotations(map[string]string{"fizz": "buzz"}).
 				Build(),
 			want: []runtimehooksv1.Variable{
 				{
@@ -460,6 +462,7 @@ func TestControlPlane(t *testing.T) {
 					Value: toJSONCompact(`{
 					"controlPlane":{
 						"version": "v1.21.1",
+						"metadata": {"labels":{"foo":"bar"}, "annotations":{"fizz":"buzz"}},
 						"name":"controlPlane1",
 						"replicas":3
 					}}`),
@@ -503,6 +506,7 @@ func TestControlPlane(t *testing.T) {
 			controlPlane: builder.ControlPlane(metav1.NamespaceDefault, "controlPlane1").
 				WithReplicas(3).
 				WithVersion("v1.21.1").
+				WithLabels(map[string]string{"foo": "bar"}).
 				Build(),
 			want: []runtimehooksv1.Variable{
 				{
@@ -518,6 +522,7 @@ func TestControlPlane(t *testing.T) {
 					Value: toJSONCompact(`{
 					"controlPlane":{
 						"version": "v1.21.1",
+						"metadata": {"labels":{"foo":"bar"}},
 						"name":"controlPlane1",
 						"replicas":3
 					}}`),
@@ -684,6 +689,8 @@ func TestMachineDeployment(t *testing.T) {
 			md: builder.MachineDeployment(metav1.NamespaceDefault, "md1").
 				WithReplicas(3).
 				WithVersion("v1.21.1").
+				WithLabels(map[string]string{"foo": "bar"}).
+				WithAnnotations(map[string]string{"fizz": "buzz"}).
 				Build(),
 			want: []runtimehooksv1.Variable{
 				{
@@ -699,6 +706,7 @@ func TestMachineDeployment(t *testing.T) {
 					Value: toJSONCompact(`{
 					"machineDeployment":{
 						"version": "v1.21.1",
+						"metadata": {"labels":{"foo":"bar"}, "annotations":{"fizz":"buzz"}},
 						"class": "md-class",
 						"name": "md1",
 						"topologyName": "md-topology",
@@ -1051,6 +1059,8 @@ func TestMachinePool(t *testing.T) {
 			mp: builder.MachinePool(metav1.NamespaceDefault, "mp1").
 				WithReplicas(3).
 				WithVersion("v1.21.1").
+				WithLabels(map[string]string{"foo": "bar"}).
+				WithAnnotations(map[string]string{"fizz": "buzz"}).
 				Build(),
 			want: []runtimehooksv1.Variable{
 				{
@@ -1066,6 +1076,7 @@ func TestMachinePool(t *testing.T) {
 					Value: toJSONCompact(`{
 					"machinePool":{
 						"version": "v1.21.1",
+						"metadata": {"labels":{"foo":"bar"}, "annotations":{"fizz":"buzz"}},
 						"class": "mp-class",
 						"name": "mp1",
 						"topologyName": "mp-topology",

internal/test/builder/builders.go

@@ -1451,6 +1451,18 @@ func (c *TestControlPlaneBuilder) WithVersion(version string) *TestControlPlaneB
 	return c
 }
 
+// WithLabels adds the passed labels to the ControlPlaneBuilder.
+func (c *ControlPlaneBuilder) WithLabels(labels map[string]string) *ControlPlaneBuilder {
+	c.obj.SetLabels(labels)
+	return c
+}
+
+// WithAnnotations adds the passed annotations to the ControlPlaneBuilder.
+func (c *ControlPlaneBuilder) WithAnnotations(annotations map[string]string) *ControlPlaneBuilder {
+	c.obj.SetAnnotations(annotations)
+	return c
+}
+
 // WithSpecFields sets a map of spec fields on the unstructured object. The keys in the map represent the path and the value corresponds
 // to the value of the spec field.
 //
@@ -1522,6 +1534,7 @@ type MachinePoolBuilder struct {
 	clusterName     string
 	replicas        *int32
 	labels          map[string]string
+	annotations     map[string]string
 	status          *expv1.MachinePoolStatus
 	minReadySeconds *int32
 }
@@ -1552,6 +1565,12 @@ func (m *MachinePoolBuilder) WithLabels(labels map[string]string) *MachinePoolBu
 	return m
 }
 
+// WithAnnotations adds the given annotations to the MachinePoolBuilder.
+func (m *MachinePoolBuilder) WithAnnotations(annotations map[string]string) *MachinePoolBuilder {
+	m.annotations = annotations
+	return m
+}
+
 // WithVersion sets the passed version on the MachinePool spec.
 func (m *MachinePoolBuilder) WithVersion(version string) *MachinePoolBuilder {
 	m.version = &version
@@ -1590,9 +1609,10 @@ func (m *MachinePoolBuilder) Build() *expv1.MachinePool {
 			APIVersion: expv1.GroupVersion.String(),
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      m.name,
-			Namespace: m.namespace,
-			Labels:    m.labels,
+			Name:        m.name,
+			Namespace:   m.namespace,
+			Labels:      m.labels,
+			Annotations: m.annotations,
 		},
 		Spec: expv1.MachinePoolSpec{
 			ClusterName:     m.clusterName,
@@ -1630,6 +1650,7 @@ type MachineDeploymentBuilder struct {
 	replicas               *int32
 	generation             *int64
 	labels                 map[string]string
+	annotations            map[string]string
 	status                 *clusterv1.MachineDeploymentStatus
 	minReadySeconds        *int32
 }
@@ -1672,6 +1693,12 @@ func (m *MachineDeploymentBuilder) WithLabels(labels map[string]string) *Machine
 	return m
 }
 
+// WithAnnotations adds the given annotations to the MachineDeploymentBuilder.
+func (m *MachineDeploymentBuilder) WithAnnotations(annotations map[string]string) *MachineDeploymentBuilder {
+	m.annotations = annotations
+	return m
+}
+
 // WithVersion sets the passed version on the machine deployment spec.
 func (m *MachineDeploymentBuilder) WithVersion(version string) *MachineDeploymentBuilder {
 	m.version = &version
@@ -1710,9 +1737,10 @@ func (m *MachineDeploymentBuilder) Build() *clusterv1.MachineDeployment {
 			APIVersion: clusterv1.GroupVersion.String(),
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      m.name,
-			Namespace: m.namespace,
-			Labels:    m.labels,
+			Name:        m.name,
+			Namespace:   m.namespace,
+			Labels:      m.labels,
+			Annotations: m.annotations,
 		},
 	}
 	if m.generation != nil {