Skip to content

Commit eb9cea2

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #8134 from sbueringer/pr-k-support-policy
📖 docs: document new Kubernetes support policy
2 parents e4a4370 + 4507ff5 commit eb9cea2

File tree

1 file changed

+61
-52
lines changed

1 file changed

+61
-52
lines changed

‎docs/book/src/reference/versions.md

Lines changed: 61 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,28 @@ All Infrastructure Providers are maintained by independent teams. Other Bootstra
1515

1616
## Supported Kubernetes Versions
1717

18-
The project aims to keep the current minor release compatible with the actively supported Kubernetes minor releases, i.e.,
19-
the current release (N), N-1, and N-2. Where possible we will go above and beyond this trying to help our users support
20-
both newer and older versions of Kubernetes:
21-
22-
- For a given Cluster API minor release, we give best-effort support for future Kubernetes versions that are released
23-
during the release's active support period. Depending on the changes made in Kubernetes, users may be required to
24-
update to the next patch release of Cluster API to maintain compatibility.
25-
- In some cases where support for future Kubernetes versions can't be added, or is considered not practical or too risky
26-
adding it, the Kubernetes version support matrix for an existing Cluster API minor release will stop at the last supported version.
27-
- Cluster API offers best-effort support for older Kubernetes versions where possible.
28-
Important! this is not a replacement/alternative for upstream Kubernetes support policies!
29-
Support for older version of Kubernetes is limited to "Cluster API can start a Cluster with this Kubernetes version"
30-
and "Cluster API can upgrade to the next Kubernetes version"; it does not include any extended support to Kubernetes itself.
18+
A Cluster API minor release supports (when it's initially created):
19+
* 4 Kubernetes minor releases for the management cluster (N - N-3)
20+
* 6 Kubernetes minor releases for the workload cluster (N - N-5)
21+
22+
When a new Kubernetes minor release is available, we will try to support it in an upcoming Cluster API patch release
23+
(although only in the latest supported Cluster API minor release). But this depends on the changes made in Kubernetes, if
24+
the corresponding required changes in Cluster API are too invasive we won't backport the support and users have to wait
25+
for the next Cluster API minor release.
26+
27+
For example, Cluster API v1.4.0 would support the following Kubernetes versions:
28+
* v1.23.x to v1.26.x for the management cluster
29+
* v1.21.x to v1.26.x for the workload cluster
30+
* When Kubernetes 1.27 is released, it will be supported in v1.4.x (but not in v1.3.x)
31+
32+
Support in this context means that we:
33+
* maintain corresponding code paths
34+
* have test coverage
35+
* accept bug fixes
36+
37+
Important! This is not a replacement/alternative for upstream Kubernetes support policies!
38+
Support for versions of Kubernetes which itself are out of support is limited to "Cluster API can start a Cluster with this Kubernetes version"
39+
and "Cluster API can upgrade to the next Kubernetes version"; it does not include any extended support to Kubernetes itself.
3140

3241
Whenever a new Cluster API release is cut, we will document the Kubernetes version compatibility matrix the release
3342
has been tested with. Summaries of Kubernetes versions supported by each component are additionally maintained in
@@ -63,19 +72,19 @@ These diagrams show the relationships between components in a Cluster API releas
6372

6473
#### Core Provider (`cluster-api-controller`)
6574

66-
| | v0.3 (v1alpha3) | v0.4 (v1alpha4) | v1.0 (v1beta1) | v1.1 (v1beta1) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
67-
|-------------------|----------------------|-------------------|-------------------|-------------------|-------------------|-------------------|-------------------|
68-
| Kubernetes v1.16 | ✓ | | | | | | |
69-
| Kubernetes v1.17 | ✓ | | | | | | |
70-
| Kubernetes v1.18 | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) |
71-
| Kubernetes v1.19 | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) |
72-
| Kubernetes v1.20 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
73-
| Kubernetes v1.21 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
74-
| Kubernetes v1.22 | ✓ (only workload) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
75-
| Kubernetes v1.23* | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
76-
| Kubernetes v1.24 | | | | ✓ | ✓ | ✓ | ✓ |
77-
| Kubernetes v1.25 | | | | | ✓ | ✓ | ✓ |
78-
| Kubernetes v1.26 | | | | | ✓ | ✓ | ✓ |
75+
| | v0.3 (v1alpha3) (EOL) | v0.4 (v1alpha4) (EOL) | v1.0 (v1beta1) (EOL) | v1.1 (v1beta1) (EOL) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
76+
|-------------------|-----------------------|-----------------------|----------------------|----------------------|-------------------|-------------------|-------------------|
77+
| Kubernetes v1.16 | ✓ | | | | | | |
78+
| Kubernetes v1.17 | ✓ | | | | | | |
79+
| Kubernetes v1.18 | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | |
80+
| Kubernetes v1.19 | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) | |
81+
| Kubernetes v1.20 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
82+
| Kubernetes v1.21 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) |
83+
| Kubernetes v1.22 | ✓ (only workload) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) |
84+
| Kubernetes v1.23* | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
85+
| Kubernetes v1.24 | | | | ✓ | ✓ | ✓ | ✓ |
86+
| Kubernetes v1.25 | | | | | ✓ | ✓ | ✓ |
87+
| Kubernetes v1.26 | | | | | ✓ | ✓ | ✓ |
7988

