Skip to content

Commit e506488

Browse files
committed
DOC-1569 Console new config for audit-logs
1 parent 0bf9d82 commit e506488

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For example:
2222

2323
[cols="1m,1m"]
2424
|===
25-
|YAML|Environment Variable
25+
|YAML|Environment variable
2626

2727
|kafka.rackId
2828
|KAFKA_RACKID
@@ -96,6 +96,8 @@ spec:
9696
#brokers: [] # Auto-configured to connect to this Redpanda cluster
9797
server:
9898
listenPort: 8080
99+
auditLog:
100+
enabled: true
99101
# Add any other Redpanda Console configuration here
100102
----
101103
+
@@ -121,6 +123,8 @@ console:
121123
#brokers: [] # Auto-configured to connect to this Redpanda cluster
122124
server:
123125
listenPort: 8080
126+
auditLog:
127+
enabled: true
124128
# Add any other Redpanda Console configuration here
125129
----
126130
+
@@ -187,6 +191,8 @@ console:
187191
# See https://docs.redpanda.com/current/console/config/connect-to-redpanda/
188192
kafka:
189193
brokers: ["redpanda-0:9092","redpanda-1:9092","redpanda-2:9092"]
194+
auditlog:
195+
enabled: true
190196
----
191197

192198
[[config-yaml]]

modules/manage/partials/audit-logging.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ With audit logging enabled, there should be no noticeable changes in performance
1616
ifndef::env-cloud[]
1717
NOTE: Audit logging is configured at the cluster level. Redpanda supports excluding specific topics or principals from auditing to help reduce noise in the log. Audit logging is disabled by default.
1818

19+
To view audit events in Redpanda Console, enable the audit logging with `auditLog.enabled`. See xref:console:config/configure-console.adoc[].
20+
1921
endif::[]
2022

2123
== Audit log flow

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,8 @@ console:
271271
# -----END PRIVATE KEY-----
272272
# privateKeyFilepath: /path/to/private/key
273273
# passphrase: <optional_passphrase>
274+
auditLog:
275+
enabled: true
274276

275277
#----------------------------------------------------------------------------
276278
# Server settings

0 commit comments

Comments
 (0)