clusterctl add the upgrade plan cmd

Author: fabriziopandini

cmd/clusterctl/cmd/upgrade.go

@@ -16,4 +16,135 @@ limitations under the License.
 
 package cmd
 
-// TODO: upgrade command
+import (
+	"fmt"
+	"os"
+	"sort"
+	"text/tabwriter"
+
+	"github.com/spf13/cobra"
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/pkg/client"
+)
+
+var upgradeCmd = &cobra.Command{
+	Use:   "upgrade",
+	Short: "Upgrades Cluster API providers in a management cluster",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return cmd.Help()
+	},
+}
+
+type upgradePlanOptions struct {
+	kubeconfig string
+}
+
+var up = &upgradePlanOptions{}
+
+var upgradePlanCmd = &cobra.Command{
+	Use:   "plan",
+	Short: "Provide a list of recommended target versions for upgrading Cluster API providers in a management cluster",
+	Long: LongDesc(`
+		The upgrade plan command provides a list of recommended target versions for upgrading Cluster API providers in a management cluster.
+		
+		The providers are grouped into management groups, each one defining a set of providers that should be supporting the same cluster API version
+		in order to guarantee the proper functioning of the management cluster.
+
+		Then, for each provider in a management group, the following upgrade options are provided:
+		- The last available version within the current cluster API version.
+		- The last available version within the next cluster API version, if available.`),
+
+	Example: Examples(`
+		# Gets the recommended target versions for upgrading Cluster API providers.
+		clusterctl upgrade plan`),
+
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runUpgradePlan()
+	},
+}
+
+func init() {
+	upgradePlanCmd.Flags().StringVarP(&up.kubeconfig, "kubeconfig", "", "", "Path to the kubeconfig file to use for accessing the management cluster. If empty, default rules for kubeconfig discovery will be used")
+
+	upgradeCmd.AddCommand(upgradePlanCmd)
+
+	RootCmd.AddCommand(upgradeCmd)
+}
+
+func runUpgradePlan() error {
+	c, err := client.New(cfgFile)
+	if err != nil {
+		return err
+	}
+
+	//TODO: switch to klog as soon as https://github.com/kubernetes-sigs/cluster-api/pull/2150 merge
+	fmt.Println("Checking new release availability...")
+	upgradePlans, err := c.UpgradePlan(client.UpgradePlanOptions{
+		Kubeconfig: up.kubeconfig,
+	})
+	if err != nil {
+		return err
+	}
+
+	// ensure upgrade plans are sorted consistently (by CoreProvider.Namespace, ClusterAPIVersion).
+	sortUpgradePlans(upgradePlans)
+
+	if len(upgradePlans) == 0 {
+		fmt.Println("There are no management groups in the cluster. Please use clusterctl init to initialize a Cluster API management cluster.")
+		return nil
+	}
+
+	for _, plan := range upgradePlans {
+		// ensure provider are sorted consistently (by Type, Name, Namespace).
+		sortUpgradeItems(plan)
+
+		upgradeAvailable := false
+
+		fmt.Println("")
+		fmt.Printf("Management group: %s/%s, latest release available for the %s Cluster API version:\n", plan.CoreProvider.Namespace, plan.CoreProvider.Name, plan.ClusterAPIVersion)
+		fmt.Println("")
+		w := tabwriter.NewWriter(os.Stdout, 10, 4, 3, ' ', 0)
+		fmt.Fprintln(w, "NAME\tNAMESPACE\tTYPE\tCURRENT VERSION\tNEXT VERSION")
+		for _, upgradeItem := range plan.Providers {
+			fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", upgradeItem.Provider.Name, upgradeItem.Provider.Namespace, upgradeItem.Provider.Type, upgradeItem.Provider.Version, prettifyTargetVersion(upgradeItem.NextVersion))
+			if upgradeItem.NextVersion != "" {
+				upgradeAvailable = true
+			}
+		}
+		w.Flush()
+		fmt.Println("")
+
+		if upgradeAvailable {
+			fmt.Println("You can now apply the upgrade by executing the following command:")
+			fmt.Println("")
+			fmt.Println(fmt.Sprintf("   upgrade apply --management-group %s/%s --cluster-api-version %s", plan.CoreProvider.Namespace, plan.CoreProvider.Name, plan.ClusterAPIVersion))
+		} else {
+			fmt.Println("You are already up to date!")
+		}
+		fmt.Println("")
+
+	}
+
+	return nil
+}
+
+func sortUpgradeItems(plan client.UpgradePlan) {
+	sort.Slice(plan.Providers, func(i, j int) bool {
+		return plan.Providers[i].Provider.Type < plan.Providers[j].Provider.Type ||
+			(plan.Providers[i].Provider.Type == plan.Providers[j].Provider.Type && plan.Providers[i].Provider.Name < plan.Providers[j].Provider.Name) ||
+			(plan.Providers[i].Provider.Type == plan.Providers[j].Provider.Type && plan.Providers[i].Provider.Name == plan.Providers[j].Provider.Name && plan.Providers[i].Provider.Namespace < plan.Providers[j].Provider.Namespace)
+	})
+}
+
+func sortUpgradePlans(upgradePlans []client.UpgradePlan) {
+	sort.Slice(upgradePlans, func(i, j int) bool {
+		return upgradePlans[i].CoreProvider.Namespace < upgradePlans[j].CoreProvider.Namespace ||
+			(upgradePlans[i].CoreProvider.Namespace == upgradePlans[j].CoreProvider.Namespace && upgradePlans[i].ClusterAPIVersion < upgradePlans[j].ClusterAPIVersion)
+	})
+}
+
+func prettifyTargetVersion(version string) string {
+	if version == "" {
+		return "Already up to date"
+	}
+	return version
+}

