Skip to content

Commit

Permalink
improve version support documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriziopandini committed Feb 14, 2022
1 parent cca725c commit 276eff7
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/book/src/reference/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,25 @@ All Infrastructure Providers are maintained by independent teams. Other Bootstra

## Supported Kubernetes Versions

The project aims to keep the current minor release compatible with the actively supported Kubernetes minor releases, i.e., the current release (N), N-1, and N-2. To find out the exact range of Kubernetes versions supported by each component, please see the [tables](#release-components) below.
The project aims to keep the current minor release compatible with the actively supported Kubernetes minor releases, i.e.,
the current release (N), N-1, and N-2. Whenever possible we will go over and behind this trying to help our users:

- For a given Cluster API minor release, we give best-effort support for future Kubernetes versions that are released during the time
that we are actively supporting the CAPI minor release; depending on the changes that the new Kubernetes release brings in,
this could require users to update to the next patch release, or in other cases, determine the end of the support matrix
for a given Cluster API minor release.
- We are keeping best-effort support for older Kubernetes versions as much as possible.
Important! this is not a replacement/alternative for upstream Kubernetes support policies!
Support for older version of Kubernetes is limited to "Cluster API can start a Cluster with this Kubernetes version"
and "Cluster API can upgrade to the next Kubernetes version"; it does not include any extended support to Kubernetes itself.

Whenever a new Cluster API release will be cut, we will document the Kubernetes version compatibility matrix the release
has been tested with; summaries of Kubernetes versions supported by each component are additionally maintained in
the [tables](#release-components) below.

On a final comment, let's prise all the contributors keeping care of such a wide support matrix.
If someone is looking for opportunities to help with the project, this is definitely an area where additional hands
and eyes will be more than welcome and greatly beneficial to the entire community.

See the [following section](#kubernetes-version-support-as-a-function-of-cluster-topology) to understand how cluster topology affects version support.

Expand Down

0 comments on commit 276eff7

Please sign in to comment.