Skip to content

Commit

Permalink
Merge pull request #9993 from sbueringer/pr-improve-upgrade-comments
Browse files Browse the repository at this point in the history
📖 Improve doc for clusterctl update test coverage
  • Loading branch information
k8s-ci-robot authored Jan 15, 2024
2 parents d48b35b + f5c0db4 commit 66b83f7
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/book/src/clusterctl/commands/upgrade.md
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

0 comments on commit 66b83f7

Please sign in to comment.