From 7a828a8499c9323323d8a6839a17463afe545186 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Mar 2026 00:00:32 +0000 Subject: [PATCH] docs: update CLI and helm reference for v2.12.0 --- docs.json | 4 +++- helm/k8s_reporter.md | 22 ++++++++++++---------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/docs.json b/docs.json index 027e3e0..5750bec 100644 --- a/docs.json +++ b/docs.json @@ -382,7 +382,9 @@ "groups": [ { "group": "Helm Charts", - "pages": ["helm/k8s_reporter"] + "pages": [ + "helm/k8s_reporter" + ] } ] }, diff --git a/helm/k8s_reporter.md b/helm/k8s_reporter.md index bfc7a8e..0bb1754 100644 --- a/helm/k8s_reporter.md +++ b/helm/k8s_reporter.md @@ -1,8 +1,9 @@ --- title: Kubernetes Reporter Helm Chart -description: A Helm chart for installing the Kosli K8S reporter as a cronjob to report running images to Kosli at a given cron schedule. --- +# k8s-reporter + ![Version: 1.11.3](https://img.shields.io/badge/Version-1.11.3-informational?style=flat-square) A Helm chart for installing the Kosli K8S reporter as a cronjob. @@ -20,12 +21,12 @@ The chart allows you to create a Kubernetes cronjob and all its necessary RBAC t To install this chart via the Helm chart repository: 1. Add the Kosli helm repo -```shell +```shell {.command} helm repo add kosli https://charts.kosli.com/ && helm repo update ``` 2. Create a secret for the Kosli API token -```shell +```shell {.command} kubectl create secret generic kosli-api-token --from-literal=key= ``` @@ -33,7 +34,7 @@ kubectl create secret generic kosli-api-token --from-literal=key= A. To report artifacts running in entire cluster (requires cluster-wide read permissions): -```shell +```shell {.command} helm install kosli-reporter kosli/k8s-reporter \ --set reporterConfig.kosliOrg= \ --set reporterConfig.kosliEnvironmentName= @@ -41,7 +42,7 @@ helm install kosli-reporter kosli/k8s-reporter \ B. To report artifacts running in multiple namespaces (requires cluster-wide read permissions): -```shell +```shell {.command} helm install kosli-reporter kosli/k8s-reporter \ --set reporterConfig.kosliOrg= \ --set reporterConfig.kosliEnvironmentName= \ @@ -50,7 +51,7 @@ helm install kosli-reporter kosli/k8s-reporter \ C. To report artifacts running in one namespace (requires namespace-scoped read permissions): -```shell +```shell {.command} helm install kosli-reporter kosli/k8s-reporter \ --set reporterConfig.kosliOrg= \ --set reporterConfig.kosliEnvironmentName= \ @@ -64,13 +65,13 @@ helm install kosli-reporter kosli/k8s-reporter \ ## Upgrading the chart -```shell +```shell {.command} helm upgrade kosli-reporter kosli/k8s-reporter ... ``` ## Uninstalling chart -```shell +```shell {.command} helm uninstall kosli-reporter ``` @@ -85,7 +86,7 @@ helm uninstall kosli-reporter | 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 | `{}` | | +| podAnnotations | object | `{}` | any custom annotations to be added to the cronjob | | podLabels | object | `{}` | custom labels to add to pods | | 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.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 | @@ -108,4 +109,5 @@ helm uninstall kosli-reporter | 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] | ---------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) +Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) +