Skip to content

Commit

Permalink
docs: update CAPI support and guarantees.
Browse files Browse the repository at this point in the history
  • Loading branch information
@oscr
oscr committed Mar 23, 2023
1 parent 6100ef8 commit fc8b07c
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 36 deletions.
17 changes: 9 additions & 8 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,15 @@ Cluster API maintains the most recent release/releases for all supported API and
- We will maintain test coverage for all supported minor releases and for one additional release for the current stable API version in case we have to do an emergency patch release.
For example, if v1.2 and v1.3 are currently supported, we will also maintain test coverage for v1.1 for one additional release cycle. When v1.4 is released, tests for v1.1 will be removed.

| Minor Release | API Version | Supported Until |
|---------------|--------------|------------------------------------------------------|
| v1.3.x | **v1beta1** | when v1.5.0 will be released |
| v1.2.x | **v1beta1** | when v1.4.0 will be released, tentatively March 2023 |
| v1.1.x | **v1beta1** | EOL since 2022-07-18 - v1.2.0 release date (*) |
| v1.0.x | **v1beta1** | EOL since 2022-02-02 - v1.1.0 release date (*) |
| v0.4.x | **v1alpha4** | EOL since 2022-04-06 - API version EOL |
| v0.3.x | **v1alpha3** | EOL since 2022-02-23 - API version EOL |
| Minor Release | API Version | Supported Until |
|---------------|--------------|-----------------------------------------------------|
| v1.4.x | **v1beta1** | when v1.6.0 will be released |
| v1.3.x | **v1beta1** | when v1.5.0 will be released, tentatively July 2023 |
| v1.2.x | **v1beta1** | EOL since 2023-03-28 - v1.4.0 release date |
| v1.1.x | **v1beta1** | EOL since 2022-07-18 - v1.2.0 release date (*) |
| v1.0.x | **v1beta1** | EOL since 2022-02-02 - v1.1.0 release date (*) |
| v0.4.x | **v1alpha4** | EOL since 2022-04-06 - API version EOL |
| v0.3.x | **v1alpha3** | EOL since 2022-02-23 - API version EOL |

(*) Previous support policy applies, older minor releases were immediately unsupported when a new major/minor release was available

Expand Down
55 changes: 27 additions & 28 deletions docs/book/src/reference/versions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,17 @@ These diagrams show the relationships between components in a Cluster API releas

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

| | v1.1 (v1beta1) (EOL) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
| | v1.2 (v1beta1) (EOL) | v1.3 (v1beta1) | v1.4 (v1beta1) | v1.5 (v1beta1) |
|-------------------|----------------------|-------------------|-------------------|-------------------|
| Kubernetes v1.18 | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | |
| Kubernetes v1.19 | ✓ | ✓ (only workload) | ✓ (only workload) | |
| Kubernetes v1.20 | ✓ | ✓ | ✓ | |
| Kubernetes v1.21 | ✓ | ✓ | ✓ | ✓ (only workload) |
| Kubernetes v1.22 | ✓ | ✓ | ✓ | ✓ (only workload) |
| Kubernetes v1.18 | ✓ (only workload) | ✓ (only workload) | | |
| Kubernetes v1.19 | ✓ (only workload) | ✓ (only workload) | | |
| Kubernetes v1.20 | ✓ | ✓ | | |
| Kubernetes v1.21 | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) |
| Kubernetes v1.22 | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) |
| Kubernetes v1.23* | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.24 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.25 | | ✓ | ✓ | ✓ |
| Kubernetes v1.26 | | ✓ | ✓ | ✓ |
| Kubernetes v1.25 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.26 | ✓ | ✓ | ✓ | ✓ |


\* 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.
Expand All @@ -94,33 +94,33 @@ The Core Provider also talks to API server of every Workload Cluster. Therefore,

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

