diff --git a/charts/k8s-reporter/README.md b/charts/k8s-reporter/README.md index a67e3c0a6..579937da7 100644 --- a/charts/k8s-reporter/README.md +++ b/charts/k8s-reporter/README.md @@ -61,7 +61,7 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter | 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 | | 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 | | 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 | @@ -74,5 +74,5 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter | serviceAccount.name | string | `""` | the name of the service account to use. If not set and create is true, a name is generated using the fullname template | ---------------------------------------------- -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.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) diff --git a/docs.kosli.com/content/helm/_index.md b/docs.kosli.com/content/helm/_index.md index a67e3c0a6..579937da7 100644 --- a/docs.kosli.com/content/helm/_index.md +++ b/docs.kosli.com/content/helm/_index.md @@ -61,7 +61,7 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter | 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 | | 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 | | 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 | @@ -74,5 +74,5 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter | serviceAccount.name | string | `""` | the name of the service account to use. If not set and create is true, a name is generated using the fullname template | ---------------------------------------------- -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.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) diff --git a/docs.kosli.com/content/kosli_overview/kosli_tools.md b/docs.kosli.com/content/kosli_overview/kosli_tools.md index 4417804ba..3175edd76 100644 --- a/docs.kosli.com/content/kosli_overview/kosli_tools.md +++ b/docs.kosli.com/content/kosli_overview/kosli_tools.md @@ -74,9 +74,16 @@ sudo mv kosli /usr/local/bin/kosli {{< /tab >}} {{< tab "Docker" >}} -You can run the Kosli CLI in this docker container: +You can run the Kosli CLI with docker: ```shell {.command} -docker run -it --rm ghcr.io/kosli-dev/cli:v{{< cli-version >}} bash +docker run --rm ghcr.io/kosli-dev/cli:v{{< cli-version >}} +``` +The `entrypoint` for this container is the kosli command. + +To run any kosli command you append it to the `docker run` command above – +without the `kosli` keyword. For example to run `kosli version`: +```shell {.command} +docker run --rm ghcr.io/kosli-dev/cli:v{{< cli-version >}} version ``` {{< /tab >}} @@ -208,4 +215,4 @@ In the top right corner of the page you will see your GitHub avatar where you ca access your profile settings (containing your Kosli API key). You'll also find there a link to the page where you can create a shared organization and links to [cyber-dojo demo project](https://app.kosli.com/cyber-dojo/environments/) and to -log out. \ No newline at end of file +log out.