Merge pull request #8472 from Jont828/clusterctl-addon-providers

✨ Add support for add-on providers in clusterctl

Author: k8s-ci-robot

cmd/clusterctl/api/v1alpha3/labels.go

@@ -54,6 +54,8 @@ func ManifestLabel(name string, providerType ProviderType) string {
 		return fmt.Sprintf("ipam-%s", name)
 	case RuntimeExtensionProviderType:
 		return fmt.Sprintf("runtime-extension-%s", name)
+	case AddonProviderType:
+		return fmt.Sprintf("addon-%s", name)
 	default:
 		return name
 	}

cmd/clusterctl/api/v1alpha3/provider_type.go

@@ -95,7 +95,8 @@ func (p *Provider) GetProviderType() ProviderType {
 		InfrastructureProviderType,
 		ControlPlaneProviderType,
 		IPAMProviderType,
-		RuntimeExtensionProviderType:
+		RuntimeExtensionProviderType,
+		AddonProviderType:
 		return t
 	default:
 		return ProviderTypeUnknown
@@ -129,6 +130,10 @@ const (
 	// runtime extensions.
 	RuntimeExtensionProviderType = ProviderType("RuntimeExtensionProvider")
 
+	// AddonProviderType is the type associated with codebases that provide
+	// add-on capabilities.
+	AddonProviderType = ProviderType("AddonProvider")
+
 	// ProviderTypeUnknown is used when the type is unknown.
 	ProviderTypeUnknown = ProviderType("")
 )
@@ -148,6 +153,8 @@ func (p ProviderType) Order() int {
 		return 4
 	case RuntimeExtensionProviderType:
 		return 5
+	case AddonProviderType:
+		return 6
 	default:
 		return 99
 	}

cmd/clusterctl/client/config/providers_client.go

@@ -81,6 +81,11 @@ const (
 	KubeKeyK3sControlPlaneProviderName = "kubekey-k3s"
 )
 
+// Add-on providers.
+const (
+	HelmAddonProviderName = "helm"
+)
+
 // Other.
 const (
 	// ProvidersConfigKey is a constant for finding provider configurations with the ProvidersClient.
@@ -276,6 +281,7 @@ func (p *providersClient) defaults() []Provider {
 			url:          "https://github.com/canonical/cluster-api-bootstrap-provider-microk8s/releases/latest/bootstrap-components.yaml",
 			providerType: clusterctlv1.BootstrapProviderType,
 		},
+
 		// ControlPlane providers
 		&provider{
 			name:         KubeadmControlPlaneProviderName,
@@ -302,6 +308,13 @@ func (p *providersClient) defaults() []Provider {
 			url:          "https://github.com/kubernetes-sigs/cluster-api-provider-nested/releases/latest/control-plane-components.yaml",
 			providerType: clusterctlv1.ControlPlaneProviderType,
 		},
+
+		// Add-on providers
+		&provider{
+			name:         HelmAddonProviderName,
+			url:          "https://github.com/kubernetes-sigs/cluster-api-addon-provider-helm/releases/latest/addon-components.yaml",
+			providerType: clusterctlv1.AddonProviderType,
+		},
 	}
 
 	return defaults
@@ -401,16 +414,18 @@ func validateProvider(r Provider) error {
 		clusterctlv1.InfrastructureProviderType,
 		clusterctlv1.ControlPlaneProviderType,
 		clusterctlv1.IPAMProviderType,
-		clusterctlv1.RuntimeExtensionProviderType:
+		clusterctlv1.RuntimeExtensionProviderType,
+		clusterctlv1.AddonProviderType:
 		break
 	default:
-		return errors.Errorf("invalid provider type. Allowed values are [%s, %s, %s, %s, %s, %s]",
+		return errors.Errorf("invalid provider type. Allowed values are [%s, %s, %s, %s, %s, %s, %s]",
 			clusterctlv1.CoreProviderType,
 			clusterctlv1.BootstrapProviderType,
 			clusterctlv1.InfrastructureProviderType,
 			clusterctlv1.ControlPlaneProviderType,
 			clusterctlv1.IPAMProviderType,
-			clusterctlv1.RuntimeExtensionProviderType)
+			clusterctlv1.RuntimeExtensionProviderType,
+			clusterctlv1.AddonProviderType)
 	}
 	return nil
 }

cmd/clusterctl/client/config/providers_client_test.go

@@ -23,6 +23,7 @@ import (
 	"testing"
 
 	. "github.com/onsi/gomega"
+	"github.com/onsi/gomega/format"
 
 	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/internal/test"
@@ -41,6 +42,10 @@ func Test_providers_List(t *testing.T) {
 	})
 
 	defaultsAndZZZ := append(defaults, NewProvider("zzz", "https://zzz/infrastructure-components.yaml", "InfrastructureProvider"))
+	// AddonProviders are at the end of the list so we want to make sure this InfrastructureProvider is before the AddonProviders.
+	sort.Slice(defaultsAndZZZ, func(i, j int) bool {
+		return defaultsAndZZZ[i].Less(defaultsAndZZZ[j])
+	})
 
 	defaultsWithOverride := append([]Provider{}, defaults...)
 	defaultsWithOverride[0] = NewProvider(defaults[0].Name(), "https://zzz/infrastructure-components.yaml", defaults[0].Type())
@@ -135,6 +140,9 @@ func Test_providers_List(t *testing.T) {
 			wantErr: true,
 		},
 	}
