chore: rename doc ref of container.securityContext

Signed-off-by: hainenber <[email protected]>
grafana · Nov 18, 2023 · ada4d89 · ada4d89
1 parent 950870a
commit ada4d89
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/operations/helm/charts/grafana-agent/CHANGELOG.md b/operations/helm/charts/grafana-agent/CHANGELOG.md
@@ -15,6 +15,8 @@ Unreleased
 - Ensure that `app.kubernetes.io/version` label accounts for any 
   image tag overrides supplied to the chart Values. (@tristanburgess)
 
+- Update `container.securityContext` Helm value reference to renamed `agent.securityContext`. (@hainenber)
+
 0.27.2 (2023-11-07)
 ----------
 

diff --git a/operations/helm/charts/grafana-agent/README.md b/operations/helm/charts/grafana-agent/README.md
@@ -168,9 +168,9 @@ used. When provided, `agent.configMap.content` must hold a valid River configura
 
 [default-config]: ./config/example.river
 
-### controller.securityContext
+### agent.securityContext
 
-`controller.securityContext` sets the securityContext passed to the Grafana
+`agent.securityContext` sets the securityContext passed to the Grafana
 Agent container.
 
 By default, Grafana Agent containers are not able to collect telemetry from the
@@ -241,7 +241,7 @@ This capability is disabled by default.
 To expose logs from other containers to Grafana Agent:
 
 * Set `agent.mounts.dockercontainers` to `true`.
-* Set `controller.securityContext` to:
+* Set `agent.securityContext` to:
   ```yaml
   privileged: true
   runAsUser: 0
@@ -256,7 +256,7 @@ To expose this information to Grafana Agent for telemetry collection:
 
 * Set `agent.mounts.dockercontainers` to `true`.
 * Mount `/proc` and `/sys` from the host into the container.
-* Set `controller.securityContext` to:
+* Set `agent.securityContext` to:
   ```yaml
   privileged: true
   runAsUser: 0

diff --git a/operations/helm/charts/grafana-agent/README.md.gotmpl b/operations/helm/charts/grafana-agent/README.md.gotmpl
@@ -80,9 +80,9 @@ used. When provided, `agent.configMap.content` must hold a valid River configura
 
 [default-config]: ./config/example.river
 
-### controller.securityContext
+### agent.securityContext
 
-`controller.securityContext` sets the securityContext passed to the Grafana
+`agent.securityContext` sets the securityContext passed to the Grafana
 Agent container.
 
 By default, Grafana Agent containers are not able to collect telemetry from the
@@ -153,7 +153,7 @@ This capability is disabled by default.
 To expose logs from other containers to Grafana Agent:
 
 * Set `agent.mounts.dockercontainers` to `true`.
-* Set `controller.securityContext` to:
+* Set `agent.securityContext` to:
   ```yaml
   privileged: true
   runAsUser: 0
@@ -168,7 +168,7 @@ To expose this information to Grafana Agent for telemetry collection:
 
 * Set `agent.mounts.dockercontainers` to `true`.
 * Mount `/proc` and `/sys` from the host into the container.
-* Set `controller.securityContext` to:
+* Set `agent.securityContext` to:
   ```yaml
   privileged: true
   runAsUser: 0