Skip to content

Commit a918c38

Browse files
committed
book: Add note about clusterctl skip-level upgrades
Signed-off-by: Stefan Büringer [email protected]
1 parent c9dec31 commit a918c38

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docs/book/src/clusterctl/commands/upgrade.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ installed into a management cluster.
77

88
The `clusterctl upgrade plan` command can be used to identify possible targets for upgrades.
99

10-
1110
```bash
1211
clusterctl upgrade plan
1312
```
@@ -28,7 +27,9 @@ control-plane-kubeadm capi-kubeadm-control-plane-system ControlPlaneProvider
2827
cluster-api capi-system CoreProvider v0.4.0 v1.0.0
2928
infrastructure-docker capd-system InfrastructureProvider v0.4.0 v1.0.0
3029
```
30+
3131
You can now apply the upgrade by executing the following command:
32+
3233
```bash
3334
clusterctl upgrade apply --contract v1beta1
3435
```
@@ -67,6 +68,7 @@ Please note that clusterctl does not upgrade Cluster API objects (Clusters, Mach
6768
such objects are the responsibility of the provider's controllers.
6869

6970
It is also possible to explicitly upgrade one or more components to specific versions.
71+
7072
```bash
7173
clusterctl upgrade apply \
7274
--core cluster-api:v1.2.4 \
@@ -75,6 +77,26 @@ clusterctl upgrade apply \
7577

7678
<aside class="note warning">
7779

80+
<h1>Clusterctl upgrade test coverage</h1>
81+
82+
Cluster API only tests a subset of possible clusterctl upgrade paths as otherwise the test matrix would be overwhelming.
83+
Untested upgrade paths are not blocked by clusterctl and should work in general, they are just not tested. Users
84+
intending to use an upgrade path not tested by us should do their own validation to ensure the operation works correctly.
85+
86+
The following is an example of the tested upgrade paths while v1.4 is being developed:
87+
88+
| From | To | Note |
89+
|------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
90+
| v0.3 | latest | v0.3 is the latest supported minor release with the v1alpha3 contract (v0.3 is EOL since 2022-02-23). This test will be removed once the v1alpha3 apiVersion has been entirely removed. |
91+
| v0.4 | latest | v0.4 is the latest supported minor release with the v1alpha4 contract (v0.4 is EOL since 2022-04-06). This test will be removed once the v1alpha4 apiVersion has been entirely removed. |
92+
| v1.0 | latest | v1.0 is the first release with the v1beta1 contract. |
93+
| v1.2 | latest | v1.2 is a currently supported release. This test will be removed when v1.4 is released and a new test for v1.4 is added. |
94+
| 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. |
95+
96+
</aside>
97+
98+
<aside class="note warning">
99+
78100
<h1>Warning!</h1>
79101

80102
The current implementation of the upgrade process does not preserve controllers flags that are not set through the

0 commit comments

Comments
 (0)