public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 12:38:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add new audit log docs (#1847)

Browse Source 
* docs: add new audit log docs

Signed-off-by: Alexandre Lamarre <alexandre.lamarre@suse.com>

* docs: minor tweaks to audit logs

redaction engine clarification

typo fixes

correction about path redaction example

Signed-off-by: Alexandre Lamarre <alexandre.lamarre@suse.com>

* Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/troubleshooting/other-troubleshooting-tips/user-id-tracking-in-audit-logs.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/getting-started/installation-and-upgrade/installation-references/helm-chart-options.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/getting-started/installation-and-upgrade/installation-references/helm-chart-options.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

Update docs/how-to-guides/advanced-user-guides/enable-api-audit-log.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* clarify json path engine limitations, and link to upstream resource

Signed-off-by: Alexandre Lamarre <alexandre.lamarre@suse.com>

* apply changes in docs to versioned_docs/version-2.12

Signed-off-by: Alexandre Lamarre <alexandre.lamarre@suse.com>

---------

Signed-off-by: Alexandre Lamarre <alexandre.lamarre@suse.com>
Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
This commit is contained in:
Alexandre Lamarre
2025-07-30 08:23:06 -07:00
committed by GitHub
co-authored by Lucas Saintarbor
parent 23c2f68170
commit 45f812baa1
10 changed files with 1218 additions and 958 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/installation-and-upgrade/installation-references/helm-chart-options.md
+6 -1
View File
@@ -36,7 +36,8 @@ For information on enabling experimental features, refer to [this page.](../../.
| `antiAffinity` | "preferred" | `string` - AntiAffinity rule for Rancher pods - "preferred, required" |
| `auditLog.destination` | "sidecar" | `string` - Stream to sidecar container console or hostPath volume - "sidecar, hostPath" |
| `auditLog.hostPath` | "/var/log/rancher/audit" | `string` - log file destination on host (only applies when `auditLog.destination` is set to `hostPath`) |
| `auditLog.level` | 0 | `int` - set the [API Audit Log](../../../how-to-guides/advanced-user-guides/enable-api-audit-log.md) level. 0 is off. [0-3] |
| `auditLog.enabled` | false | `bool` - Enables / disables audit logging. |
| `auditLog.level` | 0 | `int` - Sets the [API Audit Log](../../../how-to-guides/advanced-user-guides/enable-api-audit-log.md) level [0-3]. |
| `auditLog.maxAge` | 1 | `int` - maximum number of days to retain old audit log files (only applies when `auditLog.destination` is set to `hostPath`) |
| `auditLog.maxBackup` | 1 | `int` - maximum number of audit log files to retain (only applies when `auditLog.destination` is set to `hostPath`) |
| `auditLog.maxSize` | 100 | `int` - maximum size in megabytes of the audit log file before it gets rotated (only applies when `auditLog.destination` is set to `hostPath`) |
@@ -63,6 +64,10 @@ For information on enabling experimental features, refer to [this page.](../../.
| `tls` | "ingress" | `string` - See [External TLS Termination](#external-tls-termination) for details. - "ingress, external" |
| `useBundledSystemChart` | `false` | `bool` - select to use the system-charts packaged with Rancher server. This option is used for air gapped installations. |
When using Rancher v2.12.0 and above, Rancher will use an audit logging controller that watches `AuditPolicy` CRs for configuring additional redactions, for more info see [API Audit Log](../../../how-to-guides/advanced-user-guides/enable-api-audit-log.md).
### Bootstrap Password
You can [set a specific bootstrap password](../resources/bootstrap-password.md) during Rancher installation. If you don't set a specific bootstrap password, Rancher randomly generates a password for the first admin account.