Skip to content

Commit 43f3d5e

Browse files
Update helm docs (#495)
Co-authored-by: sami-alajrami <sami-alajrami@users.noreply.github.com>
1 parent b7ce06a commit 43f3d5e

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

charts/k8s-reporter/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ 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.3"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
85+
| image.tag | string | `"v2.11.15"` | 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 |
@@ -91,7 +91,8 @@ helm uninstall kosli-reporter
9191
| reporterConfig.httpProxy | string | `""` | the http proxy url |
9292
| reporterConfig.kosliEnvironmentName | string | `""` | the name of Kosli environment that the k8s cluster/namespace correlates to |
9393
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
94-
| reporterConfig.namespaces | string | `""` | the namespaces which represent the environment. It is a comma separated list of namespace names. leave this unset if you want to report what is running in the entire cluster |
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 |
9596
| resources.limits.cpu | string | `"100m"` | the cpu limit |
9697
| resources.limits.memory | string | `"256Mi"` | the memory limit |
9798
| resources.requests.memory | string | `"64Mi"` | the memory request |

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
22
title: Kubernetes Reporter Helm Chart
3-
summary: "A Helm chart for installing the Kosli K8S reporter as a cronjob.
4-
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."
53
---
64

75
# k8s-reporter
86

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

119
A Helm chart for installing the Kosli K8S reporter as a cronjob.
1210
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.
@@ -84,7 +82,7 @@ helm uninstall kosli-reporter
8482
| fullnameOverride | string | `""` | overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride` |
8583
| image.pullPolicy | string | `"IfNotPresent"` | the kosli reporter image pull policy |
8684
| image.repository | string | `"ghcr.io/kosli-dev/cli"` | the kosli reporter image repository |
87-
| image.tag | string | `"v2.11.3"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
85+
| image.tag | string | `"v2.11.15"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
8886
| kosliApiToken.secretKey | string | `"key"` | the name of the key in the secret data which contains the Kosli API token |
8987
| kosliApiToken.secretName | string | `"kosli-api-token"` | the name of the secret containing the kosli API token |
9088
| nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
@@ -93,7 +91,8 @@ helm uninstall kosli-reporter
9391
| reporterConfig.httpProxy | string | `""` | the http proxy url |
9492
| reporterConfig.kosliEnvironmentName | string | `""` | the name of Kosli environment that the k8s cluster/namespace correlates to |
9593
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
96-
| reporterConfig.namespaces | string | `""` | the namespaces which represent the environment. It is a comma separated list of namespace names. leave this unset if you want to report what is running in the entire cluster |
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 |
9796
| resources.limits.cpu | string | `"100m"` | the cpu limit |
9897
| resources.limits.memory | string | `"256Mi"` | the memory limit |
9998
| resources.requests.memory | string | `"64Mi"` | the memory request |

0 commit comments

Comments
 (0)