Merge pull request #6270 from ykakarap/topology-plan-contract-fix

🐛 fix the version assumption in topology plan command

Author: k8s-ci-robot

cmd/clusterctl/client/cluster/topology.go

@@ -222,6 +222,12 @@ func (t *topologyClient) Plan(in *TopologyPlanInput) (*TopologyPlanOutput, error
 // - no more than 1 cluster in the input.
 // - no more than 1 clusterclass in the input.
 func (t *topologyClient) validateInput(in *TopologyPlanInput) error {
+	// Check if objects of the same Group.Kind are using the same version.
+	// Note: This is because the dryrun client does not guarantee any coversions.
+	if !hasUniqueVersionPerGroupKind(in.Objs) {
+		return fmt.Errorf("objects of the same Group.Kind should use the same apiVersion")
+	}
+
 	// Check all the objects in the input belong to the same namespace.
 	// Note: It is okay if all the objects in the input do not have any namespace.
 	// In such case, the list of unique namespaces will be [""].
@@ -501,6 +507,7 @@ func (t *topologyClient) generateCRDs(objs []*unstructured.Unstructured) []*apie
 	crds := []*apiextensionsv1.CustomResourceDefinition{}
 	crdMap := map[string]bool{}
 	var gvk schema.GroupVersionKind
+
 	for _, obj := range objs {
 		gvk = obj.GroupVersionKind()
 		if strings.HasSuffix(gvk.Group, ".cluster.x-k8s.io") && !crdMap[gvk.String()] {
@@ -512,14 +519,16 @@ func (t *topologyClient) generateCRDs(objs []*unstructured.Unstructured) []*apie
 				ObjectMeta: metav1.ObjectMeta{
 					Name: fmt.Sprintf("%s.%s", flect.Pluralize(strings.ToLower(gvk.Kind)), gvk.Group),
 					Labels: map[string]string{
-						clusterv1.GroupVersion.String(): clusterv1.GroupVersion.Version,
+						// Here we assume that all the versions are compatible with the Cluster API contract version.
+						clusterv1.GroupVersion.String(): gvk.Version,
 					},
 				},
 			}
 			crds = append(crds, crd)
 			crdMap[gvk.String()] = true
 		}
 	}
+
 	return crds
 }
 
@@ -698,3 +707,16 @@ func uniqueNamespaces(objs []*unstructured.Unstructured) []string {
 	}
 	return ns.List()
 }
+
+func hasUniqueVersionPerGroupKind(objs []*unstructured.Unstructured) bool {
+	versionMap := map[string]string{}
+	for _, obj := range objs {
+		gvk := obj.GroupVersionKind()
+		gk := gvk.GroupKind().String()
+		if ver, ok := versionMap[gk]; ok && ver != gvk.Version {
+			return false
+		}
+		versionMap[gk] = gvk.Version
+	}
+	return true
+}

docs/book/src/clusterctl/commands/alpha-topology-plan.md

@@ -424,6 +424,17 @@ or validation on these objects. Defaulting and validation is only run on Cluster
 
 </aside>
 
+<aside class="note warning">
+
+<h1>API Versions and Contract compatibility</h1>
+
+All the objects in the input of the same `Group.Kind` should have the same `apiVersion`. 
+Example: Two `InfraMachineTemplate`s with `apiVersion`s `infrastructure.cluster.x-k8s.io/v1beta1` and `infrastructure.cluster.x-k8s.io/v1alpha4` are not allowed.
+
+The API version of resource in the input should be compatible with the current version of Cluster API contract.
+
+</aside>
+
 ### `--output-directory`, `-o` (REQUIRED)
 
 Information about the objects that are created and updated is written to this directory.