Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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