Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
g-gaston committed Aug 9, 2023
1 parent 0bce02e commit 734ae84
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 36 deletions.
63 changes: 31 additions & 32 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,35 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Contributing Guidelines](#contributing-guidelines)
- [Contributor License Agreements](#contributor-license-agreements)
- [Finding Things That Need Help](#finding-things-that-need-help)
- [Versioning](#versioning)
- [Codebase and Go Modules](#codebase-and-go-modules)
- [Backporting a patch](#backporting-a-patch)
- [APIs](#apis)
- [CLIs](#clis)
- [Branches](#branches)
- [Support and guarantees](#support-and-guarantees)
- [Removal of v1alpha3 \& v1alpha4 apiVersions](#removal-of-v1alpha3--v1alpha4-apiversions)
- [Contributing a Patch](#contributing-a-patch)
- [Documentation changes](#documentation-changes)
- [Releases](#releases)
- [Proposal process (CAEP)](#proposal-process-caep)
- [Triaging E2E test failures](#triaging-e2e-test-failures)
- [Reviewing a Patch](#reviewing-a-patch)
- [Reviews](#reviews)
- [Approvals](#approvals)
- [Features and bugs](#features-and-bugs)
- [Experiments](#experiments)
- [Breaking Changes](#breaking-changes)
- [API conventions](#api-conventions)
- [Optional vs. Required](#optional-vs-required)
- [Example](#example)
- [Exceptions](#exceptions)
- [CRD additionalPrinterColumns](#crd-additionalprintercolumns)
- [Google Doc Viewing Permissions](#google-doc-viewing-permissions)
- [Issue and Pull Request Management](#issue-and-pull-request-management)
- [Contributors Ladder](#contributors-ladder)
- [Contributor License Agreements](#contributor-license-agreements)
- [Finding Things That Need Help](#finding-things-that-need-help)
- [Versioning](#versioning)
- [Codebase and Go Modules](#codebase-and-go-modules)
- [Backporting a patch](#backporting-a-patch)
- [APIs](#apis)
- [CLIs](#clis)
- [Branches](#branches)
- [Support and guarantees](#support-and-guarantees)
- [Removal of v1alpha3 & v1alpha4 apiVersions](#removal-of-v1alpha3--v1alpha4-apiversions)
- [Contributing a Patch](#contributing-a-patch)
- [Documentation changes](#documentation-changes)
- [Releases](#releases)
- [Proposal process (CAEP)](#proposal-process-caep)
- [Triaging E2E test failures](#triaging-e2e-test-failures)
- [Reviewing a Patch](#reviewing-a-patch)
- [Reviews](#reviews)
- [Approvals](#approvals)
- [Features and bugs](#features-and-bugs)
- [Experiments](#experiments)
- [Breaking Changes](#breaking-changes)
- [API conventions](#api-conventions)
- [Optional vs. Required](#optional-vs-required)
- [Example](#example)
- [Exceptions](#exceptions)
- [CRD additionalPrinterColumns](#crd-additionalprintercolumns)
- [Google Doc Viewing Permissions](#google-doc-viewing-permissions)
- [Issue and Pull Request Management](#issue-and-pull-request-management)
- [Contributors Ladder](#contributors-ladder)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -165,7 +164,7 @@ Cluster API maintains the most recent release/releases for all supported API and

| Minor Release | API Version | Supported Until |
|---------------|--------------|-----------------------------------------------------|
| v1.6.x | **v1beta1** | when v1.7.0 will be released |
| v1.5.x | **v1beta1** | when v1.7.0 will be released |
| v1.4.x | **v1beta1** | when v1.6.0 will be released, tentatively Nov 2023 |
| v1.3.x | **v1beta1** | EOL since 2023-07-25 - v1.5.0 release date |
| v1.2.x | **v1beta1** | EOL since 2023-03-28 - v1.4.0 release date |
Expand All @@ -176,7 +175,7 @@ Cluster API maintains the most recent release/releases for all supported API and

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

- Exceptions can be filed with maintainers and taken into consideration on a case-by-case basis.
- Exceptions can be filed with maintainers and taken into consideration on a case-by-case basis.giu

### Removal of v1alpha3 & v1alpha4 apiVersions

Expand Down
8 changes: 4 additions & 4 deletions docs/book/src/reference/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ When a new Kubernetes minor release is available, we will try to support it in a
the corresponding required changes in Cluster API are too invasive we won't backport the support and users have to wait
for the next Cluster API minor release.

For example, Cluster API v1.6.0 would support the following Kubernetes versions:
For example, Cluster API v1.5.0 would support the following Kubernetes versions:
* v1.24.x to v1.27.x for the management cluster
* v1.22.x to v1.27.x for the workload cluster
* When Kubernetes 1.28 is released, it will be supported in v1.6.x (but not in v1.5.x)
* When Kubernetes 1.28 is released, it will be supported in v1.5.x (but not in v1.4.x)

Support in this context means that we:
* maintain corresponding code paths
Expand Down Expand Up @@ -83,7 +83,7 @@ These diagrams show the relationships between components in a Cluster API releas
| Kubernetes v1.24 |||||
| Kubernetes v1.25 |||||
| Kubernetes v1.26 |||||
| Kubernetes v1.27 | | |||
| Kubernetes v1.27 | | |||


\* 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 Down Expand Up @@ -140,7 +140,7 @@ The Kubeadm Control Plane requires the Kubeadm Bootstrap Provider.
| v1.3 (v1beta1) | v1.10.0 |
| >= v1.3.4 (v1beta1) | v1.10.1 |
| v1.4 (v1beta1) | v1.10.1 |
| v1.4 (v1beta1) | v1.10.1 |
| v1.5 (v1beta1) | v1.10.1 |

#### Kubernetes version specific notes

Expand Down

0 comments on commit 734ae84

Please sign in to comment.