Skip to content

Commit be4adff

Browse files
authored
docs: update Helm chart reference to v2.2.1 (#199)
## Summary - Update the `.mdx` Helm chart reference to v2.2.1: version badge, info callout, and `image.tag` default (empty string, not hardcoded CLI version) - Fix misleading OpenShift `securityContext` guidance — users must explicitly set `runAsUser: null`, not omit it (Helm deep-merges the default `1000` back in) The auto-generated `.md` file remains unchanged. Upstream fix to make it Mintlify-compatible (remove `{.command}` fences, escape `<instance_name>`) is tracked in kosli-dev/cli#853. ## Test plan - [ ] Verify `helm/k8s_reporter` renders correctly at http://localhost:3000/helm/k8s_reporter - [ ] Check version badge shows 2.2.1
1 parent 91d09d8 commit be4adff

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

helm/k8s_reporter.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ description: A Helm chart for installing the Kosli K8S reporter as a cronjob.
55

66
# k8s-reporter
77

8-
![Version: 2.2.0](https://img.shields.io/badge/Version-2.2.0-informational?style=flat-square)
9-
108
<Info>
11-
This reference applies to **chart version 2.2.0**, which uses **CLI version v2.12.0** by default (`image.tag`).
9+
This reference applies to **chart version 2.2.1**, which defaults to CLI **v2.12.0** via `appVersion`. Override with `image.tag`.
1210
</Info>
1311

1412
A Helm chart for installing the Kosli K8S reporter as a cronjob.
@@ -205,8 +203,8 @@ If you already run [cert-manager's trust-manager](https://cert-manager.io/docs/t
205203
The kosli reporter image repository.
206204
</ParamField>
207205

208-
<ParamField path="image.tag" type="string" default="v2.12.0">
209-
The kosli reporter image tag, overrides the image tag whose default is the chart appVersion.
206+
<ParamField path="image.tag" type="string" default="">
207+
The kosli reporter image tag. Defaults to the chart `appVersion` when left empty.
210208
</ParamField>
211209

212210
<ParamField path="image.pullPolicy" type="string" default="IfNotPresent">
@@ -232,7 +230,7 @@ If you already run [cert-manager's trust-manager](https://cert-manager.io/docs/t
232230
</ParamField>
233231

234232
<ParamField path="reporterConfig.securityContext" type="object">
235-
The security context for the reporter cronjob. Set to null or `{}` to disable security context entirely (not recommended). For OpenShift, you can omit `runAsUser` to let OpenShift assign the UID.
233+
The security context for the reporter cronjob. Set to null or `{}` to disable security context entirely (not recommended). For OpenShift with SCC, explicitly set `runAsUser: null` to let OpenShift assign the UID from the allowed range. Simply omitting `runAsUser` from your values override will not work because Helm deep-merges with the chart defaults.
236234

237235
Default:
238236
```json
@@ -253,7 +251,7 @@ If you already run [cert-manager's trust-manager](https://cert-manager.io/docs/t
253251
</ParamField>
254252

255253
<ParamField path="reporterConfig.securityContext.runAsUser" type="int" default="1000">
256-
The user id to run as. Omit this field for OpenShift environments to allow automatic UID assignment.
254+
The user id to run as. For OpenShift environments with SCC, set to `null` (`runAsUser: null`) to allow automatic UID assignment. Simply omitting this field will not work due to Helm's deep merge with chart defaults.
257255
</ParamField>
258256

259257
### Kosli API token

0 commit comments

Comments
 (0)