Skip to content

docs: update CLI and helm reference for v2.12.0 #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update CLI and helm reference for v2.12.0 #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,9 @@
"groups": [
{
"group": "Helm Charts",
"pages": ["helm/k8s_reporter"]
"pages": [
"helm/k8s_reporter"
]
}
]
},
Expand Down
22 changes: 12 additions & 10 deletions helm/k8s_reporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -20,28 +21,28 @@ 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=<your-api-key>
```

3. Install the helm chart

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=<your-org> \
--set reporterConfig.kosliEnvironmentName=<your-env-name>
```

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=<your-org> \
--set reporterConfig.kosliEnvironmentName=<your-env-name> \
Expand All @@ -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=<your-org> \
--set reporterConfig.kosliEnvironmentName=<your-env-name> \
Expand All @@ -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
```

Expand All @@ -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 |
Expand All @@ -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)