| | v1.1 (v1beta1) (EOL) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
|------------------------------------|----------------------|-------------------|-------------------|--------------------|
| Kubernetes v1.18 + kubeadm/v1beta2 | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | |
| Kubernetes v1.19 + kubeadm/v1beta2 | ✓ | ✓ (only workload) | ✓ (only workload) | |
| Kubernetes v1.20 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | |
| Kubernetes v1.21 + kubeadm/v1beta2 | ✓ | ✓ | ✓ | ✓ (only workload) |
| Kubernetes v1.22 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ (only workload) |
| Kubernetes v1.23 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.24 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.25 + kubeadm/v1beta3 | | ✓ | ✓ | ✓ |
| Kubernetes v1.26 + kubeadm/v1beta3 | | ✓ | ✓ | ✓ |
| | v1.2 (v1beta1) (EOL) | v1.3 (v1beta1) | v1.4 (v1beta1) | v1.5 (v1beta1) |
|------------------------------------|----------------------|-------------------|--------------------|--------------------|
| Kubernetes v1.18 + kubeadm/v1beta2 | ✓ (only workload) | ✓ (only workload) | | |
| Kubernetes v1.19 + kubeadm/v1beta2 | ✓ (only workload) | ✓ (only workload) | | |
| Kubernetes v1.20 + kubeadm/v1beta2 | ✓ | ✓ | | |
| Kubernetes v1.21 + kubeadm/v1beta2 | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) |
| Kubernetes v1.22 + kubeadm/v1beta3 | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) |
| Kubernetes v1.23 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.24 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.25 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.26 + kubeadm/v1beta3 | ✓ | ✓ | ✓ | ✓ |

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

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

| | v1.1 (v1beta1) (EOL) | v1.2 (v1beta1) | v1.3 (v1beta1) | v1.4 (v1beta1) |
| | v1.2 (v1beta1) (EOL) | v1.3 (v1beta1) | v1.4 (v1beta1) | v1.5 (v1beta1) |
|----------------------------|----------------------|-------------------|-------------------|-------------------|
| Kubernetes v1.18 + etcd/v3 | ✓ (only workload) | ✓ (only workload) | ✓ (only workload) | |
| Kubernetes v1.19 + etcd/v3 | ✓ | ✓ (only workload) | ✓ (only workload) | |
| Kubernetes v1.20 + etcd/v3 | ✓ | ✓ | ✓ | |
| Kubernetes v1.21 + etcd/v3 | ✓ | ✓ | ✓ | ✓ (only workload) |
| Kubernetes v1.22 + etcd/v3 | ✓ | ✓ | ✓ | ✓ (only workload) |
| Kubernetes v1.18 + etcd/v3 | ✓ (only workload) | ✓ (only workload) | | |
| Kubernetes v1.19 + etcd/v3 | ✓ (only workload) | ✓ (only workload) | | |
| Kubernetes v1.20 + etcd/v3 | ✓ | ✓ | | |
| Kubernetes v1.21 + etcd/v3 | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) |
| Kubernetes v1.22 + etcd/v3 | ✓ | ✓ | ✓ (only workload) | ✓ (only workload) |
| Kubernetes v1.23 + etcd/v3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.24 + etcd/v3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.25 + etcd/v3 | | ✓ | ✓ | ✓ |
| Kubernetes v1.26 + etcd/v3 | | ✓ | ✓ | ✓ |
| Kubernetes v1.25 + etcd/v3 | ✓ | ✓ | ✓ | ✓ |
| Kubernetes v1.26 + etcd/v3 | ✓ | ✓ | ✓ | ✓ |

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.

Expand All @@ -132,7 +132,6 @@ The Kubeadm Control Plane requires the Kubeadm Bootstrap Provider.

| CAPI Version | Max CoreDNS Version for Upgrade |
|----------------------|---------------------------------|
| v1.1 (v1beta1) | v1.9.3 |
| v1.2 (v1beta1) | v1.9.3 |
| >= v1.2.7 (v1beta1) | v1.10.0 |
| >= v1.2.11 (v1beta1) | v1.10.1 |
Expand Down

0 comments on commit fc8b07c

Please sign in to comment.