8089

8190
\* There is an issue with CRDs in Kubernetes v1.23.{0-2}. ClusterClass with patches is affected by that (for more details please see [this issue](https://github.com/kubernetes-sigs/cluster-api/issues/5990)). Therefore we recommend to use Kubernetes v1.23.3+ with ClusterClass.
@@ -87,37 +96,37 @@ The Core Provider also talks to API server of every Workload Cluster. Therefore,
8796

8897
#### Kubeadm Bootstrap Provider (`kubeadm-bootstrap-controller`)
8998

90-
| | v0.3 (v1alpha3) | v0.4 (v1alpha4) | v1.0 (v1beta1) | v1.1 (v1beta1) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
91-
|--------------------------------------------------------------------|----------------------|----------------------|---------------------|-------------------|-------------------|-------------------|-------------------|
92-
| Kubernetes v1.16 + kubeadm/v1beta2 | ✓ | | | | | | |
93-
| Kubernetes v1.17 + kubeadm/v1beta2 | ✓ | | | | | | |
94-
| Kubernetes v1.18 + kubeadm/v1beta2 | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) |
95-
| Kubernetes v1.19 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) |
96-
| Kubernetes v1.20 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
97-
| Kubernetes v1.21 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
98-
| Kubernetes v1.22 + kubeadm/v1beta2 (v0.3) kubeadm/v1beta3 (v0.4+) | ✓ (only workload) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
99-
| Kubernetes v1.23 + kubeadm/v1beta3 | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
100-
| Kubernetes v1.24 + kubeadm/v1beta3 | | | | ✓ | ✓ | ✓ | ✓ |
101-
| Kubernetes v1.25 + kubeadm/v1beta3 | | | | | ✓ | ✓ | ✓ |
102-
| Kubernetes v1.26 + kubeadm/v1beta3 | | | | | ✓ | ✓ | ✓ |
99+
| | v0.3 (v1alpha3) (EOL) | v0.4 (v1alpha4) (EOL) | v1.0 (v1beta1) (EOL) | v1.1 (v1beta1) (EOL) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
100+
|-------------------------------------------------------------------|-----------------------|-----------------------|----------------------|----------------------|-------------------|-------------------|--------------------|
101+
| Kubernetes v1.16 + kubeadm/v1beta2 | ✓ | | | | | | |
102+
| Kubernetes v1.17 + kubeadm/v1beta2 | ✓ | | | | | | |
103+
| Kubernetes v1.18 + kubeadm/v1beta2 | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | |
104+
| Kubernetes v1.19 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) | |
105+
| Kubernetes v1.20 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
106+
| Kubernetes v1.21 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) |
107+
| Kubernetes v1.22 + kubeadm/v1beta2 (v0.3) kubeadm/v1beta3 (v0.4+) | ✓ (only workload) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) |
108+
| Kubernetes v1.23 + kubeadm/v1beta3 | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
109+
| Kubernetes v1.24 + kubeadm/v1beta3 | | | | ✓ | ✓ | ✓ | ✓ |
110+
| Kubernetes v1.25 + kubeadm/v1beta3 | | | | | ✓ | ✓ | ✓ |
111+
| Kubernetes v1.26 + kubeadm/v1beta3 | | | | | ✓ | ✓ | ✓ |
103112

