Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 2 deletions charts/k8s-reporter/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 2.6.0
version: 2.7.0

# This is the version number of the (CLI) application being deployed. This version number should be
# incremented each time you make changes to the application. They should reflect the version the
# application is using. It is recommended to use it with quotes.
appVersion: "v2.34.0"
appVersion: "v2.36.1"
10 changes: 8 additions & 2 deletions charts/k8s-reporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Kubernetes Reporter Helm Chart

# k8s-reporter

![Version: 2.6.0](https://img.shields.io/badge/Version-2.6.0-informational?style=flat-square)
![Version: 2.7.0](https://img.shields.io/badge/Version-2.7.0-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.
Expand Down Expand Up @@ -90,6 +90,12 @@ If upgrading from v1.x to v2.0.0, migrate your values to the **environments** li
helm upgrade kosli-reporter kosli/k8s-reporter -f values.yaml
```

### Deprecated and ignored in v2.7.0: `reporterConfig.includeScaling`

`reporterConfig.includeScaling` no longer has any effect. Scaling events do not trigger new snapshots, and an environment can no longer have scaling capture turned on, so the `--include-scaling` / `--exclude-scaling` flags this value passed to the CLI had already stopped doing anything — they only produced a deprecation warning in the reporter's logs on every run.

Version 2.7.0 stops passing them, which removes that warning. Nothing else changes: the reporter created environments with scaling off before this version and still does. The value is still accepted, but it does nothing and will be removed in a future major version. Remove it from your values.

## Uninstalling chart

```shell
Expand Down Expand Up @@ -229,7 +235,7 @@ cronSchedule: "*/15 * * * *"
| reporterConfig.environmentDescription | string | `""` | description applied to every environment auto-created in this run. Only used when `autoEnvironment` is true; existing environments are never modified. Note: a single value is shared by all environments created during the run. |
| reporterConfig.environments | list | `[]` | List of Kosli environments to report to. Each entry has required 'name' and optional namespace selectors. Use one entry to report a single environment; use multiple entries to report to multiple environments with different selectors. Per entry: name (required), namespaces, namespacesRegex, excludeNamespaces, excludeNamespacesRegex (optional). Leave namespace fields unset for an entry to report the entire cluster to that environment. |
| reporterConfig.httpProxy | string | `""` | the http proxy url |
| reporterConfig.includeScaling | boolean | `null` (server default) | whether to record scaling (replica count) changes for every environment auto-created in this run. Leave unset to use the Kosli server default; set to `true` to pass `--include-scaling` or `false` to pass `--exclude-scaling`. Only used when `autoEnvironment` is true; existing environments are never modified. |
| reporterConfig.includeScaling | boolean | `null` | **Deprecated and ignored** — used to control whether scaling (replica count) changes were recorded for environments auto-created in this run. Scaling events no longer trigger new snapshots and an environment can no longer have scaling capture turned on, so the `--include-scaling` / `--exclude-scaling` flags this passed to the CLI had stopped having any effect. As of chart version 2.7.0 the flags are no longer passed. Setting this value does nothing; remove it from your values. |
| reporterConfig.kosliOrg | string | `""` | the name of the Kosli org |
| reporterConfig.securityContext | object | `{"allowPrivilegeEscalation":false,"runAsNonRoot":true,"runAsUser":1000}` | the security context for the reporter cronjob. Set to null or {} to disable security context entirely (not recommended). For OpenShift with SCC, explicitly set runAsUser to null to let OpenShift assign the UID from the allowed range. Simply omitting runAsUser from your values override will not work because Helm deep-merges with these defaults. Example OpenShift override: securityContext: allowPrivilegeEscalation: false runAsNonRoot: true runAsUser: null |
| reporterConfig.securityContext.allowPrivilegeEscalation | bool | `false` | whether to allow privilege escalation |
Expand Down
4 changes: 4 additions & 0 deletions charts/k8s-reporter/_mintlify_templates.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ To install this chart via the Helm chart repository:

If upgrading from v1.x to v2.0.0, migrate your values to the **environments** list format (see [Installing the chart](/helm/k8s_reporter/installing)).

## Deprecated and ignored in v2.7.0: `reporterConfig.includeScaling`

{{ template "body.deprecatedIncludeScaling" . }}

## Upgrade command

{{ template "body.upgradeCmd" . }}
Expand Down
10 changes: 10 additions & 0 deletions charts/k8s-reporter/_templates.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ Version 2.0.0 removes the previous single-environment mode (`kosliEnvironmentNam
* If you want to report artifacts from multiple namespaces or entire cluster, you need to have cluster-wide permissions to `get` and `list` pods.
{{- end }}

{{ define "body.deprecatedIncludeScaling" -}}
`reporterConfig.includeScaling` no longer has any effect. Scaling events do not trigger new snapshots, and an environment can no longer have scaling capture turned on, so the `--include-scaling` / `--exclude-scaling` flags this value passed to the CLI had already stopped doing anything — they only produced a deprecation warning in the reporter's logs on every run.
Comment thread
ToreMerkely marked this conversation as resolved.

Version 2.7.0 stops passing them, which removes that warning. Nothing else changes: the reporter created environments with scaling off before this version and still does. The value is still accepted, but it does nothing and will be removed in a future major version. Remove it from your values.
{{- end }}

{{ define "body.upgradeCmd" -}}
```shell
helm upgrade kosli-reporter kosli/k8s-reporter -f values.yaml
Expand Down Expand Up @@ -116,6 +122,10 @@ helm install kosli-reporter kosli/k8s-reporter -f values.yaml
If upgrading from v1.x to v2.0.0, migrate your values to the **environments** list format (see above). Then:

{{ template "body.upgradeCmd" . }}

### Deprecated and ignored in v2.7.0: `reporterConfig.includeScaling`

{{ template "body.deprecatedIncludeScaling" . }}
{{- end }}

{{ define "extra.uninstall" -}}
Expand Down
7 changes: 0 additions & 7 deletions charts/k8s-reporter/templates/cronjob.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -116,13 +116,6 @@ spec:
- --environment-description
- {{ .Values.reporterConfig.environmentDescription | quote }}
{{- end }}
{{- if kindIs "bool" .Values.reporterConfig.includeScaling }}
{{- if .Values.reporterConfig.includeScaling }}
- --include-scaling
{{- else }}
- --exclude-scaling
{{- end }}
{{- end }}
{{- end }}
{{- if .Values.reporterConfig.dryRun }}
- --dry-run
Expand Down
4 changes: 2 additions & 2 deletions charts/k8s-reporter/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ reporterConfig:
autoEnvironment: false
# -- description applied to every environment auto-created in this run. Only used when `autoEnvironment` is true; existing environments are never modified. Note: a single value is shared by all environments created during the run.
environmentDescription: ""
# -- (boolean) whether to record scaling (replica count) changes for every environment auto-created in this run. Leave unset to use the Kosli server default; set to `true` to pass `--include-scaling` or `false` to pass `--exclude-scaling`. Only used when `autoEnvironment` is true; existing environments are never modified.
# @default -- `null` (server default)
# -- (boolean) **Deprecated and ignored** — used to control whether scaling (replica count) changes were recorded for environments auto-created in this run. Scaling events no longer trigger new snapshots and an environment can no longer have scaling capture turned on, so the `--include-scaling` / `--exclude-scaling` flags this passed to the CLI had stopped having any effect. As of chart version 2.7.0 the flags are no longer passed. Setting this value does nothing; remove it from your values.
# @default -- `null`
includeScaling: null
# -- 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.
dryRun: false
Expand Down
Loading