⚠️ Restructure classRef field in Cluster.spec.topology (#12235)

* Restructure classRef field in Cluster.spec.topology

Signed-off-by: Stefan Büringer buringerst@vmware.com

* Fix review findings

* Simplify field patterns

---------

Signed-off-by: Stefan Büringer buringerst@vmware.com

Author: sbueringer

api/v1beta1/cluster_types.go

@@ -546,13 +546,15 @@ type Topology struct {
 	// +kubebuilder:validation:MaxLength=253
 	Class string `json:"class"`
 
-	// classNamespace is the namespace of the ClusterClass object to create the topology.
-	// If the namespace is empty or not set, it is defaulted to the namespace of the cluster object.
-	// Value must follow the DNS1123Subdomain syntax.
+	// classNamespace is the namespace of the ClusterClass that should be used for the topology.
+	// If classNamespace is empty or not set, it is defaulted to the namespace of the Cluster object.
+	// classNamespace must be a valid namespace name and because of that be at most 63 characters in length
+	// and it must consist only of lower case alphanumeric characters or hyphens (-), and must start
+	// and end with an alphanumeric character.
 	// +optional
 	// +kubebuilder:validation:MinLength=1
-	// +kubebuilder:validation:MaxLength=253
-	// +kubebuilder:validation:Pattern=`^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\.[a-z0-9](?:[-a-z0-9]*[a-z0-9])?)*$`
+	// +kubebuilder:validation:MaxLength=63
+	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
 	ClassNamespace string `json:"classNamespace,omitempty"`
 
 	// version is the Kubernetes version of the cluster.

api/v1beta1/conversion.go

@@ -247,6 +247,16 @@ func Convert_v1beta2_ClusterStatus_To_v1beta1_ClusterStatus(in *clusterv1.Cluste
 	return nil
 }
 
+func Convert_v1beta1_Topology_To_v1beta2_Topology(in *Topology, out *clusterv1.Topology, s apimachineryconversion.Scope) error {
+	if err := autoConvert_v1beta1_Topology_To_v1beta2_Topology(in, out, s); err != nil {
+		return err
+	}
+
+	out.ClassRef.Name = in.Class
+	out.ClassRef.Namespace = in.ClassNamespace
+	return nil
+}
+
 func Convert_v1beta1_ClusterStatus_To_v1beta2_ClusterStatus(in *ClusterStatus, out *clusterv1.ClusterStatus, s apimachineryconversion.Scope) error {
 	if err := autoConvert_v1beta1_ClusterStatus_To_v1beta2_ClusterStatus(in, out, s); err != nil {
 		return err
@@ -307,6 +317,16 @@ func Convert_v1beta1_ClusterStatus_To_v1beta2_ClusterStatus(in *ClusterStatus, o
 	return nil
 }
 
+func Convert_v1beta2_Topology_To_v1beta1_Topology(in *clusterv1.Topology, out *Topology, s apimachineryconversion.Scope) error {
+	if err := autoConvert_v1beta2_Topology_To_v1beta1_Topology(in, out, s); err != nil {
+		return err
+	}
+
+	out.Class = in.ClassRef.Name
+	out.ClassNamespace = in.ClassRef.Namespace
+	return nil
+}
+
 func Convert_v1beta2_MachineDeploymentStatus_To_v1beta1_MachineDeploymentStatus(in *clusterv1.MachineDeploymentStatus, out *MachineDeploymentStatus, s apimachineryconversion.Scope) error {
 	if err := autoConvert_v1beta2_MachineDeploymentStatus_To_v1beta1_MachineDeploymentStatus(in, out, s); err != nil {
 		return err

api/v1beta1/zz_generated.conversion.go

@@ -538,20 +538,9 @@ type ClusterAvailabilityGate struct {
 
 // Topology encapsulates the information of the managed resources.
 type Topology struct {
-	// class is the name of the ClusterClass object to create the topology.
+	// classRef is the ref to the ClusterClass that should be used for the topology.
 	// +required
-	// +kubebuilder:validation:MinLength=1
-	// +kubebuilder:validation:MaxLength=253
-	Class string `json:"class"`
-
-	// classNamespace is the namespace of the ClusterClass object to create the topology.
-	// If the namespace is empty or not set, it is defaulted to the namespace of the cluster object.
-	// Value must follow the DNS1123Subdomain syntax.
-	// +optional
-	// +kubebuilder:validation:MinLength=1
-	// +kubebuilder:validation:MaxLength=253
-	// +kubebuilder:validation:Pattern=`^[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\.[a-z0-9](?:[-a-z0-9]*[a-z0-9])?)*$`
-	ClassNamespace string `json:"classNamespace,omitempty"`
+	ClassRef ClusterClassRef `json:"classRef"`
 
 	// version is the Kubernetes version of the cluster.
 	// +required
@@ -586,6 +575,30 @@ type Topology struct {
 	Variables []ClusterVariable `json:"variables,omitempty"`
 }
 
+// ClusterClassRef is the ref to the ClusterClass that should be used for the topology.
+type ClusterClassRef struct {
+	// name is the name of the ClusterClass that should be used for the topology.
+	// name must be a valid ClusterClass name and because of that be at most 253 characters in length
+	// and it must consist only of lower case alphanumeric characters, hyphens (-) and periods (.), and must start
+	// and end with an alphanumeric character.
+	// +required
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=253
+	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
+	Name string `json:"name"`
+
+	// namespace is the namespace of the ClusterClass that should be used for the topology.
+	// If namespace is empty or not set, it is defaulted to the namespace of the Cluster object.
+	// namespace must be a valid namespace name and because of that be at most 63 characters in length
+	// and it must consist only of lower case alphanumeric characters or hyphens (-), and must start
+	// and end with an alphanumeric character.
+	// +optional
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=63
+	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
+	Namespace string `json:"namespace,omitempty"`
+}
+
 // ControlPlaneTopology specifies the parameters for the control plane nodes in the cluster.
 type ControlPlaneTopology struct {
 	// metadata is the metadata applied to the ControlPlane and the Machines of the ControlPlane
@@ -1180,8 +1193,8 @@ func (c *Cluster) GetClassKey() types.NamespacedName {
 		return types.NamespacedName{}
 	}
 
-	namespace := cmp.Or(c.Spec.Topology.ClassNamespace, c.Namespace)
-	return types.NamespacedName{Namespace: namespace, Name: c.Spec.Topology.Class}
+	namespace := cmp.Or(c.Spec.Topology.ClassRef.Namespace, c.Namespace)
+	return types.NamespacedName{Namespace: namespace, Name: c.Spec.Topology.ClassRef.Name}
 }
 
 // GetV1Beta1Conditions returns the set of conditions for this object.

api/v1beta1/zz_generated.openapi.go

@@ -46,7 +46,9 @@ func TestClusterByClusterClassRef(t *testing.T) {
 				},
 				Spec: clusterv1.ClusterSpec{
 					Topology: &clusterv1.Topology{
-						Class: "class1",
+						ClassRef: clusterv1.ClusterClassRef{
+							Name: "class1",
+						},
 					},
 				},
 			},
@@ -61,8 +63,10 @@ func TestClusterByClusterClassRef(t *testing.T) {
 				},
 				Spec: clusterv1.ClusterSpec{
 					Topology: &clusterv1.Topology{
-						Class:          "class1",
-						ClassNamespace: "other",
+						ClassRef: clusterv1.ClusterClassRef{
+							Name:      "class1",
+							Namespace: "other",
+						},
 					},
 				},
 			},

api/v1beta2/cluster_types.go

@@ -26,7 +26,8 @@ spec:
     name: my-cluster-zrq96
     namespace: default
   topology:
-    class: my-cluster-class
+    classRef:
+      name: my-cluster-class
     version: v1.21.2
     controlPlane:
       metadata: {}

api/v1beta2/index/cluster_test.go

@@ -27,7 +27,8 @@ spec:
     name: my-second-cluster-zrq96
     namespace: default
   topology:
-    class: my-cluster-class
+    classRef:
+      name: my-cluster-class
     version: v1.21.2
     controlPlane:
       metadata: {}

api/v1beta2/zz_generated.deepcopy.go

@@ -13,7 +13,8 @@ spec:
       cidrBlocks: ["192.168.0.0/16"]
     serviceDomain: "cluster.local"
   topology:
-    class: my-cluster-class
+    classRef:
+      name: my-cluster-class
     version: v1.21.2
     controlPlane:
       metadata: {}

api/v1beta2/zz_generated.openapi.go

@@ -186,7 +186,8 @@ spec:
       cidrBlocks: ["192.168.0.0/16"]
     serviceDomain: "cluster.local"
   topology:
-    class: my-cluster-class
+    classRef:
+      name: my-cluster-class
     version: v1.21.2
     controlPlane:
       metadata: {}