104113
The Kubeadm Bootstrap Provider generates kubeadm configuration using the API version recommended for the target Kubernetes version.
105114

106115
#### Kubeadm Control Plane Provider (`kubeadm-control-plane-controller`)
107116

108-
| | v0.3 (v1alpha3) | v0.4 (v1alpha4) | v1.0 (v1beta1) | v1.1 (v1beta1) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
109-
|----------------------------|----------------------|----------------------|---------------------|-------------------|-------------------|-------------------|-------------------|
110-
| Kubernetes v1.16 + etcd/v3 | ✓ | | | | | | |
111-
| Kubernetes v1.17 + etcd/v3 | ✓ | | | | | | |
112-
| Kubernetes v1.18 + etcd/v3 | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) |
113-
| Kubernetes v1.19 + etcd/v3 | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) |
114-
| Kubernetes v1.20 + etcd/v3 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
115-
| Kubernetes v1.21 + etcd/v3 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
116-
| Kubernetes v1.22 + etcd/v3 | ✓* (only workload) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
117-
| Kubernetes v1.23 + etcd/v3 | | ✓* | ✓* | ✓ | ✓ | ✓ | ✓ |
118-
| Kubernetes v1.24 + etcd/v3 | | | | ✓ | ✓ | ✓ | ✓ |
119-
| Kubernetes v1.25 + etcd/v3 | | | | | ✓ | ✓ | ✓ |
120-
| Kubernetes v1.26 + etcd/v3 | | | | | ✓ | ✓ | ✓ |
117+
| | v0.3 (v1alpha3) (EOL) | v0.4 (v1alpha4) (EOL) | v1.0 (v1beta1) (EOL) | v1.1 (v1beta1) (EOL) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
118+
|----------------------------|-----------------------|-----------------------|----------------------|----------------------|-------------------|-------------------|-------------------|
119+
| Kubernetes v1.16 + etcd/v3 | ✓ | | | | | | |
120+
| Kubernetes v1.17 + etcd/v3 | ✓ | | | | | | |
121+
| Kubernetes v1.18 + etcd/v3 | ✓ | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | |
122+
| Kubernetes v1.19 + etcd/v3 | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) | |
123+
| Kubernetes v1.20 + etcd/v3 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
124+
| Kubernetes v1.21 + etcd/v3 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) |
125+
| Kubernetes v1.22 + etcd/v3 | ✓* (only workload) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (only workload) |
126+
| Kubernetes v1.23 + etcd/v3 | | ✓* | ✓* | ✓ | ✓ | ✓ | ✓ |
127+
| Kubernetes v1.24 + etcd/v3 | | | | ✓ | ✓ | ✓ | ✓ |
128+
| Kubernetes v1.25 + etcd/v3 | | | | | ✓ | ✓ | ✓ |
129+
| Kubernetes v1.26 + etcd/v3 | | | | | ✓ | ✓ | ✓ |
121130

122131
The Kubeadm Control Plane Provider talks to the API server and etcd members of every Workload Cluster whose control plane it owns. It uses the etcd v3 API.
123132

0 commit comments

Comments
 (0)