Skip to content

Commit 1a99e7c

Browse files
Update helm docs (#498)
Co-authored-by: sami-alajrami <[email protected]>
1 parent cc3104e commit 1a99e7c

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

charts/k8s-reporter/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Kubernetes Reporter Helm Chart
44

55
# k8s-reporter
66

7-
![Version: 1.8.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square)
7+
![Version: 1.8.0](https://img.shields.io/badge/Version-1.8.0-informational?style=flat-square)
88

99
A Helm chart for installing the Kosli K8S reporter as a cronjob.
1010
The chart allows you to create a Kubernetes cronjob and all its necessary RBAC to report running images to Kosli at a given cron schedule.
@@ -93,6 +93,10 @@ helm uninstall kosli-reporter
9393
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
9494
| reporterConfig.namespaces | string | `""` | the namespaces to scan and report. It is a comma separated list of namespace names. leave this and namespacesRegex unset if you want to report what is running in the entire cluster |
9595
| reporterConfig.namespacesRegex | string | `""` | the namespaces Regex patterns to scan and report. Does not have effect if namespaces is set. Requires cluster-wide permissions. It is a comma separated list of namespace regex patterns. leave this and namespaces unset if you want to report what is running in the entire cluster |
96+
| reporterConfig.securityContext | object | `{"allowPrivilegeEscalation":false,"runAsNonRoot":true,"runAsUser":1000}` | the security context for the reporter cronjob |
97+
| reporterConfig.securityContext.allowPrivilegeEscalation | bool | `false` | whether to allow privilege escalation |
98+
| reporterConfig.securityContext.runAsNonRoot | bool | `true` | whether to run as non root |
99+
| reporterConfig.securityContext.runAsUser | int | `1000` | the user id to run as |
96100
| resources.limits.cpu | string | `"100m"` | the cpu limit |
97101
| resources.limits.memory | string | `"256Mi"` | the memory limit |
98102
| resources.requests.memory | string | `"64Mi"` | the memory request |

docs.kosli.com/content/helm/_index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Kubernetes Reporter Helm Chart
44

55
# k8s-reporter
66

7-
![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square)
7+
![Version: 1.8.0](https://img.shields.io/badge/Version-1.8.0-informational?style=flat-square)
88

99
A Helm chart for installing the Kosli K8S reporter as a cronjob.
1010
The chart allows you to create a Kubernetes cronjob and all its necessary RBAC to report running images to Kosli at a given cron schedule.
@@ -93,6 +93,10 @@ helm uninstall kosli-reporter
9393
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
9494
| reporterConfig.namespaces | string | `""` | the namespaces to scan and report. It is a comma separated list of namespace names. leave this and namespacesRegex unset if you want to report what is running in the entire cluster |
9595
| reporterConfig.namespacesRegex | string | `""` | the namespaces Regex patterns to scan and report. Does not have effect if namespaces is set. Requires cluster-wide permissions. It is a comma separated list of namespace regex patterns. leave this and namespaces unset if you want to report what is running in the entire cluster |
96+
| reporterConfig.securityContext | object | `{"allowPrivilegeEscalation":false,"runAsNonRoot":true,"runAsUser":1000}` | the security context for the reporter cronjob |
97+
| reporterConfig.securityContext.allowPrivilegeEscalation | bool | `false` | whether to allow privilege escalation |
98+
| reporterConfig.securityContext.runAsNonRoot | bool | `true` | whether to run as non root |
99+
| reporterConfig.securityContext.runAsUser | int | `1000` | the user id to run as |
96100
| resources.limits.cpu | string | `"100m"` | the cpu limit |
97101
| resources.limits.memory | string | `"256Mi"` | the memory limit |
98102
| resources.requests.memory | string | `"64Mi"` | the memory request |

0 commit comments

Comments
 (0)