cmd/clusterctl/pkg/client/alias.go

@@ -17,6 +17,7 @@ limitations under the License.
 package client
 
 import (
+	"sigs.k8s.io/cluster-api/cmd/clusterctl/pkg/client/cluster"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/pkg/client/config"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/pkg/client/repository"
 )
@@ -32,3 +33,6 @@ type Components repository.Components
 
 // Template wraps a YAML file that defines the cluster objects (Cluster, Machines etc.).
 type Template repository.Template
+
+// Template wraps a YAML file that defines the cluster objects (Cluster, Machines etc.).
+type UpgradePlan cluster.UpgradePlan

cmd/clusterctl/pkg/client/client.go

@@ -120,6 +120,12 @@ type MoveOptions struct {
 	Namespace string
 }
 
+// UpgradePlanOptions carries the options supported by upgrade plan.
+type UpgradePlanOptions struct {
+	// Kubeconfig file to use for accessing the management cluster. If empty, default rules for kubeconfig discovery will be used.
+	Kubeconfig string
+}
+
 // Client is exposes the clusterctl high-level client library.
 type Client interface {
 	// GetProvidersConfig returns the list of providers configured for this instance of clusterctl.
@@ -139,6 +145,13 @@ type Client interface {
 
 	// Move moves all the Cluster API objects existing in a namespace (or from all the namespaces if empty) to a target management cluster.
 	Move(options MoveOptions) error
+
+	// Plan returns a set of suggested Upgrade plans for the cluster, and more specifically:
+	// - Each management group gets separated upgrade plans.
+	// - For each management group, an upgrade plan will be generated for each ClusterAPIVersion available, e.g.
+	//   - Upgrade to the latest version in the the v1alpha2 series: ....
+	//   - Upgrade to the latest version in the the v1alpha3 series: ....
+	UpgradePlan(options UpgradePlanOptions) ([]UpgradePlan, error)
 }
 
 // clusterctlClient implements Client.
@@ -218,7 +231,7 @@ func newClusterctlClient(path string, options ...Option) (*clusterctlClient, err
 	// if there is an injected ClusterFactory, use it, otherwise use a default one.
 	clusterClientFactory := cfg.injectClusterFactory
 	if clusterClientFactory == nil {
-		clusterClientFactory = defaultClusterFactory()
+		clusterClientFactory = defaultClusterFactory(configClient)
 	}
 
 	return &clusterctlClient{
@@ -229,9 +242,9 @@ func newClusterctlClient(path string, options ...Option) (*clusterctlClient, err
 }
 
 // defaultClusterFactory is a ClusterClientFactory func the uses the default client provided by the cluster low level library.
-func defaultClusterFactory() func(kubeconfig string) (cluster.Client, error) {
+func defaultClusterFactory(configClient config.Client) func(kubeconfig string) (cluster.Client, error) {
 	return func(kubeconfig string) (cluster.Client, error) {
-		return cluster.New(kubeconfig), nil
+		return cluster.New(kubeconfig, configClient), nil
 	}
 }
 

cmd/clusterctl/pkg/client/client_test.go

@@ -86,6 +86,10 @@ func (f fakeClient) Move(options MoveOptions) error {
 	return f.internalClient.Move(options)
 }
 
+func (f fakeClient) UpgradePlan(options UpgradePlanOptions) ([]UpgradePlan, error) {
+	return f.internalClient.UpgradePlan(options)
+}
+
 // newFakeClient returns a clusterctl client that allows to execute tests on a set of fake config, fake repositories and fake clusters.
 // you can use WithCluster and WithRepository to prepare for the test case.
 func newFakeClient(configClient config.Client) *fakeClient {
@@ -140,7 +144,9 @@ func (f *fakeClient) WithRepository(repositoryClient repository.Client) *fakeCli
 func newFakeCluster(kubeconfig string) *fakeClusterClient {
 	fakeProxy := test.NewFakeProxy()
 
-	client := cluster.New("", cluster.InjectProxy(fakeProxy))
+	configClient := newFakeConfig()
+
+	client := cluster.New("", configClient, cluster.InjectProxy(fakeProxy))
 
 	return &fakeClusterClient{
 		kubeconfig:     kubeconfig,
@@ -199,6 +205,10 @@ func (f *fakeClusterClient) ObjectMover() cluster.ObjectMover {
 	return f.internalclient.ObjectMover()
 }
 
+func (f *fakeClusterClient) ProviderUpgrader() cluster.ProviderUpgrader {
+	return f.internalclient.ProviderUpgrader()
+}
+
 func (f *fakeClusterClient) WithObjs(objs ...runtime.Object) *fakeClusterClient {
 	f.fakeProxy.WithObjs(objs...)
 	return f

cmd/clusterctl/pkg/client/cluster/client.go

@@ -66,12 +66,16 @@ type Client interface {
 	// ObjectMover returns an ObjectMover that implements support for moving Cluster API objects (e.g. clusters, AWS clusters, machines, etc.).
 	// from one management cluster to another management cluster.
 	ObjectMover() ObjectMover
+
+	// ProviderUpgrader returns an ObjectMover that implements support upgrading ClusterAPI providers.
+	ProviderUpgrader() ProviderUpgrader
 }
 
 // clusterClient implements Client.
 type clusterClient struct {
 	kubeconfig              string
 	proxy                   Proxy
+	configClient            config.Client
 	repositoryClientFactory RepositoryClientFactory
 }
 
@@ -114,6 +118,10 @@ func (c *clusterClient) ObjectMover() ObjectMover {
 	return newObjectMover(c.proxy, log)
 }
 
+func (c *clusterClient) ProviderUpgrader() ProviderUpgrader {
+	return newProviderUpgrader(c.configClient, c.repositoryClientFactory, c.ProviderInventory())
+}
+
 // NewOptions carries the options supported by New
 type NewOptions struct {
 	injectProxy                   Proxy
@@ -139,11 +147,11 @@ func InjectRepositoryFactory(factory RepositoryClientFactory) Option {
 }
 
 // New returns a cluster.Client.
-func New(kubeconfig string, options ...Option) Client {
-	return newClusterClient(kubeconfig, options...)
+func New(kubeconfig string, configClient config.Client, options ...Option) Client {
+	return newClusterClient(kubeconfig, configClient, options...)
 }
 
-func newClusterClient(kubeconfig string, options ...Option) *clusterClient {
+func newClusterClient(kubeconfig string, configClient config.Client, options ...Option) *clusterClient {
 	cfg := &NewOptions{}
 	for _, o := range options {
 		o(cfg)
@@ -162,6 +170,7 @@ func newClusterClient(kubeconfig string, options ...Option) *clusterClient {
 	}
 
 	return &clusterClient{
+		configClient:            configClient,
 		kubeconfig:              kubeconfig,
 		proxy:                   proxy,
 		repositoryClientFactory: repositoryClientFactory,

cmd/clusterctl/pkg/client/cluster/components_test.go

@@ -32,7 +32,7 @@ import (
 
 func Test_providerComponents_Delete(t *testing.T) {
 	labels := map[string]string{
-		clusterv1.ProviderLabelName: "aws",
+		clusterv1.ProviderLabelName: "infra",
 	}
 
 	crd := unstructured.Unstructured{}
@@ -107,7 +107,7 @@ func Test_providerComponents_Delete(t *testing.T) {
 		{
 			name: "Delete provider while preserving Namespace and CRDs",
 			args: args{
-				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "aws", Namespace: "ns1"}},
+				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "infra", Namespace: "ns1"}},
 				forceDeleteNamespace: false,
 				forceDeleteCRD:       false,
 			},
@@ -123,7 +123,7 @@ func Test_providerComponents_Delete(t *testing.T) {
 		{
 			name: "Delete provider and provider namespace, while preserving CRDs",
 			args: args{
-				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "aws", Namespace: "ns1"}},
+				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "infra", Namespace: "ns1"}},
 				forceDeleteNamespace: true,
 				forceDeleteCRD:       false,
 			},
@@ -140,7 +140,7 @@ func Test_providerComponents_Delete(t *testing.T) {
 		{
 			name: "Delete provider and provider CRDs, while preserving the provider namespace",
 			args: args{
-				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "aws", Namespace: "ns1"}},
+				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "infra", Namespace: "ns1"}},
 				forceDeleteNamespace: false,
 				forceDeleteCRD:       true,
 			},
@@ -157,7 +157,7 @@ func Test_providerComponents_Delete(t *testing.T) {
 		{
 			name: "Delete provider, provider namespace and provider CRDs",
 			args: args{
-				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "aws", Namespace: "ns1"}},
+				provider:             clusterctlv1.Provider{ObjectMeta: metav1.ObjectMeta{Name: "infra", Namespace: "ns1"}},
 				forceDeleteNamespace: true,
 				forceDeleteCRD:       true,
 			},

cmd/clusterctl/pkg/client/cluster/upgrader.go

@@ -17,6 +17,8 @@ limitations under the License.
 package cluster
 
 import (
+	"fmt"
+
 	"github.com/pkg/errors"
 	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/pkg/client/config"
@@ -26,7 +28,7 @@ import (
 type ProviderUpgrader interface {
 	// Plan returns a set of suggested Upgrade plans for the cluster, and more specifically:
 	// - Each management group gets separated upgrade plans.
-	// - For each management group, an upgrade plann will be generated for each ClusterAPIVersion available, e.g.
+	// - For each management group, an upgrade plan will be generated for each ClusterAPIVersion available, e.g.
 	//   - Upgrade to the latest version in the the v1alpha2 series: ....
 	//   - Upgrade to the latest version in the the v1alpha3 series: ....
 	Plan() ([]UpgradePlan, error)
@@ -35,15 +37,27 @@ type ProviderUpgrader interface {
 // UpgradePlan defines a list of possible upgrade targets for a management group.
 type UpgradePlan struct {
 	ClusterAPIVersion string
+	CoreProvider      clusterctlv1.Provider
 	Providers         []UpgradeItem
 }
 
+// UgradeRef returns a string identifying the upgrade plan; this string is derived by the core provider which is
+// unique for each management group.
+func (u *UpgradePlan) UgradeRef() string {
+	return fmt.Sprintf("%s/%s", u.CoreProvider.Namespace, u.CoreProvider.Name)
+}
+
 // UpgradeItem defines a possible upgrade target for a provider in the management group.
 type UpgradeItem struct {
-	Provider    clusterctlv1.Provider
+	clusterctlv1.Provider
 	NextVersion string
 }
 
+// UgradeRef returns a string identifying the upgrade item; this string is derived by the provider.
+func (u *UpgradeItem) UgradeRef() string {
+	return fmt.Sprintf("%s/%s", u.Namespace, u.Name)
+}
+
 type providerUpgrader struct {
 	configClient            config.Client
 	repositoryClientFactory RepositoryClientFactory
@@ -104,10 +118,19 @@ func (u *providerUpgrader) Plan() ([]UpgradePlan, error) {
 
 			ret = append(ret, UpgradePlan{
 				ClusterAPIVersion: apiVersion,
+				CoreProvider:      managementGroup.CoreProvider,
 				Providers:         upgradeItems,
 			})
 		}
 	}
 
 	return ret, nil
 }
+
+func newProviderUpgrader(configClient config.Client, repositoryClientFactory RepositoryClientFactory, providerInventory InventoryClient) *providerUpgrader {
+	return &providerUpgrader{
+		configClient:            configClient,
+		repositoryClientFactory: repositoryClientFactory,
+		providerInventory:       providerInventory,
+	}
+}