Skip to content

Commit b2654cc

Browse files
JakeSCahillpaulohtb6
authored andcommitted
Prepare Kubernetes docs for 25.2 release using 25.1 helm chart/operator (#1249)
1 parent 30647cb commit b2654cc

4 files changed

Lines changed: 70 additions & 27 deletions

File tree

modules/console/partials/operator-console-version-note.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.The Redpanda Operator deploys Redpanda Console v2.x, not v3.x
1+
.The Redpanda Operator deploys Redpanda Console v2.x, not v3.x.
22
[%collapsible]
33
====
44
Redpanda Console v3 is **not yet available when deploying with the Redpanda Operator**. The Redpanda Operator continues to deploy Redpanda Console v2. To try Redpanda Console v3 in Kubernetes, you can xref:deploy:deployment-option/self-hosted/kubernetes/k-production-deployment.adoc[deploy Redpanda using the Redpanda Helm chart] instead of the Redpanda Operator.

modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ spec:
8484
#licenseSecretRef:
8585
#name: <secret-name>
8686
#key: <secret-key>
87+
image:
88+
tag: {latest-redpanda-tag}
8789
statefulset:
8890
extraVolumes: |-
8991
- name: redpanda-io-config
@@ -99,6 +101,7 @@ spec:
99101
- `metadata.name`: Name to assign the Redpanda cluster.
100102
- xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-api-redpanda-v1alpha2-redpandaclusterspec[`spec.clusterSpec`]: This is where you can override default values in the Redpanda Helm chart. Here, you mount the <<prerequisites, I/O configuration file>> to the Pods that run Redpanda. For other configuration details, see <<Production considerations>>.
101103
- `spec.clusterSpec.enterprise`: If you want to use enterprise features in Redpanda, uncomment this section and add the details of a Secret that stores your Enterprise Edition license key. For details, see xref:get-started:licenses.adoc[].
104+
- `spec.clusterSpec.image.tag`: Deploys the latest version of Redpanda.
102105
- `spec.clusterSpec.statefulset`: Here, you mount the <<prerequisites, I/O configuration file>> to the Pods that run Redpanda. For other configuration details, see <<Production considerations>>.
103106
104107
. Apply the Redpanda resource:
@@ -169,6 +172,8 @@ The Redpanda Helm chart enables TLS by default and uses cert-manager to manage T
169172
.`redpanda-values.yaml`
170173
[,yaml]
171174
----
175+
image:
176+
tag: {latest-redpanda-tag}
172177
statefulset:
173178
extraVolumes: |-
174179
- name: redpanda-io-config

modules/deploy/partials/kubernetes/guides/deploy-redpanda.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ metadata:
5757
name: redpanda
5858
spec:
5959
clusterSpec:
60+
image:
61+
tag: {latest-redpanda-tag}
6062
external:
6163
domain: customredpandadomain.local
6264
auth:
@@ -75,6 +77,7 @@ spec:
7577
kubectl apply -f redpanda-cluster.yaml --namespace <namespace>
7678
```
7779
+
80+
- `image.tag`: Deploys the latest version of Redpanda.
7881
- `external.domain`: The custom domain that each broker will advertise to clients externally. This domain is added to the internal and external TLS certificates so that you can connect to the cluster using this domain.
7982
- `auth.sasl.name`: Creates a superuser called `superuser` that can grant permissions to new users in your cluster using access control lists (ACLs).
8083
- `storage.persistentVolume.storageClass`: Points each PVC associated with the Redpanda brokers to the `csi-driver-lvm-striped-xfs` StorageClass. This StorageClass allows the LVM CSI driver to provision the appropriate local PersistentVolumes backed by NVMe disks for each Redpanda broker.
@@ -127,6 +130,7 @@ helm repo update
127130
helm install redpanda redpanda/redpanda \
128131
--version {latest-redpanda-helm-chart-version} \
129132
--namespace <namespace> --create-namespace \
133+
--set image.tag={latest-redpanda-tag} \
130134
--set auth.sasl.enabled=true \
131135
--set "auth.sasl.users[0].name=superuser" \
132136
--set "auth.sasl.users[0].password=secretpassword" \
@@ -136,6 +140,7 @@ helm install redpanda redpanda/redpanda \
136140
--timeout 1h
137141
----
138142
+
143+
- `image.tag`: Deploys the latest version of Redpanda.
139144
- `external.domain`: The custom domain that each broker advertises to clients externally. This domain is added to the internal and external TLS certificates so that you can connect to the cluster using this domain.
140145
- `auth.sasl.name`: Creates a superuser called `superuser` that can grant permissions to new users in your cluster using access control lists (ACLs).
141146
- `storage.persistentVolume.storageClass`: Points each PVC associated with the Redpanda brokers to the `csi-driver-lvm-striped-xfs` StorageClass. This StorageClass allows the LVM CSI driver to provision the appropriate local PersistentVolumes backed by NVMe disks for each Redpanda broker.

modules/upgrade/pages/k-compatibility.adoc

Lines changed: 59 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,20 @@ include::partial$versioning.adoc[]
1111

1212
The Redpanda Helm chart and Redpanda Operator are versioned and tested alongside specific Redpanda core releases, Kubernetes, and Helm.
1313

14-
Starting from version v25.1.1-beta1, the Redpanda Operator and Redpanda Helm chart follow a new versioning scheme aligned with Redpanda core releases:
14+
Starting from version 25.1.1, the Redpanda Operator and Redpanda Helm chart follow a new versioning scheme aligned with Redpanda core releases:
1515

1616
- `v25.1` refers to the Redpanda core feature release deployed by default.
1717

1818
- The patch version denotes the patch version for either the operator or Helm chart. It is not the patch version of Redpanda core.
1919

20-
- The beta version is used for pre-release versions of the Redpanda Operator and Helm chart. These versions are not intended for production use.
20+
NOTE: If a version includes `-beta`, it is a pre-release version of the Redpanda Operator and Helm chart. These versions are not supported and should not be used in production environments. Beta versions are available only for testing and feedback. To give feedback on beta releases, reach out to the Redpanda team in https://redpanda.com/slack[Redpanda Community Slack^].
2121

2222
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.
2323

2424
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.
2525

26-
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^].
27-
2826
== Kubernetes version policy
2927

30-
The minimum supported Kubernetes version is {supported-kubernetes-version}.
31-
3228
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.
3329

3430
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^].
@@ -41,32 +37,69 @@ Redpanda Core has no direct dependency on Kubernetes. Compatibility is influence
4137
|===
4238
|Redpanda Core / `rpk` |Helm Chart |Operator Helm Chart |Operator |Helm CLI |Kubernetes
4339

44-
// |25.2.x
45-
// |25.3-k8sx, 25.2-k8sx, 25.1-k8sx
46-
// |25.3-k8sx, 25.2-k8sx, 25.1-k8sx
47-
// |25.3-k8sx, 25.2-k8sx, 25.1-k8sx
48-
// |3.13+
49-
// |1.30.x - 1.33.x
40+
.1+|25.2.x
5041

5142
|25.1.x
52-
|25.1.1-betaX, 5.10.x, 5.9.x
53-
|25.1.1-betaX, 2.4.x, 0.4.36
54-
|25.1.1-betaX, 2.4.x, 2.3.x
43+
|25.1.x
44+
|25.1.x
45+
|3.12+
46+
d|1.28.x - 1.32.x{fn-k8s-compatibility}
47+
48+
.3+|25.1.x
49+
|25.1.x
50+
|25.1.x
51+
|25.1.x
5552
|3.12+
5653
// d (default) here is required to get footnotes to appear at the bottom of the page
5754
// instead of inside the table cell.
5855
// See https://github.com/asciidoctor/asciidoctor/issues/2350#issuecomment-546841684
5956
d|1.28.x - 1.32.x{fn-k8s-compatibility}
6057

61-
|24.3.x
62-
|25.1.1-betaX, 5.9.x
63-
|25.1.1-betaX, 0.4.41, 0.4.36, 0.4.29
64-
|25.1.1-betaX, 2.4.x, 2.3.x, 2.2.x
58+
|5.10.x
59+
|2.4.x
60+
|2.4.x
61+
|3.12+
62+
d|1.28.x - 1.32.x{fn-k8s-compatibility}
63+
64+
|5.9.x
65+
|0.4.36
66+
|2.3.x
67+
|3.12+
68+
d|1.28.x - 1.32.x{fn-k8s-compatibility}
69+
70+
.4+|24.3.x
71+
|25.1.x
72+
|25.1.x
73+
|25.1.x
74+
|3.11+
75+
d|1.28.x - 1.32.x{fn-k8s-compatibility}
76+
77+
|5.9.x
78+
|0.4.41
79+
|2.4.x
80+
|3.11+
81+
d|1.28.x - 1.31.x{fn-k8s-compatibility}
82+
83+
|5.9.x
84+
|0.4.36
85+
|2.3.x
86+
|3.11+
87+
d|1.28.x - 1.31.x{fn-k8s-compatibility}
88+
89+
|5.9.x
90+
|0.4.29
91+
|2.2.x
6592
|3.11+
6693
d|1.28.x - 1.31.x{fn-k8s-compatibility}
6794

68-
|24.2.x
69-
|5.9.x, 5.8.x
95+
.2+|24.2.x
96+
|5.9.x
97+
|0.4.29
98+
|2.2.x
99+
|3.10+
100+
d|1.27.x - 1.30.x{fn-k8s-compatibility}
101+
102+
|5.8.x
70103
|0.4.29
71104
|2.2.x
72105
|3.10+
@@ -90,16 +123,16 @@ Upgrading the Helm chart may also upgrade Redpanda Console. Because of this buil
90123
|Redpanda Console |Helm Chart |Operator
91124

92125
|v3.x.x
93-
|v25.1.1-beta1
94-
|v25.1.1-beta1
126+
|25.1.x
127+
|Not yet supported
95128

96129
|v2.x.x
97-
| 5.10.1, 5.9.x, 5.8.x
98-
|2.4.x, 2.3.x, 2.2.x
130+
|5.10.1, 5.9.x, 5.8.x
131+
|25.1.x, 2.4.x, 2.3.x, 2.2.x
99132

100133
|===
101134

102135
== Next steps
103136

104137
- xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc[Deploy Redpanda in Kubernetes]
105-
- xref:k-rolling-upgrade.adoc[Upgrade Redpanda in Kubernetes]
138+
- xref:k-rolling-upgrade.adoc[Upgrade Redpanda in Kubernetes]

0 commit comments

Comments
 (0)