diff --git a/config/navigation.json b/config/navigation.json index 4b1d934..1bcf9e9 100644 --- a/config/navigation.json +++ b/config/navigation.json @@ -514,7 +514,19 @@ { "group": "Helm Charts", "pages": [ - "helm/k8s_reporter" + { + "group": "Kubernetes Reporter", + "pages": [ + "helm/k8s_reporter/overview", + "helm/k8s_reporter/prerequisites", + "helm/k8s_reporter/installing", + "helm/k8s_reporter/upgrading", + "helm/k8s_reporter/uninstalling", + "helm/k8s_reporter/tls-proxy", + "helm/k8s_reporter/karpenter", + "helm/k8s_reporter/configuration" + ] + } ] } ] diff --git a/config/redirects.json b/config/redirects.json index 4518025..4f17a4d 100644 --- a/config/redirects.json +++ b/config/redirects.json @@ -1,4 +1,8 @@ [ + { + "source": "/helm/k8s_reporter", + "destination": "/helm/k8s_reporter/overview" + }, { "source": "/tutorials/unauthorized_iac_changes", "destination": "/tutorials/detecting_unexpected_statefile_changes" diff --git a/helm/k8s_reporter.mdx b/helm/k8s_reporter.mdx deleted file mode 100644 index bfeb642..0000000 --- a/helm/k8s_reporter.mdx +++ /dev/null @@ -1,397 +0,0 @@ ---- -title: Kubernetes Reporter Helm Chart -description: A Helm chart for installing the Kosli K8S reporter as a cronjob. ---- - -# k8s-reporter - - -This reference applies to **chart version 2.3.1**, which defaults to CLI **v2.12.0** via `appVersion`. Override with `image.tag`. - - -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. - -Configuration is done via **reporterConfig.environments**: a list of Kosli environments to report to. Each entry has a required `name` and optional namespace selectors. Use one entry for a single environment, or multiple entries to report to different environments with different selectors. - -## Breaking change in v2.0.0 - -Version 2.0.0 removes the previous single-environment mode (`kosliEnvironmentName` and the `namespaces` / `namespacesRegex` / `excludeNamespaces` / `excludeNamespacesRegex` flags). You now configure one or more environments only via **reporterConfig.environments**. To report a single environment, use a list with one entry. - -## Prerequisites - -- A Kubernetes cluster (minimum supported version is `v1.21`) -- Helm v3.0+ -- If you want to report artifacts from just one namespace, you need to have permissions to `get` and `list` pods in that namespace. -- If you want to report artifacts from multiple namespaces or entire cluster, you need to have cluster-wide permissions to `get` and `list` pods. - -## Installing the chart - -To install this chart via the Helm chart repository: - - - - ```shell - helm repo add kosli https://charts.kosli.com/ && helm repo update - ``` - - - ```shell - kubectl create secret generic kosli-api-token --from-literal=key= - ``` - - - Configure **reporterConfig.environments** (required). Each entry has required `name` and optional `namespaces`, `namespacesRegex`, `excludeNamespaces`, `excludeNamespacesRegex`. Omit namespace fields for an entry to report the entire cluster to that environment. - - **One environment, entire cluster:** - - ```yaml - # values.yaml - reporterConfig: - kosliOrg: - environments: - - name: - ``` - - **One environment, specific namespaces:** - - ```yaml - reporterConfig: - kosliOrg: - environments: - - name: - namespaces: [namespace1, namespace2] - ``` - - **Multiple environments with different selectors:** - - ```yaml - reporterConfig: - kosliOrg: - environments: - - name: prod-env - namespaces: [prod-ns1, prod-ns2] - - name: staging-env - namespacesRegex: ["^staging-.*"] - - name: infra-env - excludeNamespaces: [prod-ns1, prod-ns2, default] - ``` - - ```shell - helm install kosli-reporter kosli/k8s-reporter -f values.yaml - ``` - - - -Chart source can be found at [GitHub](https://github.com/kosli-dev/cli/tree/main/charts/k8s-reporter). - -See all available [configuration options](#configurations) below. - -## Upgrading the chart - -If upgrading from v1.x to v2.0.0, migrate your values to the **environments** list format (see above). Then: - -```shell -helm upgrade kosli-reporter kosli/k8s-reporter -f values.yaml -``` - -## Uninstalling chart - -```shell -helm uninstall kosli-reporter -``` - -## Running behind a TLS-inspecting proxy (corporate / custom CA bundle) - -If your network sits behind a TLS-inspecting appliance (Zscaler, Netskope, Palo Alto, etc.) that re-signs HTTPS traffic with a corporate CA certificate, the reporter will fail with `x509: certificate signed by unknown authority`. To fix this, make the appliance's CA bundle available to the reporter. - -The chart offers two ways to do this. Use whichever fits your deployment flow. - -### Option 1 — customCA convenience wrapper (recommended for the common case) - - - - PEM format, single cert or bundle: - - ```shell - kubectl create secret generic corporate-ca-bundle --from-file=ca.crt=/path/to/corporate-ca.crt - ``` - - - ```yaml - customCA: - enabled: true - secretName: corporate-ca-bundle - key: ca.crt - ``` - - - -The chart mounts the certificate as a single file at `/etc/ssl/certs/kosli-custom-ca.crt` using `subPath`. Go's standard library on Linux loads CA roots in two independent passes — it reads the system bundle file (e.g. `/etc/ssl/certs/ca-certificates.crt`) and **also** scans `/etc/ssl/certs/` for additional certificate files. The mounted file is picked up by the directory scan and added to the trust store alongside the system roots, so no `SSL_CERT_FILE` env var is needed. - -The wrapper deliberately does **not** set `SSL_CERT_FILE`. Setting it would replace the system bundle entirely with the customer's file, breaking trust for any public CAs the bundle does not include. - -### Option 2 — generic extraVolumes / extraVolumeMounts / extraEnvVars - -Use these when you need a non-default mount path, a ConfigMap instead of a Secret, multiple volumes, or any other shape the wrapper does not cover: - -```yaml -extraVolumes: - - name: corporate-ca - secret: - secretName: corporate-ca-bundle - -extraVolumeMounts: - - name: corporate-ca - mountPath: /etc/ssl/certs/corporate - readOnly: true -``` - - -If you mount the CA outside `/etc/ssl/certs/` and set `SSL_CERT_FILE` via `extraEnvVars`, your bundle must include the public CAs you also need to trust — Go uses only that file when `SSL_CERT_FILE` is set. - - -### Pod Security Standards - -Both options use `secret`-backed volumes, which are permitted under the Pod Security Standards `restricted` profile. `hostPath` mounts are not permitted under that profile and should not be used here. - -### Cluster-wide alternative - -If you already run [cert-manager's trust-manager](https://cert-manager.io/docs/trust/trust-manager/) to distribute a corporate CA bundle into a well-known ConfigMap in every namespace, point `extraVolumes` / `extraVolumeMounts` at that ConfigMap instead of creating a per-namespace Secret. - -## Running on EKS with Karpenter (or another node autoscaler) - -By default the reporter runs as a CronJob every 5 minutes. On clusters that use [Karpenter](https://karpenter.sh) for node autoscaling, this frequent scheduling can prevent nodes from being **consolidated** (scaled down). - -The cause is Karpenter's `consolidateAfter` timer: Karpenter only consolidates a node once it has seen no pod scheduling activity on it for the configured window. A reporter pod arriving every 5 minutes keeps resetting that timer, so any node whose `consolidateAfter` is longer than the reporter interval never becomes eligible for consolidation (see [karpenter#1921](https://github.com/kubernetes-sigs/karpenter/issues/1921)). This is Karpenter working as designed, not a reporter bug. - -Frequent snapshots are what let Kosli surface drift or an unauthorized change quickly, so the best fix keeps the 5-minute cadence and moves the reporter out of Karpenter's way. Widening the interval trades away that detection speed and should be a last resort. - -### 1. Pin the reporter to a stable node group (recommended) - -If you run a stable managed node group that Karpenter does not manage, schedule the reporter there so it never disturbs Karpenter-managed nodes. Use `nodeSelector`, and `tolerations` if that node group is tainted: - -```yaml -nodeSelector: - eks.amazonaws.com/nodegroup: system # your managed node group - -tolerations: - - key: dedicated - operator: Equal - value: system - effect: NoSchedule -``` - -To steer the reporter away from Karpenter-managed nodes instead, use `affinity` (a plain `nodeSelector` cannot express "not on these nodes"): - -```yaml -affinity: - nodeAffinity: - requiredDuringSchedulingIgnoredDuringExecution: - nodeSelectorTerms: - - matchExpressions: - - key: karpenter.sh/nodepool - operator: DoesNotExist -``` - -### 2. Run the reporter out of the cluster - -For zero footprint on cluster nodes, run `kosli snapshot k8s` on a schedule outside the cluster (for example a CI cron job) with kubeconfig access, keeping your reporting cadence without placing a pod on the cluster's nodes. See the [Kubernetes environment reporting tutorial](/tutorials/report_k8s_envs). - -### 3. Widen the report interval (last resort) - -Only if you cannot pin the reporter or move it out of cluster: set `cronSchedule` longer than your NodePool's `consolidateAfter` so nodes get quiet windows long enough to consolidate. This works, but a longer interval widens the window in which a change can go unreported, so prefer the options above. - -```yaml -cronSchedule: "*/15 * * * *" -``` - - -`karpenter.sh/do-not-disrupt: "true"` is **not** a fix here. It prevents Karpenter from disrupting the pod, which protects a mid-run report from interruption but makes consolidation of that node *less* likely, not more. Likewise `cluster-autoscaler.kubernetes.io/safe-to-evict` only affects the Kubernetes Cluster Autoscaler and is ignored by Karpenter. - - -## Configurations - -### General - - - Affinity rules for scheduling the reporter pod. Supports nodeAffinity, podAffinity and podAntiAffinity. - - - - Specifies how to treat concurrent executions of a Job that is created by this CronJob. - - - - The cron schedule at which the reporter is triggered to report to Kosli. - - - - Specifies the number of failed finished jobs to keep. - - - - Overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride`. - - - - Overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one. - - - - Node labels for scheduling the reporter pod. On EKS with Karpenter, use this to pin the reporter to a stable managed node group (e.g. `eks.amazonaws.com/nodegroup: `) so it does not interfere with node consolidation. See the "Running on EKS with Karpenter" section of the README. - - - - Annotations to add to the CronJob object itself. For pod-level annotations (added to each reporter pod), use `podTemplateAnnotations` instead. - - - - Custom labels to add to pods. - - - - Annotations to add to the reporter pod template (applied to each Job pod that the CronJob creates). - - - - Specifies the number of successful finished jobs to keep. - - - - Tolerations for scheduling the reporter pod, e.g. to run on a dedicated or tainted node group. - - -### Image - - - The kosli reporter image pull policy. - - - - The kosli reporter image repository. - - - - The kosli reporter image tag, overrides the image tag whose default is the chart appVersion. - - -### Reporter configuration - - - 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. - - - - 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. - - - - The http proxy url. - - - - The name of the Kosli org. - - - - 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. - - - - Whether to allow privilege escalation. - - - - Whether to run as non root. - - - - The user id to run as. For OpenShift environments with SCC, set to null (runAsUser: null) to allow automatic UID assignment. Simply omitting this field will not work due to Helm's deep merge with chart defaults. - - -### Kosli API token - - - The name of the key in the secret data which contains the Kosli API token. - - - - The name of the secret containing the kosli API token. - - -### Environment variables - - - Map of plain environment variables to inject into the reporter container. For a single-tenant Kosli instance, set `KOSLI_HOST` to `https://INSTANCE_NAME.kosli.com`. - - - - Additional environment variables to inject into the reporter container. List of `{name, value}` or `{name, valueFrom}` entries, rendered verbatim into the container env. Supports plain values and valueFrom (`secretKeyRef` / `configMapKeyRef`). Note: entries here are appended after the chart's own env entries; on duplicate names the later entry wins. - - -### Volumes - - - Additional container-level volumeMounts for the reporter container. Rendered verbatim into the container spec alongside the chart's own mounts. - - - - Additional Pod-level volumes to attach to the reporter pod. Rendered verbatim into the Pod spec alongside the chart's own volumes. Use together with `extraVolumeMounts` to mount Secrets, ConfigMaps, or other volumes into the container. - - -### Custom CA - - - Convenience wrapper for mounting a corporate / custom CA bundle. See the "Running behind a TLS-inspecting proxy" section of the README for usage. - - - - Enable mounting a corporate/custom CA bundle into the trust store. - - - - Key within the Secret that holds the PEM-formatted CA certificate (single cert or multi-cert PEM bundle). - - - - Name of an existing Secret in the same namespace containing the CA bundle. - - -### Resources - - - The cpu limit. - - - - The memory limit. - - - - The memory request. - - -### Service account - - - Annotations to add to the service account. - - - - Specifies whether a service account should be created. - - - - The name of the service account to use. If not set and create is true, a name is generated using the fullname template. - - - - 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.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) - diff --git a/helm/k8s_reporter/configuration.mdx b/helm/k8s_reporter/configuration.mdx new file mode 100644 index 0000000..7f3272a --- /dev/null +++ b/helm/k8s_reporter/configuration.mdx @@ -0,0 +1,186 @@ +--- +title: Configuration reference +description: All values.yaml options for the Kosli k8s-reporter Helm chart. +--- + +## General + + + Affinity rules for scheduling the reporter pod. Supports nodeAffinity, podAffinity and podAntiAffinity. + + + + Specifies how to treat concurrent executions of a Job that is created by this CronJob. + + + + The cron schedule at which the reporter is triggered to report to Kosli. + + + + Specifies the number of failed finished jobs to keep. + + + + Overrides the fullname used for the created k8s resources. It has higher precedence than `nameOverride`. + + + + Overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one. + + + + Node labels for scheduling the reporter pod. On EKS with Karpenter, use this to pin the reporter to a stable managed node group (e.g. `eks.amazonaws.com/nodegroup: `) so it does not interfere with node consolidation. See [Running on EKS with Karpenter](/helm/k8s_reporter/karpenter). + + + + Annotations to add to the CronJob object itself. For pod-level annotations (added to each reporter pod), use `podTemplateAnnotations` instead. + + + + Custom labels to add to pods. + + + + Annotations to add to the reporter pod template (applied to each Job pod that the CronJob creates). + + + + Specifies the number of successful finished jobs to keep. + + + + Tolerations for scheduling the reporter pod, e.g. to run on a dedicated or tainted node group. + + +## Image + + + The kosli reporter image pull policy. + + + + The kosli reporter image repository. + + + + The kosli reporter image tag, overrides the image tag whose default is the chart appVersion. + + +## Reporter configuration + + + 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. + + + + 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. + + + + The http proxy url. + + + + The name of the Kosli org. + + + + 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. + + + + Whether to allow privilege escalation. + + + + Whether to run as non root. + + + + The user id to run as. For OpenShift environments with SCC, set to null (runAsUser: null) to allow automatic UID assignment. Simply omitting this field will not work due to Helm's deep merge with chart defaults. + + +## Kosli API token + + + The name of the key in the secret data which contains the Kosli API token. + + + + The name of the secret containing the kosli API token. + + +## Environment variables + + + Map of plain environment variables to inject into the reporter container. For a single-tenant Kosli instance, set `KOSLI_HOST` to `https://INSTANCE_NAME.kosli.com`. + + + + Additional environment variables to inject into the reporter container. List of `{name, value}` or `{name, valueFrom}` entries, rendered verbatim into the container env. Supports plain values and valueFrom (`secretKeyRef` / `configMapKeyRef`). Note: entries here are appended after the chart's own env entries; on duplicate names the later entry wins. + + +## Volumes + + + Additional container-level volumeMounts for the reporter container. Rendered verbatim into the container spec alongside the chart's own mounts. + + + + Additional Pod-level volumes to attach to the reporter pod. Rendered verbatim into the Pod spec alongside the chart's own volumes. Use together with `extraVolumeMounts` to mount Secrets, ConfigMaps, or other volumes into the container. + + +## Custom CA + + + Convenience wrapper for mounting a corporate / custom CA bundle. See [Running behind a TLS-inspecting proxy](/helm/k8s_reporter/tls-proxy) for usage. + + + + Enable mounting a corporate/custom CA bundle into the trust store. + + + + Key within the Secret that holds the PEM-formatted CA certificate (single cert or multi-cert PEM bundle). + + + + Name of an existing Secret in the same namespace containing the CA bundle. + + +## Resources + + + The cpu limit. + + + + The memory limit. + + + + The memory request. + + +## Service account + + + Annotations to add to the service account. + + + + Specifies whether a service account should be created. + + + + The name of the service account to use. If not set and create is true, a name is generated using the fullname template. + + + + 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.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2). diff --git a/helm/k8s_reporter/installing.mdx b/helm/k8s_reporter/installing.mdx new file mode 100644 index 0000000..95567ee --- /dev/null +++ b/helm/k8s_reporter/installing.mdx @@ -0,0 +1,64 @@ +--- +title: Installing the chart +description: Install the Kosli k8s-reporter Helm chart via the Kosli Helm repository. +--- + +To install this chart via the Helm chart repository: + + + + ```shell + helm repo add kosli https://charts.kosli.com/ && helm repo update + ``` + + + + ```shell + kubectl create secret generic kosli-api-token --from-literal=key= + ``` + + + + Configure **reporterConfig.environments** (required). Each entry has required `name` and optional `namespaces`, `namespacesRegex`, `excludeNamespaces`, `excludeNamespacesRegex`. Omit namespace fields for an entry to report the entire cluster to that environment. + + **One environment, entire cluster:** + + ```yaml + # values.yaml + reporterConfig: + kosliOrg: + environments: + - name: + ``` + + **One environment, specific namespaces:** + + ```yaml + reporterConfig: + kosliOrg: + environments: + - name: + namespaces: [namespace1, namespace2] + ``` + + **Multiple environments with different selectors:** + + ```yaml + reporterConfig: + kosliOrg: + environments: + - name: prod-env + namespaces: [prod-ns1, prod-ns2] + - name: staging-env + namespacesRegex: ["^staging-.*"] + - name: infra-env + excludeNamespaces: [prod-ns1, prod-ns2, default] + ``` + + ```shell + helm install kosli-reporter kosli/k8s-reporter -f values.yaml + ``` + + + +See all available options in the [configuration reference](/helm/k8s_reporter/configuration). diff --git a/helm/k8s_reporter/karpenter.mdx b/helm/k8s_reporter/karpenter.mdx new file mode 100644 index 0000000..bb68538 --- /dev/null +++ b/helm/k8s_reporter/karpenter.mdx @@ -0,0 +1,53 @@ +--- +title: Running on EKS with Karpenter +description: Keep the k8s-reporter out of Karpenter's way so nodes can still consolidate. +--- + +By default the reporter runs as a CronJob every 5 minutes. On clusters that use [Karpenter](https://karpenter.sh) for node autoscaling, this frequent scheduling can prevent nodes from being **consolidated** (scaled down). + +The cause is Karpenter's `consolidateAfter` timer: Karpenter only consolidates a node once it has seen no pod scheduling activity on it for the configured window. A reporter pod arriving every 5 minutes keeps resetting that timer, so any node whose `consolidateAfter` is longer than the reporter interval never becomes eligible for consolidation (see [karpenter#1921](https://github.com/kubernetes-sigs/karpenter/issues/1921)). This is Karpenter working as designed, not a reporter bug. + +Frequent snapshots are what let Kosli surface drift or an unauthorized change quickly, so the best fix keeps the 5-minute cadence and moves the reporter out of Karpenter's way. Widening the interval trades away that detection speed and should be a last resort. + +## 1. Pin the reporter to a stable node group (recommended) + +If you run a stable managed node group that Karpenter does not manage, schedule the reporter there so it never disturbs Karpenter-managed nodes. Use `nodeSelector`, and `tolerations` if that node group is tainted: + +```yaml +nodeSelector: + eks.amazonaws.com/nodegroup: system # your managed node group + +tolerations: + - key: dedicated + operator: Equal + value: system + effect: NoSchedule +``` + +To steer the reporter away from Karpenter-managed nodes instead, use `affinity` (a plain `nodeSelector` cannot express "not on these nodes"): + +```yaml +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: karpenter.sh/nodepool + operator: DoesNotExist +``` + +## 2. Run the reporter out of the cluster + +For zero footprint on cluster nodes, run `kosli snapshot k8s` on a schedule outside the cluster (for example a CI cron job) with kubeconfig access, keeping your reporting cadence without placing a pod on the cluster's nodes. See the [Kubernetes environment reporting tutorial](/tutorials/report_k8s_envs). + +## 3. Widen the report interval (last resort) + +Only if you cannot pin the reporter or move it out of cluster: set `cronSchedule` longer than your NodePool's `consolidateAfter` so nodes get quiet windows long enough to consolidate. This works, but a longer interval widens the window in which a change can go unreported, so prefer the options above. + +```yaml +cronSchedule: "*/15 * * * *" +``` + + + `karpenter.sh/do-not-disrupt: "true"` is **not** a fix here. It prevents Karpenter from disrupting the pod, which protects a mid-run report from interruption but makes consolidation of that node *less* likely, not more. Likewise `cluster-autoscaler.kubernetes.io/safe-to-evict` only affects the Kubernetes Cluster Autoscaler and is ignored by Karpenter. + diff --git a/helm/k8s_reporter/overview.mdx b/helm/k8s_reporter/overview.mdx new file mode 100644 index 0000000..abb41f0 --- /dev/null +++ b/helm/k8s_reporter/overview.mdx @@ -0,0 +1,27 @@ +--- +title: Kubernetes Reporter Helm Chart +description: A Helm chart for installing the Kosli K8S reporter as a cronjob. +--- + + + This reference applies to **chart version 2.3.1**, which defaults to CLI **v2.12.0** via `appVersion`. Override with `image.tag`. + + +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. + +Configuration is done via **reporterConfig.environments**: a list of Kosli environments to report to. Each entry has a required `name` and optional namespace selectors. Use one entry for a single environment, or multiple entries to report to different environments with different selectors. + +Chart source can be found at [GitHub](https://github.com/kosli-dev/cli/tree/main/charts/k8s-reporter). + +## In this section + + + + + + + + + + diff --git a/helm/k8s_reporter/prerequisites.mdx b/helm/k8s_reporter/prerequisites.mdx new file mode 100644 index 0000000..31c036e --- /dev/null +++ b/helm/k8s_reporter/prerequisites.mdx @@ -0,0 +1,9 @@ +--- +title: Prerequisites +description: Requirements for installing the Kosli k8s-reporter Helm chart. +--- + +* A Kubernetes cluster (minimum supported version is `v1.21`) +* Helm v3.0+ +* If you want to report artifacts from just one namespace, you need to have permissions to `get` and `list` pods in that namespace. +* If you want to report artifacts from multiple namespaces or entire cluster, you need to have cluster-wide permissions to `get` and `list` pods. diff --git a/helm/k8s_reporter/tls-proxy.mdx b/helm/k8s_reporter/tls-proxy.mdx new file mode 100644 index 0000000..b4c7cf6 --- /dev/null +++ b/helm/k8s_reporter/tls-proxy.mdx @@ -0,0 +1,61 @@ +--- +title: Running behind a TLS-inspecting proxy +description: Trust a corporate / custom CA bundle when running the k8s-reporter behind a TLS-inspecting proxy. +--- + +If your network sits behind a TLS-inspecting appliance (Zscaler, Netskope, Palo Alto, etc.) that re-signs HTTPS traffic with a corporate CA certificate, the reporter will fail with `x509: certificate signed by unknown authority`. To fix this, make the appliance's CA bundle available to the reporter. + +The chart offers two ways to do this. Use whichever fits your deployment flow. + +## Option 1 — customCA convenience wrapper (recommended for the common case) + + + + PEM format, single cert or bundle: + + ```shell + kubectl create secret generic corporate-ca-bundle --from-file=ca.crt=/path/to/corporate-ca.crt + ``` + + + + ```yaml + customCA: + enabled: true + secretName: corporate-ca-bundle + key: ca.crt + ``` + + + +The chart mounts the certificate as a single file at `/etc/ssl/certs/kosli-custom-ca.crt` using `subPath`. Go's standard library on Linux loads CA roots in two independent passes — it reads the system bundle file (e.g. `/etc/ssl/certs/ca-certificates.crt`) and **also** scans `/etc/ssl/certs/` for additional certificate files. The mounted file is picked up by the directory scan and added to the trust store alongside the system roots, so no `SSL_CERT_FILE` env var is needed. + +The wrapper deliberately does **not** set `SSL_CERT_FILE`. Setting it would replace the system bundle entirely with the customer's file, breaking trust for any public CAs the bundle does not include. + +## Option 2 — generic extraVolumes / extraVolumeMounts / extraEnvVars + +Use these when you need a non-default mount path, a ConfigMap instead of a Secret, multiple volumes, or any other shape the wrapper does not cover: + +```yaml +extraVolumes: + - name: corporate-ca + secret: + secretName: corporate-ca-bundle + +extraVolumeMounts: + - name: corporate-ca + mountPath: /etc/ssl/certs/corporate + readOnly: true +``` + + + If you mount the CA outside `/etc/ssl/certs/` and set `SSL_CERT_FILE` via `extraEnvVars`, your bundle must include the public CAs you also need to trust — Go uses only that file when `SSL_CERT_FILE` is set. + + +## Pod Security Standards + +Both options use `secret`-backed volumes, which are permitted under the Pod Security Standards `restricted` profile. `hostPath` mounts are not permitted under that profile and should not be used here. + +## Cluster-wide alternative + +If you already run [cert-manager's trust-manager](https://cert-manager.io/docs/trust/trust-manager/) to distribute a corporate CA bundle into a well-known ConfigMap in every namespace, point `extraVolumes` / `extraVolumeMounts` at that ConfigMap instead of creating a per-namespace Secret. diff --git a/helm/k8s_reporter/uninstalling.mdx b/helm/k8s_reporter/uninstalling.mdx new file mode 100644 index 0000000..36c8674 --- /dev/null +++ b/helm/k8s_reporter/uninstalling.mdx @@ -0,0 +1,8 @@ +--- +title: Uninstalling the chart +description: Remove the Kosli k8s-reporter release from your cluster. +--- + +```shell +helm uninstall kosli-reporter +``` diff --git a/helm/k8s_reporter/upgrading.mdx b/helm/k8s_reporter/upgrading.mdx new file mode 100644 index 0000000..3df9481 --- /dev/null +++ b/helm/k8s_reporter/upgrading.mdx @@ -0,0 +1,16 @@ +--- +title: Upgrading the chart +description: Upgrade an existing Kosli k8s-reporter release, including migration notes for v2.0.0. +--- + +## Breaking change in v2.0.0 + +Version 2.0.0 removes the previous single-environment mode (`kosliEnvironmentName` and the `namespaces` / `namespacesRegex` / `excludeNamespaces` / `excludeNamespacesRegex` flags). You now configure one or more environments only via **reporterConfig.environments**. To report a single environment, use a list with one entry. + +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)). + +## Upgrade command + +```shell +helm upgrade kosli-reporter kosli/k8s-reporter -f values.yaml +``` diff --git a/tutorials/report_k8s_envs.md b/tutorials/report_k8s_envs.md index dc0b165..8c06ad6 100644 --- a/tutorials/report_k8s_envs.md +++ b/tutorials/report_k8s_envs.md @@ -70,7 +70,7 @@ kubectl get cronjobs The CronJob will now run every 5 minutes and report what is running in the cluster to Kosli. -Running on EKS with Karpenter, or another node autoscaler? A reporter pod arriving every 5 minutes can stop nodes being consolidated. Pin the reporter to a stable node group, widen `cronSchedule`, or run it out of cluster. See [Running on EKS with Karpenter](/helm/k8s_reporter#running-on-eks-with-karpenter-or-another-node-autoscaler). +Running on EKS with Karpenter, or another node autoscaler? A reporter pod arriving every 5 minutes can stop nodes being consolidated. Pin the reporter to a stable node group, widen `cronSchedule`, or run it out of cluster. See [Running on EKS with Karpenter](/helm/k8s_reporter/karpenter).