Update helm docs (#142)

Co-authored-by: sami-alajrami <[email protected]>
kosli-dev · Mar 6, 2024 · c2f4892 · c2f4892
1 parent d87d3f6
commit c2f4892
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/charts/k8s-reporter/README.md b/charts/k8s-reporter/README.md
@@ -4,7 +4,7 @@ title: Kubernetes Reporter Helm Chart
 
 # k8s-reporter
 
-![Version: 1.4.2](https://img.shields.io/badge/Version-1.4.2-informational?style=flat-square)
+![Version: 1.4.3](https://img.shields.io/badge/Version-1.4.3-informational?style=flat-square)
 
 A Helm chart for installing the Kosli K8S reporter as a cronjob.
 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.
@@ -54,18 +54,18 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter
 ## Configurations
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| cronSchedule | string | `"*/5 * * * *"` | the cron schedule at which the reporter is triggered to report to kosli   |
+| cronSchedule | string | `"*/5 * * * *"` | the cron schedule at which the reporter is triggered to report to Kosli   |
 | fullnameOverride | string | `""` | overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride` |
 | image.pullPolicy | string | `"IfNotPresent"` | the kosli reporter image pull policy |
 | image.repository | string | `"ghcr.io/kosli-dev/cli"` | the kosli reporter image repository |
 | image.tag | string | `"v2.8.6"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
-| kosliApiToken.secretKey | string | `""` | the name of the key in the secret data which contains the kosli API token |
-| kosliApiToken.secretName | string | `""` | the name of the secret containing the kosli API token |
+| kosliApiToken.secretKey | string | `"key"` | the name of the key in the secret data which contains the Kosli API token |
+| kosliApiToken.secretName | string | `"kosli-api-token"` | the name of the secret containing the kosli API token |
 | nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
 | podAnnotations | object | `{}` |  |
 | 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. |
-| reporterConfig.kosliEnvironmentName | string | `""` | the name of kosli environment that the k8s cluster/namespace correlates to |
-| reporterConfig.kosliOrg | string | `""` | the name of the kosli org |
+| reporterConfig.kosliEnvironmentName | string | `""` | the name of Kosli environment that the k8s cluster/namespace correlates to |
+| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
 | reporterConfig.namespaces | string | `""` | the namespaces which represent the environment. It is a comma separated list of namespace name regex patterns. e.g. `^prod$,^dev-*` reports for the `prod` namespace and any namespace that starts with `dev-` leave this unset if you want to report what is running in the entire cluster |
 | resources.limits.cpu | string | `"100m"` | the cpu limit |
 | resources.limits.memory | string | `"256Mi"` | the memory limit |

diff --git a/docs.kosli.com/content/helm/_index.md b/docs.kosli.com/content/helm/_index.md
@@ -4,7 +4,7 @@ title: Kubernetes Reporter Helm Chart
 
 # k8s-reporter
 
-![Version: 1.4.2](https://img.shields.io/badge/Version-1.4.2-informational?style=flat-square)
+![Version: 1.4.3](https://img.shields.io/badge/Version-1.4.3-informational?style=flat-square)
 
 A Helm chart for installing the Kosli K8S reporter as a cronjob.
 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.
@@ -54,18 +54,18 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter
 ## Configurations
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| cronSchedule | string | `"*/5 * * * *"` | the cron schedule at which the reporter is triggered to report to kosli   |
+| cronSchedule | string | `"*/5 * * * *"` | the cron schedule at which the reporter is triggered to report to Kosli   |
 | fullnameOverride | string | `""` | overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride` |
 | image.pullPolicy | string | `"IfNotPresent"` | the kosli reporter image pull policy |
 | image.repository | string | `"ghcr.io/kosli-dev/cli"` | the kosli reporter image repository |
 | image.tag | string | `"v2.8.6"` | the kosli reporter image tag, overrides the image tag whose default is the chart appVersion. |
-| kosliApiToken.secretKey | string | `""` | the name of the key in the secret data which contains the kosli API token |
-| kosliApiToken.secretName | string | `""` | the name of the secret containing the kosli API token |
+| kosliApiToken.secretKey | string | `"key"` | the name of the key in the secret data which contains the Kosli API token |
+| kosliApiToken.secretName | string | `"kosli-api-token"` | the name of the secret containing the kosli API token |
 | nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
 | podAnnotations | object | `{}` |  |
 | 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. |
-| reporterConfig.kosliEnvironmentName | string | `""` | the name of kosli environment that the k8s cluster/namespace correlates to |
-| reporterConfig.kosliOrg | string | `""` | the name of the kosli org |
+| reporterConfig.kosliEnvironmentName | string | `""` | the name of Kosli environment that the k8s cluster/namespace correlates to |
+| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
 | reporterConfig.namespaces | string | `""` | the namespaces which represent the environment. It is a comma separated list of namespace name regex patterns. e.g. `^prod$,^dev-*` reports for the `prod` namespace and any namespace that starts with `dev-` leave this unset if you want to report what is running in the entire cluster |
 | resources.limits.cpu | string | `"100m"` | the cpu limit |
 | resources.limits.memory | string | `"256Mi"` | the memory limit |