Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Fix v1alpha4 references in clusterctl comments #8234

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/clusterctl/api/v1alpha3/provider_type.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type Provider struct {
// WatchedNamespace indicates the namespace where the provider controller is watching.
// If empty the provider controller is watching for objects in all namespaces.
//
// Deprecated: in clusterctl v1alpha4 all the providers watch all the namespaces; this field will be removed in a future version of this API
// Deprecated: providers complying with the Cluster API v1alpha4 contract or above must watch all namespaces; this field will be removed in a future version of this API
// +optional
WatchedNamespace string `json:"watchedNamespace,omitempty"`
}
Expand Down
4 changes: 1 addition & 3 deletions cmd/clusterctl/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@ 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

// PlanUpgrade returns a set of suggested Upgrade plans for the cluster, and more specifically:
// - Upgrade to the latest version in the v1alpha3 series: ....
// - Upgrade to the latest version in the v1alpha4 series: ....
// PlanUpgrade returns a set of suggested Upgrade plans for the cluster.
PlanUpgrade(options PlanUpgradeOptions) ([]UpgradePlan, error)

// PlanCertManagerUpgrade returns a CertManagerUpgradePlan.
Expand Down
6 changes: 2 additions & 4 deletions cmd/clusterctl/client/cluster/upgrader.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,7 @@ import (

// ProviderUpgrader defines methods for supporting provider upgrade.
type ProviderUpgrader interface {
// Plan returns a set of suggested Upgrade plans for the management cluster, and more specifically:
// - Upgrade to the latest version in the v1alpha3 series: ....
// - Upgrade to the latest version in the v1alpha4 series: ....
// Plan returns a set of suggested Upgrade plans for the management cluster.
Plan() ([]UpgradePlan, error)

// ApplyPlan executes an upgrade following an UpgradePlan generated by clusterctl.
Expand Down Expand Up @@ -109,7 +107,7 @@ func (u *providerUpgrader) Plan() ([]UpgradePlan, error) {
// all the providers can upgrade to the latest release supporting v1alpha5 (not supported in current clusterctl release,
// but upgrade plan should report these options)
// Please note that upgrade plan also works on management cluster still in v1alpha3. In this case upgrade plan is shown, but
// upgrade to latest version in the v1alpha3 series are not supported using clusterctl v1alpha4 (use older releases).
// upgrade to latest version in the v1alpha3 series are not supported using clusterctl v1alpha4 or v1beta1 (use older releases).

// Gets the upgrade info for the core provider.
coreProviders := providerList.FilterCore()
Expand Down
4 changes: 2 additions & 2 deletions cmd/clusterctl/client/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func (c *clusterctlClient) Init(options InitOptions) ([]Components, error) {
return nil, err
}

// Ensure this command only runs against v1alpha4 management clusters
// Ensure this command only runs against v1beta1 management clusters
if err := clusterClient.ProviderInventory().CheckCAPIContract(cluster.AllowCAPINotInstalled{}); err != nil {
return nil, err
}
Expand Down Expand Up @@ -172,7 +172,7 @@ func (c *clusterctlClient) InitImages(options InitOptions) ([]string, error) {
return nil, err
}

// Ensure this command only runs against empty management clusters or v1alpha4 management clusters.
// Ensure this command only runs against empty management clusters or v1beta1 management clusters.
if err := clusterClient.ProviderInventory().CheckCAPIContract(cluster.AllowCAPINotInstalled{}); err != nil {
return nil, err
}
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions cmd/clusterctl/config/manifest/clusterctl-api.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.