Extend providers interface to support multiple cluster GVKs (#971)

* Extend providers interface to support multiple cluster GVKs

* Make child cluster name configurable from environ

* Find first cluster in `getCluster` and return

Author: s3rj1k

Makefile

@@ -1,4 +1,5 @@
 NAMESPACE ?= kcm-system
+CLUSTER_NAME_SUFFIX ?= dev
 VERSION ?= $(shell git describe --tags --always)
 VERSION := $(patsubst v%,%,$(VERSION))
 FQDN_VERSION = $(subst .,-,$(VERSION))
@@ -370,11 +371,11 @@ dev-destroy: kind-undeploy registry-undeploy ## Destroy the development environm
 
 .PHONY: dev-mcluster-apply
 dev-mcluster-apply: envsubst ## Create dev managed cluster using 'config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml'
-	@NAMESPACE=$(NAMESPACE) $(ENVSUBST) -no-unset -i config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml | $(KUBECTL) apply -f -
+	@NAMESPACE=$(NAMESPACE) CLUSTER_NAME_SUFFIX=$(CLUSTER_NAME_SUFFIX) $(ENVSUBST) -no-unset -i config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml | $(KUBECTL) apply -f -
 
 .PHONY: dev-mcluster-delete
 dev-mcluster-delete: envsubst ## Delete dev managed cluster using 'config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml'
-	@NAMESPACE=$(NAMESPACE) $(ENVSUBST) -no-unset -i config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml | $(KUBECTL) delete -f -
+	@NAMESPACE=$(NAMESPACE) CLUSTER_NAME_SUFFIX=$(CLUSTER_NAME_SUFFIX) $(ENVSUBST) -no-unset -i config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml | $(KUBECTL) delete -f -
 
 .PHONY: dev-creds-apply
 dev-creds-apply: dev-$(DEV_PROVIDER)-creds ## Create credentials resources for $DEV_PROVIDER

config/dev/adopted-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: adopted-dev
+  name: adopted-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: adopted-cluster-0-0-2

config/dev/aks-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: azure-aks-dev
+  name: azure-aks-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: azure-aks-0-0-2

config/dev/aws-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: aws-dev
+  name: aws-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: aws-standalone-cp-0-0-6

config/dev/azure-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: azure-dev
+  name: azure-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: azure-standalone-cp-0-0-6

config/dev/eks-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: eks-dev
+  name: eks-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: aws-eks-0-0-4

config/dev/openstack-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: openstack-dev
+  name: openstack-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: openstack-standalone-cp-0-0-5

config/dev/vsphere-clusterdeployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: k0rdent.mirantis.com/v1alpha1
 kind: ClusterDeployment
 metadata:
-  name: vsphere-dev
+  name: vsphere-${CLUSTER_NAME_SUFFIX}
   namespace: ${NAMESPACE}
 spec:
   template: vsphere-standalone-cp-0-0-6

internal/controller/clusterdeployment_controller.go

@@ -649,12 +649,12 @@ func (r *ClusterDeploymentReconciler) releaseCluster(ctx context.Context, namesp
 
 	// Associate the provider with it's GVK
 	for _, provider := range providers {
-		gvk := providersloader.GetClusterGVK(provider)
-		if !gvk.Empty() {
+		gvks := providersloader.GetClusterGVKs(provider)
+		if len(gvks) == 0 {
 			continue
 		}
 
-		cluster, err := r.getCluster(ctx, namespace, name, gvk)
+		cluster, err := r.getCluster(ctx, namespace, name, gvks...)
 		if err != nil {
 			if provider == "aws" && apierrors.IsNotFound(err) {
 				return nil
@@ -665,7 +665,7 @@ func (r *ClusterDeploymentReconciler) releaseCluster(ctx context.Context, namesp
 
 		found, err := r.objectsAvailable(ctx, namespace, cluster.Name, gvkMachine)
 		if err != nil {
-			return err
+			continue
 		}
 
 		if !found {
@@ -697,21 +697,25 @@ func (r *ClusterDeploymentReconciler) getInfraProvidersNames(ctx context.Context
 	return ips[:len(ips):len(ips)], nil
 }
 
-func (r *ClusterDeploymentReconciler) getCluster(ctx context.Context, namespace, name string, gvk schema.GroupVersionKind) (*metav1.PartialObjectMetadata, error) {
-	opts := &client.ListOptions{
-		LabelSelector: labels.SelectorFromSet(map[string]string{kcm.FluxHelmChartNameKey: name}),
-		Namespace:     namespace,
-	}
-	itemsList := &metav1.PartialObjectMetadataList{}
-	itemsList.SetGroupVersionKind(gvk)
-	if err := r.Client.List(ctx, itemsList, opts); err != nil {
-		return nil, err
-	}
-	if len(itemsList.Items) == 0 {
-		return nil, fmt.Errorf("%s with name %s was not found", gvk.Kind, name)
+func (r *ClusterDeploymentReconciler) getCluster(ctx context.Context, namespace, name string, gvks ...schema.GroupVersionKind) (*metav1.PartialObjectMetadata, error) {
+	for _, gvk := range gvks {
+		opts := &client.ListOptions{
+			LabelSelector: labels.SelectorFromSet(map[string]string{kcm.FluxHelmChartNameKey: name}),
+			Namespace:     namespace,
+		}
+		itemsList := &metav1.PartialObjectMetadataList{}
+		itemsList.SetGroupVersionKind(gvk)
+
+		if err := r.Client.List(ctx, itemsList, opts); err != nil {
+			return nil, fmt.Errorf("failed to list %s in namespace %s: %w", gvk.Kind, namespace, err)
+		}
+
+		if len(itemsList.Items) > 0 {
+			return &itemsList.Items[0], nil
+		}
 	}
 
-	return &itemsList.Items[0], nil
+	return nil, fmt.Errorf("no cluster found with name %s in namespace %s for any of the provided GroupVersionKinds", name, namespace)
 }
 
 func (r *ClusterDeploymentReconciler) removeClusterFinalizer(ctx context.Context, cluster *metav1.PartialObjectMetadata) error {

internal/providers/providers.go

@@ -50,8 +50,8 @@ var (
 type ProviderModule interface {
 	// GetName returns the short name of the provider
 	GetName() string
-	// GetClusterGVK returns the GroupVersionKind for the provider's cluster resource
-	GetClusterGVK() schema.GroupVersionKind
+	// GetClusterGVKs returns the GroupVersionKind for the provider's cluster resource
+	GetClusterGVKs() []schema.GroupVersionKind
 	// GetClusterIdentityKinds returns a list of supported cluster identity kinds
 	GetClusterIdentityKinds() []string
 }
@@ -85,17 +85,17 @@ func List() []kcm.Provider {
 	return slices.Clone(providers)
 }
 
-// GetClusterGVK returns the GroupVersionKind for a provider's cluster resource
-func GetClusterGVK(shortName string) schema.GroupVersionKind {
+// GetClusterGVKs returns the GroupVersionKind for a provider's cluster resource
+func GetClusterGVKs(shortName string) []schema.GroupVersionKind {
 	mu.RLock()
 	defer mu.RUnlock()
 
 	module, ok := registry[shortName]
 	if !ok {
-		return schema.GroupVersionKind{}
+		return nil
 	}
 
-	return module.GetClusterGVK()
+	return module.GetClusterGVKs()
 }
 
 // GetClusterIdentityKinds returns the supported identity kinds for a given infrastructure provider

internal/providers/yaml.go

@@ -24,18 +24,11 @@ import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
 )
 
-// GVK represents the GroupVersionKind structure in YAML.
-type GVK struct {
-	Group   string `yaml:"group"`
-	Version string `yaml:"version"`
-	Kind    string `yaml:"kind"`
-}
-
 // YAMLProviderDefinition represents a YAML-based provider configuration.
 type YAMLProviderDefinition struct {
-	Name                 string   `yaml:"name"`
-	ClusterGVK           GVK      `yaml:"clusterGVK"`
-	ClusterIdentityKinds []string `yaml:"clusterIdentityKinds"`
+	Name                 string                    `yaml:"name"`
+	ClusterGVKs          []schema.GroupVersionKind `yaml:"clusterGVKs"`
+	ClusterIdentityKinds []string                  `yaml:"clusterIdentityKinds"`
 }
 
 var _ ProviderModule = (*YAMLProviderDefinition)(nil)
@@ -44,12 +37,20 @@ func (p *YAMLProviderDefinition) GetName() string {
 	return p.Name
 }
 
-func (p *YAMLProviderDefinition) GetClusterGVK() schema.GroupVersionKind {
-	return schema.GroupVersionKind{
-		Group:   p.ClusterGVK.Group,
-		Version: p.ClusterGVK.Version,
-		Kind:    p.ClusterGVK.Kind,
+func (p *YAMLProviderDefinition) GetClusterGVKs() []schema.GroupVersionKind {
+	if len(p.ClusterGVKs) == 0 {
+		return nil
 	}
+
+	result := make([]schema.GroupVersionKind, 0, len(p.ClusterGVKs))
+
+	for _, gvk := range p.ClusterGVKs {
+		if !gvk.Empty() {
+			result = append(result, gvk)
+		}
+	}
+
+	return result
 }
 
 func (p *YAMLProviderDefinition) GetClusterIdentityKinds() []string {

providers/aws.yml

@@ -13,11 +13,11 @@
 # limitations under the License.
 
 name: aws
-clusterGVK:
-  group: infrastructure.cluster.x-k8s.io
-  version: v1beta2
-  kind: AWSCluster
+clusterGVKs:
+  - group: infrastructure.cluster.x-k8s.io
+    version: v1beta2
+    kind: AWSCluster
 clusterIdentityKinds:
   - AWSClusterStaticIdentity
   - AWSClusterRoleIdentity
-  - AWSClusterControllerIdentity
+  - AWSClusterControllerIdentity

providers/azure.yml

@@ -13,10 +13,10 @@
 # limitations under the License.
 
 name: azure
-clusterGVK:
-  group: infrastructure.cluster.x-k8s.io
-  version: v1beta1
-  kind: AzureCluster
+clusterGVKs:
+  - group: infrastructure.cluster.x-k8s.io
+    version: v1beta1
+    kind: AzureCluster
 clusterIdentityKinds:
   - AzureClusterIdentity
   - Secret

providers/openstack.yml

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 name: openstack
-clusterGVK:
-  group: infrastructure.cluster.x-k8s.io
-  version: v1beta1
-  kind: OpenStackCluster
+clusterGVKs:
+  - group: infrastructure.cluster.x-k8s.io
+    version: v1beta1
+    kind: OpenStackCluster
 clusterIdentityKinds:
   - Secret

providers/vsphere.yml

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 name: vsphere
-clusterGVK:
-  group: infrastructure.cluster.x-k8s.io
-  version: v1beta1
-  kind: VSphereCluster
+clusterGVKs:
+  - group: infrastructure.cluster.x-k8s.io
+    version: v1beta1
+    kind: VSphereCluster
 clusterIdentityKinds:
   - VSphereClusterIdentity