📖 Document clusterctl version support #3449
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/S
docs/book/src/reference/versions.md
Outdated
| It is strongly recommended using a version of [clusterctl](../clusterctl/overview.md) that exactly matches the version | ||
| of the Cluster API core provider; in case of upgrades, clusterctl should be upgraded first and used to upgrade | ||
| all the other components. |
There was a problem hiding this comment.
Not sure what we're trying to communicate here, do we want users to upgrade clusterctl to the latest available version all the time?
There was a problem hiding this comment.
Yes, IMO this is the safest approach: upgrade clusterctl first, then use the latest clusterctl to upgrade other components
There was a problem hiding this comment.
| It is strongly recommended using a version of [clusterctl](../clusterctl/overview.md) that exactly matches the version | |
| of the Cluster API core provider; in case of upgrades, clusterctl should be upgraded first and used to upgrade | |
| all the other components. | |
| It is strongly recommended using the latest version of [clusterctl](../clusterctl/overview.md) before attempting to upgrade your clusters. |
How about something like this? I'd also open an issue if we don't have one already to have ways in clusterctl to check for its latest version
There was a problem hiding this comment.
Thinking back to this might be I have misunderstood the original question because the consideration does not apply to upgrades only .
I have in mind some recent use cases of uses trying to init a cluster with version 0.3.7 but using an older version of clusterctl, and failing due to the changes for envsubst; I do expect might happen in the near future as well, e.g. for the changes on cert-manager, or for the changes on the move logic.
This is why IMO the version of clusterctl should always be >= to the version of CAPI installed in the cluster (and as corollary, clusterctl should be updated before all the other components)
There was a problem hiding this comment.
Yes. Ideally, the user should always update to the latest version of clusterctl before doing any operations in order to avoid unintended side effects.
We had a discussion regarding clusterctl doing a version check (see slack thread).
I can create an issue regarding clusterctl doing a version check.
There was a problem hiding this comment.
I created this issue regarding above: #3466
There was a problem hiding this comment.
I have aligned the doc to the issue above, please PTAL
fabriziopandini
changed the title
k8s-ci-robot
added
size/XS
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/lgtm |
|
Looks like this could use an /approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
/milestone v0.3.9 |
What this PR does / why we need it:
This PR documents version support for clusterctl
Which issue(s) this PR fixes:
Fixes #3090