Restructure classRef field in Cluster.spec.topology

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

Author: sbueringer

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.ClassNamespace = in.ClassRef.Namespace
+	out.Class = in.ClassRef.Name
+	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

@@ -536,22 +536,29 @@ type ClusterAvailabilityGate struct {
 	Polarity ConditionPolarity `json:"polarity,omitempty"`
 }
 
-// Topology encapsulates the information of the managed resources.
-type Topology struct {
-	// class is the name of the ClusterClass object to create the topology.
+// 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.
 	// +required
 	// +kubebuilder:validation:MinLength=1
 	// +kubebuilder:validation:MaxLength=253
-	Class string `json:"class"`
+	Name string `json:"name"`
 
-	// classNamespace is the namespace of the ClusterClass object to create the topology.
+	// namespace is the namespace of the ClusterClass that should be used for 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"`
+	Namespace string `json:"namespace,omitempty"`
+}
+
+// Topology encapsulates the information of the managed resources.
+type Topology struct {
+	// classRef is the ref to the ClusterClass that should be used for the topology.
+	// +required
+	ClassRef ClusterClassRef `json:"classRef"`
 
 	// version is the Kubernetes version of the cluster.
 	// +required
@@ -1180,8 +1187,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/v1beta2/cluster_types.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/index/cluster_test.go

@@ -827,13 +827,13 @@ func (o *objectGraph) setShouldNotDelete(ctx context.Context, namespace string)
 		}
 
 		// ignore cluster not referencing a CC in the namespace being moved.
-		if cluster.Spec.Topology.ClassNamespace != namespace {
+		if cluster.Spec.Topology.ClassRef.Namespace != namespace {
 			continue
 		}
 
 		// Otherwise mark the referenced CC as should not be deleted.
 		for _, class := range o.getClusterClasses() {
-			if class.identity.Namespace == cluster.Spec.Topology.ClassNamespace && class.identity.Name == cluster.Spec.Topology.Class {
+			if class.identity.Namespace == cluster.Spec.Topology.ClassRef.Namespace && class.identity.Name == cluster.Spec.Topology.ClassRef.Name {
 				class.shouldNotDelete = true
 				// Ensure that also the templates referenced by the CC won't be deleted.
 				o.setShouldNotDeleteHierarchy(class)

api/v1beta2/zz_generated.deepcopy.go

@@ -219,10 +219,11 @@ func TestAddClusterClassIfMissing(t *testing.T) {
 				fmt.Sprintf("  namespace: %s\n", tt.targetNamespace) +
 				"spec:\n" +
 				"  topology:\n" +
-				"    class: dev"
+				"    classRef:\n" +
+				"      name: dev"
 
 			if tt.clusterClassNamespace != "" {
-				clusterWithTopology = fmt.Sprintf("%s\n    classNamespace: %s", clusterWithTopology, tt.clusterClassNamespace)
+				clusterWithTopology = fmt.Sprintf("%s\n      namespace: %s", clusterWithTopology, tt.clusterClassNamespace)
 			}
 
 			baseTemplate, err := repository.NewTemplate(repository.TemplateInput{

api/v1beta2/zz_generated.openapi.go

@@ -967,7 +967,8 @@ func mangedTopologyTemplateYAML(ns, clusterName, clusterClassName string) []byte
 		fmt.Sprintf("  namespace: %s\n", ns) +
 		"spec:\n" +
 		"  topology:\n" +
-		fmt.Sprintf("    class: %s", clusterClassName))
+		"    classRef:\n" +
+		fmt.Sprintf("      name: %s", clusterClassName))
 }
 
 func clusterClassYAML(ns, clusterClassName string) []byte {

cmd/clusterctl/client/cluster/objectgraph.go

@@ -152,9 +152,13 @@ func (f *FakeCluster) Objs() []client.Object {
 	}
 
 	if f.topologyClass != nil {
-		cluster.Spec.Topology = &clusterv1.Topology{Class: *f.topologyClass}
+		cluster.Spec.Topology = &clusterv1.Topology{
+			ClassRef: clusterv1.ClusterClassRef{
+				Name: *f.topologyClass,
+			},
+		}
 		if f.topologyClassNamespace != nil {
-			cluster.Spec.Topology.ClassNamespace = *f.topologyClassNamespace
+			cluster.Spec.Topology.ClassRef.Namespace = *f.topologyClassNamespace
 		}
 	}
 

cmd/clusterctl/client/clusterclass_test.go

@@ -454,8 +454,9 @@ metadata:
   namespace: default
 spec:
   topology:
-    class: docker-clusterclass-v0.1.0
-    classNamespace: default
+    classRef:
+      name: docker-clusterclass-v0.1.0
+      namespace: default
     version: v1.22.4
     controlPlane:
       replicas: 3
@@ -491,7 +492,7 @@ spec:
       operations:  ["CREATE", "UPDATE"]
       resources:   ["clusters"]
   validations:
-    - expression: "!has(object.spec.topology.classNamespace) || object.spec.topology.classNamespace in params.data"
+    - expression: "!has(object.spec.topology.classRef.namespace) || object.spec.topology.classRef.namespace in params.data"
 ---
 apiVersion: admissionregistration.k8s.io/v1
 kind: ValidatingAdmissionPolicyBinding