From fc8b07cd7fa3d8baf291d15b5445ad4ad9b66534 Mon Sep 17 00:00:00 2001 From: Oscar Utbult Date: Sat, 18 Mar 2023 15:03:59 +0100 Subject: [PATCH] docs: update CAPI support and guarantees. --- CONTRIBUTING.md | 17 ++++----- docs/book/src/reference/versions.md | 55 ++++++++++++++--------------- 2 files changed, 36 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b138a414e29..346a22aa9530 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/docs/book/src/reference/versions.md b/docs/book/src/reference/versions.md index 3d8496e4508f..fe9731e5f905 100644 --- a/docs/book/src/reference/versions.md +++ b/docs/book/src/reference/versions.md @@ -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. @@ -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. @@ -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 |