Skip to content

Commit 1a76dfe

Browse files
Update HA and PVC incompatibility to make it more obvious (#503)
* Update HA and PVC incompatibility to make it more obvious * small edits for linter --------- Co-authored-by: Joan E <[email protected]>
1 parent d3dee57 commit 1a76dfe

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

platform/configure/advanced/audit.mdx

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Enabling Audit Logging
2+
title: Enable Audit Logging
33
sidebar_label: Enable Audit Logging
44
sidebar_position: 2
55
description: Learn how to enable and configure audit logging to track activities in the platform, including management instance changes and cluster operations.
@@ -65,7 +65,7 @@ The platform provides audit levels, which are preconfigured audit policies for t
6565
For all of these levels certain internal read-only APIs are not logged since those might pollute the log and drastically increase log size. To log these, create a custom audit policy as described below.
6666
:::
6767

68-
Configure the audit level through the platform config, which can be modified either through the platform UI or helm:
68+
Configure the audit level through the platform config, which can be modified either through the platform UI or Helm:
6969

7070
<Tabs
7171
defaultValue="ui"
@@ -113,7 +113,11 @@ Below you can find a complete policy reference:
113113

114114
## Persisting audit logs
115115

116-
There are two ways to persist platform audit logs: deploying the platform with a persistent volume claim (PVC) or connecting the platform to a persistent database. The PVC approach does not work for HA mode for the platform.
116+
There are two ways to persist platform audit logs: deploying the platform with a persistent volume claim (PVC) or connecting the platform to a persistent database.
117+
118+
:::info HA only supported with persistent database
119+
If you are running the platform in high availability (HA mode), the only way to persist audit logs is to use a persistent database. The PVC approach does not work.
120+
:::
117121

118122
### Deploy the platform with a PVC to save audit logs
119123

@@ -126,7 +130,7 @@ audit:
126130
# size: 30Gi
127131
```
128132

129-
Apply the values via helm:
133+
Apply the values using Helm:
130134

131135
```bash title="Apply helm values"
132136
helm upgrade vcluster-platform vcluster-platform -n vcluster-platform --version 4.0.0-alpha.12 \
@@ -166,7 +170,7 @@ audit:
166170

167171
To easily export the audit events to third party systems, enable the audit log
168172
sidecar that prints all the audit events onto stdout in a separate container which can then be easily watched and exported.
169-
Enabling the sidecar is only possible through helm values.
173+
Enabling the sidecar is only possible through Helm values.
170174

171175
Create a `values.yaml` with the following contents:
172176

0 commit comments

Comments
 (0)