+
+	format.MaxLength = 15000 // This way it doesn't truncate the output on test failure
+
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			g := NewWithT(t)

cmd/clusterctl/client/config_test.go

@@ -90,6 +90,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.VclusterProviderName,
 				config.VirtinkProviderName,
 				config.VSphereProviderName,
+				config.HelmAddonProviderName,
 			},
 			wantErr: false,
 		},
@@ -136,6 +137,7 @@ func Test_clusterctlClient_GetProvidersConfig(t *testing.T) {
 				config.VclusterProviderName,
 				config.VirtinkProviderName,
 				config.VSphereProviderName,
+				config.HelmAddonProviderName,
 			},
 			wantErr: false,
 		},

cmd/clusterctl/client/delete.go

@@ -48,6 +48,9 @@ type DeleteOptions struct {
 	// RuntimeExtensionProviders and versions (e.g. test:v0.0.1) to delete from the management cluster.
 	RuntimeExtensionProviders []string
 
+	// AddonProviders and versions (e.g. helm:v0.1.0) to delete from the management cluster.
+	AddonProviders []string
+
 	// DeleteAll set for deletion of all the providers.
 	DeleteAll bool
 
@@ -122,6 +125,11 @@ func (c *clusterctlClient) Delete(options DeleteOptions) error {
 			return err
 		}
 
+		providers, err = appendProviders(providers, clusterctlv1.AddonProviderType, options.AddonProviders...)
+		if err != nil {
+			return err
+		}
+
 		for _, provider := range providers {
 			// Try to detect the namespace where the provider lives
 			provider.Namespace, err = clusterClient.ProviderInventory().GetProviderNamespace(provider.ProviderName, provider.GetProviderType())

cmd/clusterctl/client/init.go

@@ -59,6 +59,9 @@ type InitOptions struct {
 	// RuntimeExtensionProviders and versions (e.g. test:v0.0.1) to add to the management cluster.
 	RuntimeExtensionProviders []string
 
+	// AddonProviders and versions (e.g. helm:v0.1.0) to add to the management cluster.
+	AddonProviders []string
+
 	// TargetNamespace defines the namespace where the providers should be deployed. If unspecified, each provider
 	// will be installed in a provider's default namespace.
 	TargetNamespace string
@@ -255,6 +258,10 @@ func (c *clusterctlClient) setupInstaller(cluster cluster.Client, options InitOp
 		return nil, err
 	}
 
+	if err := c.addToInstaller(addOptions, clusterctlv1.AddonProviderType, options.AddonProviders...); err != nil {
+		return nil, err
+	}
+
 	return installer, nil
 }
 

cmd/clusterctl/client/upgrade.go

@@ -121,6 +121,9 @@ type ApplyUpgradeOptions struct {
 	// RuntimeExtensionProviders instance and versions (e.g. runtime-extension-system/test:v0.0.1) to upgrade to. This field can be used as alternative to Contract.
 	RuntimeExtensionProviders []string
 
+	// AddonProviders instance and versions (e.g. caaph-system/helm:v0.1.0) to upgrade to. This field can be used as alternative to Contract.
+	AddonProviders []string
+
 	// WaitProviders instructs the upgrade apply command to wait till the providers are successfully upgraded.
 	WaitProviders bool
 
@@ -169,7 +172,8 @@ func (c *clusterctlClient) ApplyUpgrade(options ApplyUpgradeOptions) error {
 		len(options.ControlPlaneProviders) > 0 ||
 		len(options.InfrastructureProviders) > 0 ||
 		len(options.IPAMProviders) > 0 ||
-		len(options.RuntimeExtensionProviders) > 0
+		len(options.RuntimeExtensionProviders) > 0 ||
+		len(options.AddonProviders) > 0
 
 	opts := cluster.UpgradeOptions{
 		WaitProviders:       options.WaitProviders,
@@ -207,6 +211,10 @@ func (c *clusterctlClient) ApplyUpgrade(options ApplyUpgradeOptions) error {
 		if err != nil {
 			return err
 		}
+		upgradeItems, err = addUpgradeItems(clusterClient, upgradeItems, clusterctlv1.AddonProviderType, options.AddonProviders...)
+		if err != nil {
+			return err
+		}
 
 		// Execute the upgrade using the custom upgrade items
 		return clusterClient.ProviderUpgrader().ApplyCustomPlan(opts, upgradeItems...)

cmd/clusterctl/cmd/config_repositories_test.go

@@ -23,6 +23,7 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
 	. "github.com/onsi/gomega"
 )
 
@@ -45,11 +46,13 @@ func Test_runGetRepositories(t *testing.T) {
 			out, err := io.ReadAll(buf)
 			g.Expect(err).ToNot(HaveOccurred())
 
+			var diff string
 			if val == RepositoriesOutputText {
-				g.Expect(string(out)).To(Equal(expectedOutputText))
+				diff = cmp.Diff(expectedOutputText, string(out))
 			} else if val == RepositoriesOutputYaml {
-				g.Expect(string(out)).To(Equal(expectedOutputYaml))
+				diff = cmp.Diff(expectedOutputYaml, string(out))
 			}
+			g.Expect(diff).To(BeEmpty()) // Use diff to compare as Gomega output does not actually print the string values on failure
 		}
 	})
 
@@ -137,6 +140,7 @@ vcd                 InfrastructureProvider   https://github.com/vmware/cluster-a
 vcluster            InfrastructureProvider   https://github.com/loft-sh/cluster-api-provider-vcluster/releases/latest/                   infrastructure-components.yaml
 virtink             InfrastructureProvider   https://github.com/smartxworks/cluster-api-provider-virtink/releases/latest/                infrastructure-components.yaml
 vsphere             InfrastructureProvider   https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/latest/            infrastructure-components.yaml
+helm                AddonProvider            https://github.com/kubernetes-sigs/cluster-api-addon-provider-helm/releases/latest/         addon-components.yaml
 `
 
 var expectedOutputYaml = `- File: core_components.yaml
@@ -287,4 +291,8 @@ var expectedOutputYaml = `- File: core_components.yaml
   Name: vsphere
   ProviderType: InfrastructureProvider
   URL: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/releases/latest/
+- File: addon-components.yaml
+  Name: helm
+  ProviderType: AddonProvider
+  URL: https://github.com/kubernetes-sigs/cluster-api-addon-provider-helm/releases/latest/
 `

cmd/clusterctl/cmd/delete.go

@@ -32,6 +32,7 @@ type deleteOptions struct {
 	infrastructureProviders   []string
 	ipamProviders             []string
 	runtimeExtensionProviders []string
+	addonProviders            []string
 	includeNamespace          bool
 	includeCRDs               bool
 	deleteAll                 bool
@@ -109,6 +110,8 @@ func init() {
 		"IPAM providers and versions (e.g. infoblox:v0.0.1) to delete from the management cluster")
 	deleteCmd.Flags().StringSliceVar(&dd.runtimeExtensionProviders, "runtime-extension", nil,
 		"Runtime extension providers and versions (e.g. test:v0.0.1) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVar(&dd.addonProviders, "addon", nil,
+		"Add-on providers and versions (e.g. helm:v0.1.0) to delete from the management cluster")
 
 	deleteCmd.Flags().BoolVar(&dd.deleteAll, "all", false,
 		"Force deletion of all the providers")
@@ -127,14 +130,15 @@ func runDelete() error {
 		(len(dd.controlPlaneProviders) > 0) ||
 		(len(dd.infrastructureProviders) > 0) ||
 		(len(dd.ipamProviders) > 0) ||
-		(len(dd.runtimeExtensionProviders) > 0)
+		(len(dd.runtimeExtensionProviders) > 0) ||
+		(len(dd.addonProviders) > 0)
 
 	if dd.deleteAll && hasProviderNames {
-		return errors.New("The --all flag can't be used in combination with --core, --bootstrap, --control-plane, --infrastructure, --ipam, --extension")
+		return errors.New("The --all flag can't be used in combination with --core, --bootstrap, --control-plane, --infrastructure, --ipam, --extension, --addon")
 	}
 
 	if !dd.deleteAll && !hasProviderNames {
-		return errors.New("At least one of --core, --bootstrap, --control-plane, --infrastructure, --ipam, --extension should be specified or the --all flag should be set")
+		return errors.New("At least one of --core, --bootstrap, --control-plane, --infrastructure, --ipam, --extension, --addon should be specified or the --all flag should be set")
 	}
 
 	return c.Delete(client.DeleteOptions{
@@ -147,6 +151,7 @@ func runDelete() error {
 		ControlPlaneProviders:     dd.controlPlaneProviders,
 		IPAMProviders:             dd.ipamProviders,
 		RuntimeExtensionProviders: dd.runtimeExtensionProviders,
+		AddonProviders:            dd.addonProviders,
 		DeleteAll:                 dd.deleteAll,
 	})
 }