Skip to content

Commit e40a4a8

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

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

charts/k8s-reporter/README.md

Lines changed: 8 additions & 6 deletions
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.10.0](https://img.shields.io/badge/Version-1.10.0-informational?style=flat-square)
7+
![Version: 1.11.0](https://img.shields.io/badge/Version-1.11.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.
@@ -82,18 +82,20 @@ helm uninstall kosli-reporter
8282
| fullnameOverride | string | `""` | overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride` |
8383
| image.pullPolicy | string | `"IfNotPresent"` | the kosli reporter image pull policy |
8484
| image.repository | string | `"ghcr.io/kosli-dev/cli"` | the kosli reporter image repository |
85-
| image.tag | string | `"v2.11.17"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
85+
| image.tag | string | `"v2.11.27"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
8686
| kosliApiToken.secretKey | string | `"key"` | the name of the key in the secret data which contains the Kosli API token |
8787
| kosliApiToken.secretName | string | `"kosli-api-token"` | the name of the secret containing the kosli API token |
8888
| nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
89-
| podAnnotations | object | `{}` | any custom annotations to be added to the cronjob |
89+
| podAnnotations | object | `{}` | |
9090
| podLabels | object | `{}` | custom labels to add to pods |
9191
| reporterConfig.dryRun | bool | `false` | whether the dry run mode is enabled or not. In dry run mode, the reporter logs the reports to stdout and does not send them to kosli. |
92+
| reporterConfig.excludeNamespaces | string | `""` | the namespaces to exclude from scanning and reporting. Cannot be combined with namespaces or namespacesRegex. It is a comma separated list of namespace names. Leave this and excludeNamespacesRegex unset if you want to report what is running in the entire cluster |
93+
| reporterConfig.excludeNamespacesRegex | string | `""` | the namespaces Regex patterns to exclude from scanning and reporting. Does not have effect if excludeNamespaces is set. Cannot be combined with namespaces or namespacesRegex. Requires cluster-wide permissions. It is a comma separated list of namespace regex patterns. Leave this and excludeNamespaces unset if you want to report what is running in the entire cluster |
9294
| reporterConfig.httpProxy | string | `""` | the http proxy url |
9395
| reporterConfig.kosliEnvironmentName | string | `""` | the name of Kosli environment that the k8s cluster/namespace correlates to |
9496
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
95-
| 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 |
96-
| 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 |
97+
| reporterConfig.namespaces | string | `""` | the namespaces to scan and report. Cannot be combined with excludeNamespaces or excludeNamespacesRegex. 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 |
98+
| reporterConfig.namespacesRegex | string | `""` | the namespaces Regex patterns to scan and report. Does not have effect if namespaces is set. Requires cluster-wide permissions. Cannot be combined with excludeNamespaces or excludeNamespacesRegex. 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 |
9799
| reporterConfig.securityContext | object | `{"allowPrivilegeEscalation":false,"runAsNonRoot":true,"runAsUser":1000}` | 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 |
98100
| reporterConfig.securityContext.allowPrivilegeEscalation | bool | `false` | whether to allow privilege escalation |
99101
| reporterConfig.securityContext.runAsNonRoot | bool | `true` | whether to run as non root |
@@ -107,5 +109,5 @@ helm uninstall kosli-reporter
107109
| serviceAccount.permissionScope | string | `"cluster"` | specifies whether to create a cluster-wide permissions for the service account or namespace-scoped permissions. allowed values are: [cluster, namespace] |
108110

109111
----------------------------------------------
110-
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
112+
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
111113

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

Lines changed: 7 additions & 4 deletions
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.9.0](https://img.shields.io/badge/Version-1.9.0-informational?style=flat-square)
7+
![Version: 1.11.0](https://img.shields.io/badge/Version-1.11.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.
@@ -82,17 +82,20 @@ helm uninstall kosli-reporter
8282
| fullnameOverride | string | `""` | overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride` |
8383
| image.pullPolicy | string | `"IfNotPresent"` | the kosli reporter image pull policy |
8484
| image.repository | string | `"ghcr.io/kosli-dev/cli"` | the kosli reporter image repository |
85-
| image.tag | string | `"v2.11.15"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
85+
| image.tag | string | `"v2.11.27"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
8686
| kosliApiToken.secretKey | string | `"key"` | the name of the key in the secret data which contains the Kosli API token |
8787
| kosliApiToken.secretName | string | `"kosli-api-token"` | the name of the secret containing the kosli API token |
8888
| nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
8989
| podAnnotations | object | `{}` | |
90+
| podLabels | object | `{}` | custom labels to add to pods |
9091
| reporterConfig.dryRun | bool | `false` | whether the dry run mode is enabled or not. In dry run mode, the reporter logs the reports to stdout and does not send them to kosli. |
92+
| reporterConfig.excludeNamespaces | string | `""` | the namespaces to exclude from scanning and reporting. Cannot be combined with namespaces or namespacesRegex. It is a comma separated list of namespace names. Leave this and excludeNamespacesRegex unset if you want to report what is running in the entire cluster |
93+
| reporterConfig.excludeNamespacesRegex | string | `""` | the namespaces Regex patterns to exclude from scanning and reporting. Does not have effect if excludeNamespaces is set. Cannot be combined with namespaces or namespacesRegex. Requires cluster-wide permissions. It is a comma separated list of namespace regex patterns. Leave this and excludeNamespaces unset if you want to report what is running in the entire cluster |
9194
| reporterConfig.httpProxy | string | `""` | the http proxy url |
9295
| reporterConfig.kosliEnvironmentName | string | `""` | the name of Kosli environment that the k8s cluster/namespace correlates to |
9396
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
94-
| 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 |
95-
| 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 |
97+
| reporterConfig.namespaces | string | `""` | the namespaces to scan and report. Cannot be combined with excludeNamespaces or excludeNamespacesRegex. 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 |
98+
| reporterConfig.namespacesRegex | string | `""` | the namespaces Regex patterns to scan and report. Does not have effect if namespaces is set. Requires cluster-wide permissions. Cannot be combined with excludeNamespaces or excludeNamespacesRegex. 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 |
9699
| reporterConfig.securityContext | object | `{"allowPrivilegeEscalation":false,"runAsNonRoot":true,"runAsUser":1000}` | 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 |
97100
| reporterConfig.securityContext.allowPrivilegeEscalation | bool | `false` | whether to allow privilege escalation |
98101
| reporterConfig.securityContext.runAsNonRoot | bool | `true` | whether to run as non root |

0 commit comments

Comments
 (0)