Address comments

Author: fabriziopandini

cmd/clusterctl/cmd/upgrade.go

@@ -50,8 +50,8 @@ var upgradePlanCmd = &cobra.Command{
 		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.`),
+		- The latest patch release for the current Cluster API version.
+		- The latest patch release for the next Cluster API version, if available.`),
 
 	Example: Examples(`
 		# Gets the recommended target versions for upgrading Cluster API providers.
@@ -78,7 +78,7 @@ func runUpgradePlan() error {
 
 	//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{
+	upgradePlans, err := c.PlanUpgrade(client.PlanUpgradeOptions{
 		Kubeconfig: up.kubeconfig,
 	})
 	if err != nil {

cmd/clusterctl/pkg/client/client.go

@@ -120,8 +120,8 @@ type MoveOptions struct {
 	Namespace string
 }
 
-// UpgradePlanOptions carries the options supported by upgrade plan.
-type UpgradePlanOptions struct {
+// PlanUpgradeOptions carries the options supported by upgrade plan.
+type PlanUpgradeOptions struct {
 	// Kubeconfig file to use for accessing the management cluster. If empty, default rules for kubeconfig discovery will be used.
 	Kubeconfig string
 }
@@ -146,12 +146,12 @@ 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:
+	// PlanUpgrade 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.
+	// - For each management group, an upgrade plan is 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)
+	PlanUpgrade(options PlanUpgradeOptions) ([]UpgradePlan, error)
 }
 
 // clusterctlClient implements Client.

cmd/clusterctl/pkg/client/client_test.go

@@ -88,7 +88,7 @@ func (f fakeClient) Move(options MoveOptions) error {
 	return f.internalClient.Move(options)
 }
 
-func (f fakeClient) UpgradePlan(options UpgradePlanOptions) ([]UpgradePlan, error) {
+func (f fakeClient) UpgradePlan(options PlanUpgradeOptions) ([]UpgradePlan, error) {
 	return f.internalClient.UpgradePlan(options)
 }
 

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

@@ -69,7 +69,7 @@ type Client interface {
 	// from one management cluster to another management cluster.
 	ObjectMover() ObjectMover
 
-	// ProviderUpgrader returns an ObjectMover that implements support upgrading ClusterAPI providers.
+	// ProviderUpgrader returns a ProviderUpgrader that supports upgrading Cluster API providers.
 	ProviderUpgrader() ProviderUpgrader
 }
 

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

@@ -41,9 +41,9 @@ type UpgradePlan struct {
 	Providers         []UpgradeItem
 }
 
-// UgradeRef returns a string identifying the upgrade plan; this string is derived by the core provider which is
+// UpgradeRef 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 {
+func (u *UpgradePlan) UpgradeRef() string {
 	return fmt.Sprintf("%s/%s", u.CoreProvider.Namespace, u.CoreProvider.Name)
 }
 
@@ -53,8 +53,8 @@ type UpgradeItem struct {
 	NextVersion string
 }
 
-// UgradeRef returns a string identifying the upgrade item; this string is derived by the provider.
-func (u *UpgradeItem) UgradeRef() string {
+// UpgradeRef returns a string identifying the upgrade item; this string is derived by the provider.
+func (u *UpgradeItem) UpgradeRef() string {
 	return fmt.Sprintf("%s/%s", u.Namespace, u.Name)
 }
 

cmd/clusterctl/pkg/client/upgrade.go

@@ -16,7 +16,7 @@ limitations under the License.
 
 package client
 
-func (c *clusterctlClient) UpgradePlan(options UpgradePlanOptions) ([]UpgradePlan, error) {
+func (c *clusterctlClient) PlanUpgrade(options PlanUpgradeOptions) ([]UpgradePlan, error) {
 	// Get the client for interacting with the management cluster.
 	cluster, err := c.clusterClientFactory(options.Kubeconfig)
 	if err != nil {