Expose clusterctl provider dependent logic for custom provider

Danil-Grigorev · Danil-Grigorev · commit 8014960c0778 · 2025-07-16T17:39:41.000+02:00
Signed-off-by: Danil-Grigorev &lt;danil.grigorev@suse.com&gt;
diff --git a/api/v1alpha2/addonprovider_wrapper.go b/api/v1alpha2/addonprovider_wrapper.go
@@ -50,6 +50,10 @@ func (b *AddonProvider) GetType() string {
 	return "addon"
 }
 
+func (b *AddonProvider) ProviderName() string {
+	return b.GetName()
+}
+
 func (b *AddonProviderList) GetItems() []GenericProvider {
 	providers := []GenericProvider{}
 
diff --git a/api/v1alpha2/bootstrapprovider_wrapper.go b/api/v1alpha2/bootstrapprovider_wrapper.go
@@ -50,6 +50,10 @@ func (b *BootstrapProvider) GetType() string {
 	return "bootstrap"
 }
 
+func (b *BootstrapProvider) ProviderName() string {
+	return b.GetName()
+}
+
 func (b *BootstrapProviderList) GetItems() []GenericProvider {
 	providers := []GenericProvider{}
 
diff --git a/api/v1alpha2/controlplaneprovider_wrapper.go b/api/v1alpha2/controlplaneprovider_wrapper.go
@@ -50,6 +50,10 @@ func (c *ControlPlaneProvider) GetType() string {
 	return "controlplane"
 }
 
+func (c *ControlPlaneProvider) ProviderName() string {
+	return c.GetName()
+}
+
 func (c *ControlPlaneProviderList) GetItems() []GenericProvider {
 	providers := make([]GenericProvider, len(c.Items))
 
diff --git a/api/v1alpha2/coreprovider_wrapper.go b/api/v1alpha2/coreprovider_wrapper.go
@@ -50,6 +50,10 @@ func (c *CoreProvider) GetType() string {
 	return "core"
 }
 
+func (c *CoreProvider) ProviderName() string {
+	return c.GetName()
+}
+
 func (c *CoreProviderList) GetItems() []GenericProvider {
 	providers := make([]GenericProvider, len(c.Items))
 
diff --git a/api/v1alpha2/genericprovider_interfaces.go b/api/v1alpha2/genericprovider_interfaces.go
@@ -30,6 +30,7 @@ type GenericProvider interface {
 	GetStatus() ProviderStatus
 	SetStatus(in ProviderStatus)
 	GetType() string
+	ProviderName() string
 }
 
 // GenericProviderList interface describes operations applicable to the provider list type.
diff --git a/api/v1alpha2/infrastructureprovider_wrapper.go b/api/v1alpha2/infrastructureprovider_wrapper.go
@@ -50,6 +50,10 @@ func (c *InfrastructureProvider) GetType() string {
 	return "infrastructure"
 }
 
+func (c *InfrastructureProvider) ProviderName() string {
+	return c.GetName()
+}
+
 func (c *InfrastructureProviderList) GetItems() []GenericProvider {
 	providers := make([]GenericProvider, len(c.Items))
 
diff --git a/api/v1alpha2/ipamprovider_wrapper.go b/api/v1alpha2/ipamprovider_wrapper.go
@@ -50,6 +50,10 @@ func (p *IPAMProvider) GetType() string {
 	return "ipam"
 }
 
+func (p *IPAMProvider) ProviderName() string {
+	return p.GetName()
+}
+
 func (p *IPAMProviderList) GetItems() []GenericProvider {
 	providers := []GenericProvider{}
 
diff --git a/api/v1alpha2/runtimeextensionprovider_wrapper.go b/api/v1alpha2/runtimeextensionprovider_wrapper.go
@@ -50,6 +50,10 @@ func (p *RuntimeExtensionProvider) GetType() string {
 	return "runtimeextension"
 }
 
+func (p *RuntimeExtensionProvider) ProviderName() string {
+	return p.GetName()
+}
+
 func (p *RuntimeExtensionProviderList) GetItems() []GenericProvider {
 	providers := []GenericProvider{}
 
diff --git a/cmd/plugin/cmd/init_test.go b/cmd/plugin/cmd/init_test.go
@@ -324,7 +324,7 @@ func TestInitProviders(t *testing.T) {
 
 			for _, genericProvider := range tt.wantedProviders {
 				g.Eventually(func() (bool, error) {
-					provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.GetName(), genericProvider.GetNamespace())
+					provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.ProviderName(), genericProvider.GetNamespace())
 					if err != nil {
 						return false, err
 					}
diff --git a/cmd/plugin/cmd/preload.go b/cmd/plugin/cmd/preload.go
@@ -313,7 +313,7 @@ func templateConfigMap(ctx context.Context, providerType clusterctlv1.ProviderTy
 		return nil, fmt.Errorf("cannot create config client: %w", err)
 	}
 
-	providerConfig, err := configClient.Providers().Get(provider.GetName(), util.ClusterctlProviderType(provider))
+	providerConfig, err := configClient.Providers().Get(provider.ProviderName(), util.ClusterctlProviderType(provider))
 	if err != nil {
 		if !strings.Contains(err.Error(), "failed to get configuration") {
 			return nil, err
@@ -340,7 +340,7 @@ func providerConfigMap(ctx context.Context, provider operatorv1.GenericProvider)
 
 	// If provided store fetch config url in memory reader.
 	if provider.GetSpec().FetchConfig != nil && provider.GetSpec().FetchConfig.URL != "" {
-		_, err := mr.AddProvider(provider.GetName(), util.ClusterctlProviderType(provider), provider.GetSpec().FetchConfig.URL)
+		_, err := mr.AddProvider(provider.ProviderName(), util.ClusterctlProviderType(provider), provider.GetSpec().FetchConfig.URL)
 		if err != nil {
 			return nil, fmt.Errorf("cannot add custom url provider: %w", err)
 		}
@@ -351,7 +351,7 @@ func providerConfigMap(ctx context.Context, provider operatorv1.GenericProvider)
 		return nil, fmt.Errorf("cannot create config client: %w", err)
 	}
 
-	providerConfig, err := configClient.Providers().Get(provider.GetName(), util.ClusterctlProviderType(provider))
+	providerConfig, err := configClient.Providers().Get(provider.ProviderName(), util.ClusterctlProviderType(provider))
 	if err != nil {
 		if !strings.Contains(err.Error(), "failed to get configuration") {
 			return nil, err
diff --git a/cmd/plugin/cmd/upgrade_plan.go b/cmd/plugin/cmd/upgrade_plan.go
@@ -331,7 +331,7 @@ func planUpgrade(ctx context.Context, client ctrlclient.Client) (upgradePlan, er
 		}
 
 		upgradeItems = append(upgradeItems, upgradeItem{
-			Name:           genericProvider.GetName(),
+			Name:           genericProvider.ProviderName(),
 			Namespace:      genericProvider.GetNamespace(),
 			Type:           genericProvider.GetType(),
 			CurrentVersion: genericProvider.GetSpec().Version,
@@ -448,7 +448,7 @@ func getProviderFetchConfig(ctx context.Context, genericProvider operatorv1.Gene
 		return "", "", err
 	}
 
-	providerConfig, err := configClient.Providers().Get(genericProvider.GetName(), util.ClusterctlProviderType(genericProvider))
+	providerConfig, err := configClient.Providers().Get(genericProvider.ProviderName(), util.ClusterctlProviderType(genericProvider))
 	if err != nil {
 		// TODO: implement support of fetching data from config maps
 		// This is a temporary fix for providers installed from config maps
diff --git a/cmd/plugin/cmd/upgrade_plan_test.go b/cmd/plugin/cmd/upgrade_plan_test.go
@@ -117,7 +117,7 @@ func TestUpgradePlan(t *testing.T) {
 
 			for _, genericProvider := range tt.wantedProviders {
 				g.Eventually(func() (bool, error) {
-					provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.GetName(), genericProvider.GetNamespace())
+					provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.ProviderName(), genericProvider.GetNamespace())
 					if err != nil {
 						return false, err
 					}
@@ -133,7 +133,7 @@ func TestUpgradePlan(t *testing.T) {
 			// Init doesn't support custom URLs yet, so we have to update providers here
 			if tt.customURL != "" {
 				for _, genericProvider := range tt.wantedProviders {
-					provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.GetName(), genericProvider.GetNamespace())
+					provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.ProviderName(), genericProvider.GetNamespace())
 					g.Expect(err).NotTo(HaveOccurred())
 
 					spec := provider.GetSpec()
@@ -146,7 +146,7 @@ func TestUpgradePlan(t *testing.T) {
 					g.Expect(env.Update(ctx, provider)).NotTo(HaveOccurred())
 
 					g.Eventually(func() (bool, error) {
-						provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.GetName(), genericProvider.GetNamespace())
+						provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.ProviderName(), genericProvider.GetNamespace())
 						if err != nil {
 							return false, err
 						}
diff --git a/controller/alias.go b/controller/alias.go
@@ -39,3 +39,30 @@ type Result = providercontroller.Result
 
 // NewPhaseReconciler is an alias for the internal NewPhaseReconciler function.
 var NewPhaseReconciler = providercontroller.NewPhaseReconciler
+
+// ProviderTypeMapper is an alias for the internal ProviderTypeMapper type.
+type ProviderTypeMapper = providercontroller.ProviderTypeMapper
+
+// WithProviderTypeMapper is an alias for the internal WithProviderTypeMapper function.
+var WithProviderTypeMapper = providercontroller.WithProviderTypeMapper
+
+// ProviderConverter is an alias for the internal ProviderConverter type.
+type ProviderConverter = providercontroller.ProviderConverter
+
+// WithProviderConverter is an alias for the internal WithProviderConverter function.
+var WithProviderConverter = providercontroller.WithProviderConverter
+
+// ProviderLister is an alias for the internal ProviderLister type.
+type ProviderLister = providercontroller.ProviderLister
+
+// ProviderOperation is an alias for the internal ProviderOperation type.
+type ProviderOperation = providercontroller.ProviderOperation
+
+// WithProviderLister is an alias for the internal WithProviderLister function.
+var WithProviderLister = providercontroller.WithProviderLister
+
+// ProviderMapper is an alias for the internal ProviderMapper type.
+type ProviderMapper = providercontroller.ProviderMapper
+
+// WithProviderMapper is an alias for the internal WithProviderMapper function.
+var WithProviderMapper = providercontroller.WithProviderMapper
diff --git a/internal/controller/client_proxy.go b/internal/controller/client_proxy.go
@@ -29,7 +29,6 @@ import (
 	"k8s.io/client-go/rest"
 	"k8s.io/klog/v2"
 
-	operatorv1 "sigs.k8s.io/cluster-api-operator/api/v1alpha2"
 	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/cluster"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/repository"
@@ -40,12 +39,13 @@ import (
 // interact with the management cluster.
 type clientProxy struct {
 	client.Client
+	lister ProviderLister
 }
 
 func (c clientProxy) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error {
 	switch l := list.(type) {
 	case *clusterctlv1.ProviderList:
-		return listProviders(ctx, c.Client, l)
+		return c.lister(ctx, l)
 	default:
 		return c.Client.List(ctx, l, opts...)
 	}
@@ -69,34 +69,6 @@ func (c clientProxy) Patch(ctx context.Context, obj client.Object, patch client.
 	}
 }
 
-func listProviders(ctx context.Context, cl client.Client, list *clusterctlv1.ProviderList) error {
-	providers := []operatorv1.GenericProviderList{
-		&operatorv1.CoreProviderList{},
-		&operatorv1.InfrastructureProviderList{},
-		&operatorv1.BootstrapProviderList{},
-		&operatorv1.ControlPlaneProviderList{},
-		&operatorv1.AddonProviderList{},
-		&operatorv1.IPAMProviderList{},
-	}
-
-	for _, group := range providers {
-		g, ok := group.(client.ObjectList)
-		if !ok {
-			continue
-		}
-
-		if err := cl.List(ctx, g); err != nil {
-			return err
-		}
-
-		for _, p := range group.GetItems() {
-			list.Items = append(list.Items, getProvider(p, ""))
-		}
-	}
-
-	return nil
-}
-
 // controllerProxy implements the Proxy interface from the clusterctl. It is used to
 // interact with the management cluster.
 type controllerProxy struct {
diff --git a/internal/controller/genericprovider_controller.go b/internal/controller/genericprovider_controller.go
@@ -23,6 +23,7 @@ import (
 	"errors"
 	"fmt"
 	"hash"
+	"os"
 
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -32,7 +33,9 @@ import (
 	"k8s.io/client-go/rest"
 	operatorv1 "sigs.k8s.io/cluster-api-operator/api/v1alpha2"
 	"sigs.k8s.io/cluster-api-operator/internal/controller/genericprovider"
+	"sigs.k8s.io/cluster-api-operator/util"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	configclient "sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
 	"sigs.k8s.io/cluster-api/util/conditions"
 	"sigs.k8s.io/cluster-api/util/patch"
@@ -312,6 +315,36 @@ func providerHash(ctx context.Context, client client.Client, hash hash.Hash, pro
 	return nil
 }
 
+// listProviders lists all providers in the cluster and applies the given operations to them.
+func (r *GenericProviderReconciler) listProviders(ctx context.Context, list *clusterctlv1.ProviderList, ops ...ProviderOperation) error {
+	for _, group := range operatorv1.ProviderLists {
+		g, ok := group.(client.ObjectList)
+		if !ok {
+			continue
+		}
+
+		if err := r.Client.List(ctx, g); err != nil {
+			return err
+		}
+
+		for _, p := range group.GetItems() {
+			for _, op := range ops {
+				if err := op(p); err != nil {
+					return err
+				}
+			}
+
+			list.Items = append(list.Items, convertProvider(p))
+		}
+	}
+
+	return nil
+}
+
+func (r *GenericProviderReconciler) providerMapper(ctx context.Context, provider configclient.Provider) (operatorv1.GenericProvider, error) {
+	return util.GetGenericProvider(ctx, r.Client, provider)
+}
+
 // ApplyFromCache applies provider configuration from cache and returns true if the cache did not change.
 func (p *PhaseReconciler) ApplyFromCache(ctx context.Context) (*Result, error) {
 	log := log.FromContext(ctx)
@@ -340,6 +373,19 @@ func (p *PhaseReconciler) ApplyFromCache(ctx context.Context) (*Result, error) {
 		return &Result{}, err
 	}
 
+	data, err := os.ReadFile(configPath)
+	if os.IsNotExist(err) {
+		data = []byte{}
+	} else if err != nil {
+		return &Result{}, err
+	}
+
+	if err := addObjectToHash(hash, data); err != nil {
+		log.Error(err, "failed to calculate clusterctl.yaml file hash")
+
+		return &Result{}, nil
+	}
+
 	cacheHash := fmt.Sprintf("%x", hash.Sum(nil))
 	if secret.GetAnnotations()[appliedSpecHashAnnotation] != cacheHash || p.provider.GetAnnotations()[appliedSpecHashAnnotation] != cacheHash {
 		log.Info("Provider or cache state has changed", "cacheHash", cacheHash, "providerHash", secret.GetAnnotations()[appliedSpecHashAnnotation])
@@ -444,6 +490,17 @@ func setCacheHash(ctx context.Context, cl client.Client, provider genericprovide
 		return err
 	}
 
+	data, err := os.ReadFile(configPath)
+	if os.IsNotExist(err) {
+		data = []byte{}
+	} else if err != nil {
+		return err
+	}
+
+	if err := addObjectToHash(hash, data); err != nil {
+		return err
+	}
+
 	cacheHash := fmt.Sprintf("%x", hash.Sum(nil))
 
 	annotations := secret.GetAnnotations()
diff --git a/internal/controller/manifests_downloader_test.go b/internal/controller/manifests_downloader_test.go
diff --git a/internal/controller/oci_source.go b/internal/controller/oci_source.go
diff --git a/internal/controller/phases.go b/internal/controller/phases.go
diff --git a/internal/controller/phases_test.go b/internal/controller/phases_test.go
diff --git a/internal/controller/preflight_checks.go b/internal/controller/preflight_checks.go
diff --git a/internal/controller/preflight_checks_test.go b/internal/controller/preflight_checks_test.go
diff --git a/util/util.go b/util/util.go

Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (b *AddonProvider) GetType() string {`
`50`	`50`	`return "addon"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (b *AddonProvider) ProviderName() string {`
	`54`	`+ return b.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (b *AddonProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := []GenericProvider{}`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (b *BootstrapProvider) GetType() string {`
`50`	`50`	`return "bootstrap"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (b *BootstrapProvider) ProviderName() string {`
	`54`	`+ return b.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (b *BootstrapProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := []GenericProvider{}`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (c *ControlPlaneProvider) GetType() string {`
`50`	`50`	`return "controlplane"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (c *ControlPlaneProvider) ProviderName() string {`
	`54`	`+ return c.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (c *ControlPlaneProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := make([]GenericProvider, len(c.Items))`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (c *CoreProvider) GetType() string {`
`50`	`50`	`return "core"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (c *CoreProvider) ProviderName() string {`
	`54`	`+ return c.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (c *CoreProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := make([]GenericProvider, len(c.Items))`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ type GenericProvider interface {`
`30`	`30`	`GetStatus() ProviderStatus`
`31`	`31`	`SetStatus(in ProviderStatus)`
`32`	`32`	`GetType() string`
	`33`	`+ ProviderName() string`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`// GenericProviderList interface describes operations applicable to the provider list type.`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (c *InfrastructureProvider) GetType() string {`
`50`	`50`	`return "infrastructure"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (c *InfrastructureProvider) ProviderName() string {`
	`54`	`+ return c.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (c *InfrastructureProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := make([]GenericProvider, len(c.Items))`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (p *IPAMProvider) GetType() string {`
`50`	`50`	`return "ipam"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (p *IPAMProvider) ProviderName() string {`
	`54`	`+ return p.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (p *IPAMProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := []GenericProvider{}`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,10 @@ func (p *RuntimeExtensionProvider) GetType() string {`
`50`	`50`	`return "runtimeextension"`
`51`	`51`	`}`
`52`	`52`
	`53`	`+func (p *RuntimeExtensionProvider) ProviderName() string {`
	`54`	`+ return p.GetName()`
	`55`	`+}`
	`56`	`+`
`53`	`57`	`func (p *RuntimeExtensionProviderList) GetItems() []GenericProvider {`
`54`	`58`	`providers := []GenericProvider{}`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -324,7 +324,7 @@ func TestInitProviders(t *testing.T) {`
`324`	`324`
`325`	`325`	`for _, genericProvider := range tt.wantedProviders {`
`326`	`326`	`g.Eventually(func() (bool, error) {`
`327`		`- provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.GetName(), genericProvider.GetNamespace())`
	`327`	`+ provider, err := getGenericProvider(ctx, env, string(util.ClusterctlProviderType(genericProvider)), genericProvider.ProviderName(), genericProvider.GetNamespace())`
`328`	`328`	`if err != nil {`
`329`	`329`	`return false, err`
`330`	`330`	`}`