Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 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
96e6f90
Merge branch 'main' of https://github.com/redpanda-data/docs into DOC…
JakeSCahill Sep 8, 2025
5a6b81b
Remove beta from nav
JakeSCahill Sep 8, 2025
a009990
Remove duplicate warning
JakeSCahill Sep 8, 2025
73f9543
Merge branch 'main' into DOC-1459
JakeSCahill Oct 7, 2025
a8593cc
Add docs for the Role resource in Kubernetes (#1378)
JakeSCahill Oct 23, 2025
41763c9
Merge branch 'main' into DOC-1459
JakeSCahill Oct 27, 2025
a40e3cc
DOC-1530 Add Console v3 docs for Redpanda Operator v25.2 (#1421)
JakeSCahill Nov 26, 2025
7aed402
Merge branch 'main' into DOC-1459
JakeSCahill Nov 26, 2025
5873b95
Trim what's new
JakeSCahill Dec 1, 2025
e758fc7
Improve migration docs for K8s
JakeSCahill Dec 3, 2025
659bd2c
fix link
JakeSCahill Dec 3, 2025
fe60736
Replace mentions of deprecated fields
JakeSCahill Dec 3, 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
6 changes: 3 additions & 3 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@
** xref:deploy:redpanda/index.adoc[Redpanda]
*** xref:deploy:redpanda/kubernetes/index.adoc[Kubernetes]
**** xref:deploy:redpanda/kubernetes/k-deployment-overview.adoc[Overview]
**** xref:deploy:redpanda/kubernetes/k-25.2-beta.adoc[Try v25.2]
**** xref:deploy:redpanda/kubernetes/get-started-dev.adoc[Get Started]
***** xref:deploy:redpanda/kubernetes/aks-guide.adoc[Azure AKS]
***** xref:deploy:redpanda/kubernetes/eks-guide.adoc[Amazon EKS]
Expand Down Expand Up @@ -130,9 +129,10 @@
**** xref:manage:kubernetes/security/tls/index.adoc[TLS Encryption]
***** xref:manage:kubernetes/security/tls/k-cert-manager.adoc[Use cert-manager]
***** xref:manage:kubernetes/security/tls/k-secrets.adoc[Use Secrets]
**** xref:manage:kubernetes/security/authentication/index.adoc[Authentication]
**** xref:manage:kubernetes/security/authentication/index.adoc[Authentication and Authorization]
***** xref:manage:kubernetes/security/authentication/k-authentication.adoc[Enable Authentication]
***** xref:manage:kubernetes/security/authentication/k-user-controller.adoc[Manage Users and ACLs]
***** xref:manage:kubernetes/security/authentication/k-user-controller.adoc[Manage Users and ACLs (Operator)]
***** xref:manage:kubernetes/security/authorization/k-role-controller.adoc[Manage Roles and ACLs (Operator)]
**** xref:manage:kubernetes/security/k-audit-logging.adoc[Audit Logging]
*** xref:manage:kubernetes/k-rack-awareness.adoc[Rack Awareness]
*** xref:manage:kubernetes/k-remote-read-replicas.adoc[Remote Read Replicas]
Expand Down
18 changes: 8 additions & 10 deletions modules/console/pages/config/analytics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,18 @@ When Redpanda Console is part of the Redpanda Helm chart or Operator:
Operator::
+
[,yaml]
.`redpanda-cluster`.yaml
.`redpanda-console`.yaml
----
apiVersion: cluster.redpanda.com/v1alpha2
kind: Redpanda
kind: Console
metadata:
name: redpanda
name: redpanda-console
spec:
clusterSpec:
console:
enabled: true
console:
config:
analytics:
enabled: false
clusterRef:
name: redpanda
config:
analytics:
enabled: false
----

Helm::
Expand Down
37 changes: 16 additions & 21 deletions modules/console/pages/config/configure-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
:page-aliases: console:reference/config.adoc, reference:console/config.adoc
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/configure-console.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

Redpanda Console loads configuration properties from three sources, in the following order of precedence:

Expand Down Expand Up @@ -79,35 +78,31 @@ Operator::
Configure Redpanda Console in the `console` section of your Redpanda custom resource:
+
[,yaml]
.`redpanda-cluster`.yaml
.`redpanda-console`.yaml
----
apiVersion: cluster.redpanda.com/v1alpha2
kind: Redpanda
kind: Console
metadata:
name: redpanda
name: redpanda-console
spec:
clusterSpec:
console:
enabled: true
console:
config:
#kafka:
#brokers: [] # Auto-configured to connect to this Redpanda cluster
server:
listenPort: 8080
auditLog:
enabled: false # default; set to true to write audit logs to stdout
additionalHeaders: # specifies HTTP headers to include in audit logs
- "X-Forwarded-For"
- "User-Agent"
# Add any other Redpanda Console configuration here
clusterRef:
name: redpanda # Reference to your Redpanda cluster
config:
server:
listenPort: 8080
auditLog:
enabled: false
additionalHeaders:
- "X-Forwarded-For"
- "User-Agent"
# Add any other Redpanda Console configuration here
----
+
Apply the configuration:
+
[,bash]
----
kubectl apply -f redpanda-cluster.yaml --namespace <namespace>
kubectl apply -f redpanda-console.yaml --namespace <namespace>
----

Helm::
Expand All @@ -122,7 +117,7 @@ console:
console:
config:
#kafka:
#brokers: [] # Auto-configured to connect to this Redpanda cluster
#brokers: [] # You can leave this empty. The chart is already auto-configured to connect to your Redpanda cluster
server:
listenPort: 8080
auditLog:
Expand Down
17 changes: 15 additions & 2 deletions modules/console/pages/config/connect-to-redpanda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
:description: Learn how to configure Redpanda Console to connect to a Redpanda cluster and ensure communication with your Redpanda brokers.
:page-context-switcher: [{"name": "Redpanda Console v2.x", "to": "24.3@ROOT:console:config/connect-to-redpanda.adoc" },{"name": "Redpanda Console v3.x", "to": "current" } ]

include::console:partial$operator-console-version-note.adoc[]

Redpanda Console connects to your Redpanda cluster using dedicated configuration blocks for the Kafka API, Schema Registry API, and Admin API. Each connection serves a different purpose:

Expand Down Expand Up @@ -56,7 +55,21 @@ kafka:
Kubernetes embedded::
+
--
When Redpanda Console is deployed as part of the Redpanda Helm chart or Operator, no additional connection configuration is required. The chart or Operator automatically configures Redpanda Console to connect to the Redpanda cluster. Only configure the `kafka` block if you need to override the default connection settings (for example, to connect to a different cluster or use custom authentication).
[tabs]
====
Operator::
+
When deploying Redpanda Console with the Redpanda Operator, you can connect Console to your Redpanda cluster in two ways:

- **clusterRef:** Reference the Redpanda cluster by name for automatic connection. This is the recommended approach for most users.
- **staticConfiguration:** Manually specify connection details for Kafka, Admin API, and Schema Registry if you need custom settings.

The Operator will automatically configure Console to connect to the referenced cluster when using `clusterRef`. Use `staticConfiguration` only if you need to override the default connection or connect to a different cluster.

Helm chart::
+
Redpanda Console is automatically configured to connect to the Redpanda cluster managed by the Helm chart. No additional connection configuration is required. Only configure the `kafka` block if you need to override the default connection settings (for example, to connect to a different cluster or use custom authentication).
====
--
Kubernetes standalone::
+
Expand Down
Loading