Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
7ec1d06
Update antora.yml
JakeSCahill May 22, 2025
011914c
Update local-antora-playbook.yml
JakeSCahill May 22, 2025
a34310a
DOC-1229 Document feature: Package Operator CRDs with Operator Helm C…
JakeSCahill Jun 26, 2025
30c90dc
Add docs for extraClusterConfig (#1187)
JakeSCahill Jul 2, 2025
90e6494
Rename extraClusterConfig to extraClusterConfiguration (#1195)
JakeSCahill Jul 8, 2025
36027b9
Fix field names
JakeSCahill Jul 9, 2025
e30e8f3
DOC-1407 single source additions for Cloud (#1139)
micheleRP Jun 13, 2025
c872eba
DOC-1449 revert playbook (#1164)
micheleRP Jun 15, 2025
0eea91c
DOC-1494 Mark KC as community supported (#1211)
micheleRP Jul 17, 2025
7177b07
Remove Kafka Connect info from Kubernetes docs (#1186)
JakeSCahill Jul 18, 2025
c796187
docs: remove ephemeral auth on Kafka API (#1210)
paulohtb6 Jul 18, 2025
fa353c0
DOC-1378: Compaction robustness (#1153)
Feediver1 Jul 18, 2025
984361f
[25.2] Serialized schema in Schema Registry API, support for confluen…
kbatuigas Jul 21, 2025
01d017e
DOC-1499 Update compatibility matrix for 25.2
JakeSCahill Jul 23, 2025
07a6596
Document cluster scope for the Kubernetes operator
JakeSCahill Jul 24, 2025
9358a0e
Remove references to createRPKBundleCRs
JakeSCahill Jul 25, 2025
c887d35
docs: use attributes instead of page level props (#1220)
paulohtb6 Jul 25, 2025
9789eb5
[25.2] KIP-554 support (#1240)
kbatuigas Jul 26, 2025
88e640f
[25.2] Iceberg - JSON Schema support (#1207)
kbatuigas Jul 26, 2025
819623a
Update modules/get-started/pages/release-notes/operator.adoc
JakeSCahill Jul 28, 2025
480757a
Console tab (#1239)
JakeSCahill Jul 28, 2025
9bc58b4
Apply suggestions from code review
JakeSCahill Jul 28, 2025
ee8faeb
Merge branch 'beta' into DOC-1459
JakeSCahill Jul 28, 2025
7bde5cb
Apply suggestions from code review
JakeSCahill Jul 29, 2025
a7cbfb6
Merge branch 'main' of https://github.com/redpanda-data/docs into DOC…
JakeSCahill Aug 1, 2025
251fc23
Apply suggestions from code review
JakeSCahill Aug 1, 2025
8a84690
Merge branch 'main' into DOC-1459
JakeSCahill Aug 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To deploy Redpanda in Kubernetes, you can choose between Helm for its simplicity
| Multi-tenancy management
| ✅
| ⚠️
| Helm requires separate releases to manage multiple clusters, making management more complex. The Redpanda Operator simplifies this through declarative custom resources.
| Helm requires separate releases to manage multiple clusters, making management more complex. The Redpanda Operator simplifies multi-tenancy by managing clusters across different namespaces from a single operator instance.

|===

Expand All @@ -50,7 +50,7 @@ TIP: If you are already using the Redpanda Helm chart and want to migrate to the
[[helm-and-redpanda-operator]]
=== Redpanda Operator

The Redpanda Operator is designed for production-grade Redpanda deployments, offering enhanced lifecycle management, automation, and GitOps compatibility.
The Redpanda Operator is designed for production-grade Redpanda deployments, offering enhanced lifecycle management, automation, and GitOps compatibility. The Redpanda Operator defaults to cluster scope, enabling it to manage multiple Redpanda clusters across different namespaces from a single operator instance.

The Redpanda Operator directly reconciles Redpanda resources, performing tasks such as installations, updates, and cleanup.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ Operator::
+
--

NOTE: The Redpanda Operator is namespace scoped. You must install the Redpanda Operator in the same namespace as your Redpanda resource (Redpanda cluster).

. Make sure that you have permission to install custom resource definitions (CRDs):
+
Expand Down Expand Up @@ -109,8 +108,6 @@ spec:
```bash
kubectl apply -f redpanda-cluster.yaml --namespace <namespace>
```
+
NOTE: The Redpanda resource must be deployed in the same namespace as the Redpanda Operator. Each new deployment of Redpanda requires a separate namespace.

. Wait for the Redpanda Operator to deploy Redpanda using the Helm chart:
+
Expand Down Expand Up @@ -260,19 +257,8 @@ Operator::
+
--

. Install another instance of the Redpanda Operator in a different namespace to your existing ones. This Redpanda Operator will manage Redpanda clusters only in its namespace.
+
[,bash,subs="attributes+"]
----
helm repo add redpanda https://charts.redpanda.com
helm repo update
helm upgrade --install redpanda-controller redpanda/operator \
--namespace <another-namespace> \
--set image.tag={latest-operator-version} \
--create-namespace
----

. Apply a Redpanda resource in the same namespace as your new Redpanda Operator to deploy your new Redpanda cluster.
. Deploy additional Redpanda clusters in different namespaces. Your existing Redpanda Operator will automatically manage them.
+
NOTE: Make sure to use unique node ports for the listeners in your Redpanda resource so that they don't conflict with any existing node ports in your other Redpanda clusters. See <<External access>>.
+
Expand All @@ -283,6 +269,7 @@ apiVersion: cluster.redpanda.com/v1alpha2
kind: Redpanda
metadata:
name: redpanda-two
namespace: <different-namespace>
spec:
clusterSpec:
listeners:
Expand All @@ -305,6 +292,13 @@ spec:
default:
advertisedPorts: [30084]
----

. Apply the resource to a different namespace:
+
```bash
kubectl apply -f redpanda-cluster-two.yaml --namespace <different-namespace>
```

--
Helm::
+
Expand Down Expand Up @@ -660,7 +654,6 @@ rbac:
annotations: {}
----

NOTE: If you use the Redpanda Operator, you must also deploy the Redpanda Operator Helm chart with `rbac.createRPKBundleCRs` set to `true` to give it the required roles.

See also: xref:manage:kubernetes/k-rack-awareness.adoc[]

Expand Down
18 changes: 18 additions & 0 deletions modules/deploy/partials/kubernetes/deploy-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,24 @@ helm upgrade --install redpanda-controller redpanda/operator \
<1> This flag specifies the exact version of the Redpanda Operator Helm chart to use for deployment. By setting this value, you pin the chart to a specific version, which prevents automatic updates that might introduce breaking changes or new features that have not been tested in your environment.
<2> This flag ensures that the CRDs are installed as part of the Redpanda Operator deployment.
+
This command deploys the Redpanda Operator in cluster scope (default in v25.2+), allowing it to manage Redpanda clusters across multiple namespaces.
+
To deploy the Redpanda Operator in namespace scope (managing only resources within its deployment namespace), use:
+
[,bash,subs="attributes+"]
----
helm upgrade --install redpanda-controller redpanda/operator \
--namespace <namespace> \
--create-namespace \
--version {latest-operator-version} \
--set crds.enabled=true \
--set 'additionalCmdFlags=["--namespace=<namespace>"]' <3>
----
+
<3> This flag restricts the Redpanda Operator to manage resources only within the specified namespace.
+
WARNING: Do not run multiple Redpanda Operators in different scopes (cluster and namespace scope) in the same cluster as this can cause resource conflicts.
+
:note-caption: Older versions of the Redpanda Operator
+
[NOTE]
Expand Down
39 changes: 34 additions & 5 deletions modules/get-started/pages/release-notes/operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,44 @@ See also:
* xref:upgrade:k-compatibility.adoc[]
* xref:upgrade:k-rolling-upgrade.adoc[]

== Redpanda Operator v25.1.x (GA)
NOTE: 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, you can deploy the link:https://artifacthub.io/packages/helm/redpanda-data/console[standalone Redpanda Console Helm chart^] or xref:deploy:deployment-option/self-hosted/kubernetes/k-production-deployment.adoc[deploy Redpanda using the Redpanda Helm chart] instead of the Redpanda Operator.

link:https://github.com/redpanda-data/redpanda-operator/blob/release/v25.1.x/operator/CHANGELOG.md[Changelog^]
== Redpanda Operator v25.2.x

link:https://github.com/redpanda-data/redpanda-operator/blob/release/v25.2.x/operator/CHANGELOG.md[Changelog^]

=== Cluster scope by default

Starting in v25.2, the Redpanda Operator defaults to cluster scope instead of namespace scope. This change provides several benefits:

* **Simplified management**: A single operator instance can manage multiple Redpanda clusters across different namespaces.
* **Reduced resource overhead**: No need to deploy separate operator instances for each namespace.
* **Centralized upgrades**: Upgrade the operator once to benefit all managed Redpanda clusters.
* **Cross-namespace management**: Deploy the operator in a dedicated namespace (such as `redpanda-system`) while managing clusters in application namespaces.
* **Simplified RBAC for debug bundles**: The Redpanda Operator now provides all required permissions for `rpk` debug bundle collection by default. The `rbac.createRPKBundleCRs` flag is no longer needed.

==== Migration considerations

If you're upgrading from a previous version that used namespace-scoped operators:

=== Redpanda Console v3
* **No manual steps required**: The Redpanda Operator automatically reconciles existing Redpanda clusters across namespaces.
* **New deployments default to cluster scope**: Regardless of which namespace you deploy the Redpanda Operator to (including `default`).
* **Delete extra Redpanda Operator deployments**: After upgrading, ensure only one Redpanda Operator remains in the cluster (the one running in cluster scope). Use `helm uninstall` to remove any other Redpanda Operator deployments from previous namespace-scoped installations.

Redpanda Console v3 is **not yet available when deploying with the Redpanda Operator**, due to pending CRD updates. The Redpanda Operator continues to deploy Redpanda Console v2. xref:24.3@ROOT:console:index.adoc[View the Redpanda Console v2 documentation].
To maintain namespace scope, use the `--set 'additionalCmdFlags=["--namespace=<namespace>"]'` flag when installing or upgrading the Redpanda Operator. The `--namespace` flag in the helm command only specifies which namespace to deploy the Redpanda Operator into and does not affect its operational scope.

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. Redpanda Console v3 introduces support for unified authentication and authorization with Redpanda, including user impersonation.
WARNING: Do not run multiple Redpanda Operators in different scopes (cluster and namespace scope) in the same cluster as this can cause resource conflicts.

==== RBAC requirements

Important RBAC considerations for v25.2+:

* **ClusterRole permissions always required**: Regardless of whether you use cluster or namespace scope, the Redpanda Operator always needs ClusterRole permissions.
* **Automatic configuration**: These permissions are automatically configured when you install the Redpanda Operator.

== Redpanda Operator v25.1.x (GA)

link:https://github.com/redpanda-data/redpanda-operator/blob/release/v25.1.x/operator/CHANGELOG.md[Changelog^]

=== Flux removed

Expand Down
1 change: 0 additions & 1 deletion modules/manage/pages/kubernetes/k-rack-awareness.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ You must have the following:

* https://kubernetes.io/docs/tasks/tools/#kubectl[Kubectl^]: Ensure you have the `kubectl` command-line tool installed and configured to communicate with your cluster.

* If you use the xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc[Redpanda Operator], you must deploy it with the `--set rbac.createRPKBundleCRs=true` flag to give it the required ClusterRoles to read node labels and annotations.

== Annotate or label Node resources

Expand Down
4 changes: 2 additions & 2 deletions modules/migrate/pages/kubernetes/helm-to-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ You should see `yes` in the output.
+
You need these cluster-level permissions to install the Redpanda Operator CRDs in the next steps.

. Install the Redpanda Operator *in the same namespace as your Redpanda Helm chart*:
. Install the Redpanda Operator. Starting in v25.2, the Redpanda Operator can manage Redpanda clusters in any namespace:
+
include::deploy:partial$kubernetes/deploy-operator.adoc[]

Expand Down Expand Up @@ -138,7 +138,7 @@ spec:
TIP: The Redpanda CRD is compatible with the version of the Helm chart defined in the operator. For details on the structure and configuration options of the Redpanda custom resource, refer to the xref:reference:k-crd.adoc#redpandaclusterspec[Redpanda Operator CRD reference].
--

. Adopt the Redpanda cluster by creating an instance of the Redpanda custom resource in the same namespace as the Redpanda Operator:
. Adopt the Redpanda cluster by creating an instance of the Redpanda custom resource:
+
```bash
kubectl apply -f redpanda-cluster.yaml --namespace <namespace>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ spec:
kubectl apply -f redpanda-cluster.yaml --namespace <namespace>
```

NOTE: You must deploy the Redpanda Operator with the `--set rbac.createRPKBundleCRs=true` flag to give it the required ClusterRoles.


--
Helm::
Expand Down
11 changes: 0 additions & 11 deletions modules/troubleshoot/partials/errors-and-solutions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -232,18 +232,7 @@ helm repo update

//end::deployment-name-exists[]

//tag::deployment-forbidden-debug-bundle[]
=== redpanda-rpk-debug-bundle is forbidden

If you see this error, your Redpanda Operator's RBAC settings are out of sync with the Pod-level RBAC in the Redpanda resource:

[.no-copy]
----
… forbidden: user "…-operator" … attempting to grant RBAC permissions not currently held …
----

To fix this error, make sure you haven't disabled xref:reference:k-operator-helm-spec.adoc#rbac-createrpkbundlecrs[`rbac.createRPKBundleCRs`] in the Redpanda Operator chart while still leaving xref:reference:k-crd.adoc#k8s-api-github-com-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-rbac[`spec.clusterSpec.rbac.rpkDebugBundle`] enabled in your Redpanda resource. Either enable both or disable both.
//end::deployment-forbidden-debug-bundle[]

//tag::deployment-data-dir-not-writable[]
=== Fatal error during checker "Data directory is writable" execution
Expand Down
14 changes: 10 additions & 4 deletions modules/upgrade/pages/k-compatibility.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Redpanda Helm chart and Redpanda Operator are versioned and tested alongside

Starting from version 25.1.1, the Redpanda Operator and Redpanda Helm chart follow a new versioning scheme aligned with Redpanda core releases:

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

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

Expand All @@ -37,7 +37,13 @@ Redpanda Core has no direct dependency on Kubernetes. Compatibility is influence
|===
|Redpanda Core / `rpk` |Helm Chart |Operator Helm Chart |Operator |Helm CLI |Kubernetes

.1+|25.2.x
.2+|25.2.x

|25.2.x
|25.2.x
|25.2.x
|3.12+
d|1.30.x - 1.33.x{fn-k8s-compatibility}

|25.1.x
|25.1.x
Expand Down Expand Up @@ -123,12 +129,12 @@ Upgrading the Helm chart may also upgrade Redpanda Console. Because of this buil
|Redpanda Console |Helm Chart |Operator

|v3.x.x
|25.1.x
|25.2.x, 25.1.x
|Not yet supported

|v2.x.x
|5.10.1, 5.9.x, 5.8.x
|25.1.x, 2.4.x, 2.3.x, 2.2.x
|25.2.x, 25.1.x, 2.4.x, 2.3.x, 2.2.x

|===

Expand Down
2 changes: 1 addition & 1 deletion modules/upgrade/pages/k-upgrade-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

. Make sure to https://github.com/redpanda-data/redpanda-operator/releases[review the release notes^] to understand any significant changes, bug fixes, or potential disruptions that could affect your existing deployment.

. xref:upgrade:k-compatibility.adoc[Review the Kubernetes compatibility matrix] and determine the version of the Redpanda Operator that is compatible with the Helm chart version you plan to use. The Redpanda Operator must be able to understand and manage the Helm chart and the Redpanda version you are deploying.
. xref:upgrade:k-compatibility.adoc[Review the Kubernetes compatibility matrix].

. Back up your current Helm values for the Redpanda Operator Helm chart:
+
Expand Down