Skip to content

Commit c4f7d8f

Browse files
micheleRPcoderabbitai[bot]weeco
authored
DOC-1569 Console new config for audit-logs (#1346)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Martin Schneppenheim <23424570+weeco@users.noreply.github.com>
1 parent e94a5ab commit c4f7d8f

2 files changed

Lines changed: 28 additions & 4 deletions

File tree

modules/console/pages/config/configure-console.adoc

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
= Configure Redpanda Console
32
:description: Learn how to configure Redpanda Console using environment variables, YAML files, or command-line arguments.
43
:page-aliases: console:reference/config.adoc, reference:console/config.adoc
@@ -22,7 +21,7 @@ For example:
2221

2322
[cols="1m,1m"]
2423
|===
25-
|YAML|Environment Variable
24+
|YAML|Environment variable
2625

2726
|kafka.rackId
2827
|KAFKA_RACKID
@@ -96,6 +95,11 @@ spec:
9695
#brokers: [] # Auto-configured to connect to this Redpanda cluster
9796
server:
9897
listenPort: 8080
98+
auditLog:
99+
enabled: false # default; set to true to write audit logs to stdout
100+
additionalHeaders: # specifies HTTP headers to include in audit logs
101+
- "X-Forwarded-For"
102+
- "User-Agent"
99103
# Add any other Redpanda Console configuration here
100104
----
101105
+
@@ -121,6 +125,9 @@ console:
121125
#brokers: [] # Auto-configured to connect to this Redpanda cluster
122126
server:
123127
listenPort: 8080
128+
auditLog:
129+
enabled: false # default; set to true to write audit logs to stdout
130+
additionalHeaders: # specifies HTTP headers to include in audit logs
124131
# Add any other Redpanda Console configuration here
125132
----
126133
+
@@ -152,6 +159,11 @@ config:
152159
- redpanda-1.redpanda.svc.cluster.local:9092
153160
server:
154161
listenPort: 8080
162+
auditLog:
163+
enabled: false # default; set to true to write audit logs to stdout
164+
additionalHeaders: # specifies HTTP headers to include in audit logs
165+
- "X-Forwarded-For"
166+
- "User-Agent"
155167
# Add any other Redpanda Console configuration here
156168
----
157169
@@ -177,7 +189,7 @@ console:
177189
container_name: redpanda-console
178190
image: docker.redpanda.com/redpandadata/console:{latest-console-tag}
179191
entrypoint: /bin/sh
180-
command: -c 'echo "$$CONSOLE_CONFIG_FILE" > /tmp/config.yml
192+
command: -c 'echo "$$CONSOLE_CONFIG_FILE" > /tmp/config.yml'
181193
volumes:
182194
- ./config:/tmp/config/
183195
environment:
@@ -187,6 +199,11 @@ console:
187199
# See https://docs.redpanda.com/current/console/config/connect-to-redpanda/
188200
kafka:
189201
brokers: ["redpanda-0:9092","redpanda-1:9092","redpanda-2:9092"]
202+
auditLog:
203+
enabled: false # default; set to true to write audit logs to stdout
204+
additionalHeaders: # specifies HTTP headers to include in audit logs
205+
- "X-Forwarded-For"
206+
- "User-Agent"
190207
----
191208

192209
[[config-yaml]]
@@ -203,7 +220,9 @@ The following YAML file contains a complete list of all Redpanda Console configu
203220
xref:shared:attachment$redpanda-console-config.yaml[Download the sample file].
204221

205222
.redpanda-console-config.yaml
223+
206224
[,yaml]
207225
----
208226
include::shared:attachment$redpanda-console-config.yaml[]
209-
----
227+
228+
----

modules/shared/attachments/redpanda-console-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,11 @@ console:
271271
# -----END PRIVATE KEY-----
272272
# privateKeyFilepath: /path/to/private/key
273273
# passphrase: <optional_passphrase>
274+
auditLog:
275+
enabled: false # default; set to true to write audit logs to stdout
276+
additionalHeaders: # specifies HTTP headers to include in audit logs
277+
- "X-Forwarded-For"
278+
- "User-Agent"
274279

275280
#----------------------------------------------------------------------------
276281
# Server settings

0 commit comments

Comments
 (0)