Skip to content

Commit 67922f3

Browse files
Clarify the K8s compatibility guidelines (#1094)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 2ebb9ce commit 67922f3

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ asciidoc:
3131
console-beta-version: '3.0.0-beta.1'
3232
console-beta-tag: 'v3.0.0-beta.1'
3333
# --
34-
supported-kubernetes-version: 1.25.0-0
34+
supported-kubernetes-version: 1.27.0-0
3535
supported-helm-version: 3.10.0
3636
supported-rhel-required: '8'
3737
supported-rhel-recommended: '9+'

modules/upgrade/pages/k-compatibility.adoc

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= Kubernetes Compatibility
22
:description: A compatibility matrix for versions of Redpanda, Redpanda Helm chart, and Redpanda Operator.
33
:page-categories: Upgrades
4+
:fn-k8s-compatibility: footnote:fn-k8s-compatibility[These Kubernetes versions are suggested ranges, based on testing and reported usage. Not every patch or minor version within these ranges is explicitly tested.]
45

56
This topic describes the compatibility for versions of Redpanda, Redpanda Operator, and the Helm charts. The tables identify the version requirements and compatibility guidelines.
67

@@ -20,10 +21,20 @@ Starting from version v25.1.1-beta1, the Redpanda Operator and Redpanda Helm cha
2021

2122
Each Redpanda Operator and Helm chart version supports the corresponding Redpanda core version plus one minor version above and one below. This approach ensures flexibility during upgrades. For example, Redpanda Operator version 25.1.1 supports Redpanda core versions 25.2.x, 25.1.x, and 24.3.x.
2223

23-
Redpanda Operator and Helm chart versions are supported only while their associated Redpanda core version remains supported. If the core version reaches End-of-Life (EoL), the corresponding Operator and Helm chart versions also reach EoL.
24+
Redpanda Operator and Helm chart versions are supported only while their associated Redpanda core version remains supported. If the core version reaches end of life (EoL), the corresponding versions of the Redpanda Operator and Helm chart also reach EoL.
2425

2526
NOTE: Beta versions are available only for testing and feedback. They are not supported by Redpanda and should not be used in production environments. To give feedback on beta releases, reach out to the Redpanda team in https://redpanda.com/slack[Redpanda Community Slack^].
2627

28+
== Kubernetes version policy
29+
30+
The minimum supported Kubernetes version is {supported-kubernetes-version}.
31+
32+
The Kubernetes versions listed in the compatibility matrix are suggested ranges, based on testing and reported usage. Not every patch or minor version within these ranges is explicitly tested.
33+
34+
To request compatibility testing of a Kubernetes version outside of the given ranges, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^].
35+
36+
Redpanda Core has no direct dependency on Kubernetes. Compatibility is influenced indirectly by the Helm chart or Operator that you use.
37+
2738
== Compatibility matrix
2839

2940
[cols="1a,1a,1a,1a,1a,1a"]
@@ -42,21 +53,24 @@ NOTE: Beta versions are available only for testing and feedback. They are not su
4253
|25.1.1-beta1, 0.4.41, 0.4.36
4354
|25.1.1-beta1, 2.4.x, 2.3.x
4455
|3.12+
45-
|1.29.x - 1.32.x
56+
// d (default) here is required to get footnotes to appear at the bottom of the page
57+
// instead of inside the table cell.
58+
// See https://github.com/asciidoctor/asciidoctor/issues/2350#issuecomment-546841684
59+
d|1.28.x - 1.32.x{fn-k8s-compatibility}
4660

4761
|24.3.x
4862
|25.1-k8s-beta, 5.9.x
4963
|25.1-k8s-beta, 0.4.41, 0.4.36, 0.4.29
5064
|25.1-k8s-beta, 2.4.x, 2.3.x, 2.2.x
5165
|3.11+
52-
|1.28.x - 1.31.x
66+
d|1.28.x - 1.31.x{fn-k8s-compatibility}
5367

5468
|24.2.x
5569
|5.9.x, 5.8.x
5670
|0.4.29
5771
|2.2.x
5872
|3.10+
59-
|1.27.x - 1.30.x
73+
d|1.27.x - 1.30.x{fn-k8s-compatibility}
6074
|===
6175

6276
By default, the Redpanda Helm chart depends on cert-manager for enabling TLS.
@@ -65,9 +79,11 @@ See the https://github.com/cert-manager/cert-manager/releases[cert-manager relea
6579

6680
== Redpanda Console integration
6781

68-
Redpanda Console is integrated as a subchart within the Redpanda Helm chart. Each version of the Redpanda Helm chart defines a range of versions of the Redpanda Console chart that it supports. The version of Redpanda Console that is installed depends on the version of the Redpanda Helm chart you choose to install.
82+
Redpanda Console is deployed through the Redpanda Helm chart. It is included as a subchart, and its version is determined by the version of the parent Helm chart.
83+
84+
The Redpanda Helm chart defines which Redpanda Console versions it supports. When you install or update the Helm chart, it automatically selects the appropriate Redpanda Console version.
6985

70-
This interdependency is established when you add or update the Redpanda chart repository, linking a particular version of Redpanda Console with the corresponding version of the Redpanda Helm chart. As a result of this integration, any updates you apply to the Redpanda Helm chart might also lead to changes in the version of the Redpanda Console. This means that selecting a different version of the Redpanda Helm chart can automatically determine the version of the Console that gets installed or updated in your environment.
86+
Upgrading the Helm chart may also upgrade Redpanda Console. Because of this built-in dependency, selecting a different Helm chart version can change the Redpanda Console version deployed in your environment.
7187

7288
[cols="1a,1a,1a"]
7389
|===

0 commit comments

Comments
 (0)