Skip to content

Commit 2c6d7bc

Browse files
authored
Merge pull request #64307 from bergerhoffer/OCPBUGS-11516
OCPBUGS#11516: Noted that custom rules are ignored if the audit log p…
2 parents 979da07 + b99e22e commit 2c6d7bc

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

modules/nodes-nodes-audit-config-about.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Audit log profiles define how to log requests that come to the OpenShift API ser
2525
|In addition to logging metadata for all requests, logs request bodies for every read and write request to the API servers (`get`, `list`, `create`, `update`, `patch`). This profile has the most resource overhead. ^[1]^
2626

2727
|`None`
28-
|No requests are logged; even OAuth access token requests and OAuth authorize token requests are not logged.
28+
|No requests are logged; even OAuth access token requests and OAuth authorize token requests are not logged. Custom rules are ignored when this profile is set.
2929

3030
[WARNING]
3131
====

modules/nodes-nodes-audit-policy-custom.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ You can configure an audit log policy that defines custom rules. You can specify
1010

1111
These custom rules take precedence over the top-level profile field. The custom rules are evaluated from top to bottom, and the first that matches is applied.
1212

13+
[IMPORTANT]
14+
====
15+
Custom rules are ignored if the top-level profile field is set to `None`.
16+
====
17+
1318
.Prerequisites
1419

1520
* You have access to the cluster as a user with the `cluster-admin` role.
@@ -41,11 +46,11 @@ spec:
4146
profile: Default <2>
4247
----
4348
<1> Add one or more groups and specify the profile to use for that group. These custom rules take precedence over the top-level profile field. The custom rules are evaluated from top to bottom, and the first that matches is applied.
44-
<2> Set to `Default`, `WriteRequestBodies`, `AllRequestBodies`, or `None`. If you do not set this top-level `audit.profile` field, it defaults to the `Default` profile.
49+
<2> Set to `Default`, `WriteRequestBodies`, or `AllRequestBodies`. If you do not set this top-level profile field, it defaults to the `Default` profile.
4550
+
4651
[WARNING]
4752
====
48-
It is not recommended to disable audit logging by using the `None` profile unless you are fully aware of the risks of not logging data that can be beneficial when troubleshooting issues. If you disable audit logging and a support situation arises, you might need to enable audit logging and reproduce the issue in order to troubleshoot properly.
53+
Do not set the top-level profile field to `None` if you want to use custom rules. Custom rules are ignored if the top-level profile field is set to `None`.
4954
====
5055

5156
. Save the file to apply the changes.

0 commit comments

Comments
 (0)