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.

Sign up for GitHub

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

Jump to bottom

📖 Improve doc for clusterctl update test coverage #9993

Merged
merged 1 commit into from
Jan 15, 2024
Merged

📖 Improve doc for clusterctl update test coverage #9993

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 8 additions & 7 deletions docs/book/src/clusterctl/commands/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,18 @@ clusterctl upgrade apply \
<h1>Clusterctl upgrade test coverage</h1>

Cluster API only tests a subset of possible clusterctl upgrade paths as otherwise the test matrix would be overwhelming.
Untested upgrade paths are not blocked by clusterctl and should work in general, they are just not tested. Users
Untested upgrade paths are not blocked by clusterctl and should work in general, they are just not tested. Users
intending to use an upgrade path not tested by us should do their own validation to ensure the operation works correctly.

The following is an example of the tested upgrade paths while v1.6 is being developed:
The following is an example of the tested upgrade paths for v1.5:

| From | To | Note |
|------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| v1.0 | latest | v1.0 is the first release with the v1beta1 contract. |
| v1.3 | latest | v1.3 is a currently supported release. This test will be removed when v1.5 is released and a new test for v1.5 is added. |
| v1.4 | latest | v1.4 is a currently supported release. This test will be removed when v1.6 is released and a new test for v1.6 is added. |
| From | To | Note |
|------|------|------------------------------------------------------|
| v1.0 | v1.5 | v1.0 is the first release with the v1beta1 contract. |
| v1.3 | v1.5 | v1.3 is v1.5 - 2. |
| v1.4 | v1.5 | v1.4 is v1.5 - 1. |

The idea is to always test upgrade from v1.0 and the previous two minor releases.

</aside>

Expand Down