# Technical Documentation: prometheus-community/helm-charts > ℹ️ **Provenance:** Multi-Tier Ingestion Β· [CodeWiki Reference](https://codewiki.google/github.com/prometheus-community/helm-charts) ### Overview (`README.md`) # Prometheus Community Kubernetes Helm Charts [](https://artifacthub.io/packages/search?org=prometheus&cncf=true) [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/prometheus-community/helm-charts/releases) This functionality is in beta and is subject to change. The code is provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. ## Usage [Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started. Once Helm is set up properly, add the repository as follows: ```console helm repo add prometheus-community https://prometheus-community.github.io/helm-charts ``` You can then run `helm search repo prometheus-community` to see the charts. OCI artifacts of all Prometheus Helm charts are available in [ghcr.io](https://github.com/orgs/prometheus-community/packages?repo_name=helm-charts). ## Helm Provenance and Integrity All charts in this repository are signed. More information about how to verify charts can be found in the official [Helm documentation](https://helm.sh/docs/topics/provenance/). A local running gpg agent is mandatory. To import the signing key for this repository, please run the following command: ```console curl https://prometheus-community.github.io/helm-charts/pubkey.gpg | gpg --import ``` After importing the key, you can use the `--verify` flag during `helm install` to enable chart signature validation. ## Contributing The source code of all [Prometheus](https://prometheus.io) community [Helm](https://helm.sh) charts can be found on GitHub: We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/prometheus-community/helm-charts/blob/main/CONTRIBUTING.md) for details. ## License [Apache 2.0 License](https://github.com/prometheus-community/helm-charts/blob/main/LICENSE). ## Helm charts build status --- ### Overview (`changelog/README.md`) # Helm Charts Changelog This directory contains the interactive changelog viewer for the Grafana Community Helm Charts project. ## About The `index.html` file is an interactive web application that displays the complete changelog history for all Helm charts in the Grafana Community repository. It provides a user-friendly interface for browsing changes across different chart versions. ## Accessing the Changelog End users can view the changelog at: **https://prometheus-community.github.io/helm-charts/changelog/** ## index.html Features ### πŸ“Š Interactive Release History - Displays all releases for each Helm chart - Organized by chart and sorted by version/publication date - Automatic filtering of CI and administrative commits ### 🎯 Chart Navigation - Auto-detects all available charts in the repository - Easy switching between different charts - URL-based navigation with shareable links ### πŸ”— External Integration - **GitHub Links**: Direct links to releases and pull requests - **ArtifactHub Integration**: - Template comparison views between versions - Values file comparison for configuration changes - Direct links to ArtifactHub package pages ### πŸŒ“ Modern User Experience - Responsive design (desktop & mobile optimized) - Automatic dark mode support based on system preferences - Manual theme toggle with localStorage persistence - Clean, modern UI with GitHub-inspired styling ### πŸ”’ Security Features - XSS protection through HTML sanitization - Only safe domains allowed (GitHub, ArtifactHub) - Input validation for repository parameters ## Technical Implementation - **No external dependencies**: Pure vanilla JavaScript - **GitHub API**: REST API v3 for fetching releases - **Modern web standards**: HTML5, CSS3, responsive design - **Performance optimized**: Pagination support for repositories with many releases ## How It Works 1. **Auto-Detection**: The app detects the GitHub organization from the page URL 2. **Release Fetching**: Queries GitHub API for repository releases 3. **Chart Extraction**: Parses release tags in `chart-name-version` format 4. **Dynamic UI**: Generates buttons for each chart and displays release notes 5. **Smart Filtering**: Removes CI-related changes and shows only relevant updates ## URL Parameters - `?owner=organization&repo=repository` - Load specific repository - `?chart=chart-name` - Display specific chart on page load - All parameters are validated and sanitized for security ## Release Tag Format For charts to appear in the changelog, releases must be tagged with: ``` chart-name-version ``` Example: `grafana-9.5.0`, `prometheus-mongodb-exporter-4.2.1` --- ### Overview (`charts/alertmanager-snmp-notifier/README.md`) # Prometheus SNMP Notifier An Alertmanager webhook that relays alerts as SNMP traps. This chart creates a [SNMP Notifier](https://github.com/maxwo/snmp_notifier) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.23+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/alertmanager-snmp-notifier` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `alertmanager-snmp-notifier` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/alertmanager-snmp-notifier ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. #### To 1.0.0 This version uses SNMP Notifier 2.0.0, with the introduction of the generic `--trap.user-object` instead of `--snmp.trap-extra-field` arguments. The chart therefore accepts the `trapTemplates` object with the `description` and `userObjects` variables instead of the previous `snmpTemplates`: ```yaml trapTemplates: userObjects: - subOid: 1 template: | {{- if .Alerts -}} Status: NOK {{- else -}} Status: OK {{- end -}} - subOid: 5 template: | This is a constant ``` See [SNMP Notifier Repository](https://github.com/maxwo/snmp_notifier) for more details about new arguments. It also updates the `HorizontalPodAutoscaler` to the `autoscaling/v2` API version. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/alertmanager-snmp-notifier ``` ### Flags Check the [configuration section](https://github.com/maxwo/snmp_notifier#snmp-notifier-configuration) list and add to the `snmpNotifier.extraArgs` block in your value overrides. --- ### Overview (`charts/alertmanager/README.md`) # Alertmanager As per [prometheus.io documentation](https://prometheus.io/docs/alerting/latest/alertmanager/): > The Alertmanager handles alerts sent by client applications such as the > Prometheus server. It takes care of deduplicating, grouping, and routing them > to the correct receiver integration such as email, PagerDuty, or OpsGenie. It > also takes care of silencing and inhibition of alerts. ## Prerequisites Kubernetes 1.25+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/alertmanager` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `alertmanager` The installation instructions use the OCI registry. Refer to the [`helm repo`](https://helm.sh/docs/helm/helm_repo/) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/alertmanager ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 2.0 Version 2.0 enables the config reloader by default and adds hardened default security contexts and health probes for Alertmanager and the config reloader. Review custom `securityContext`, probe, and `configmapReload` values before upgrading. ### To 1.0 The [configmap-reload](https://github.com/jimmidyson/configmap-reload) container was replaced by the [prometheus-config-reloader](https://github.com/prometheus-operator/prometheus-operator/tree/main/cmd/prometheus-config-reloader). Extra command-line arguments specified via configmapReload.prometheus.extraArgs are not compatible and will break with the new prometheus-config-reloader, refer to the [sources](https://github.com/prometheus-operator/prometheus-operator/blob/main/cmd/prometheus-config-reloader/main.go) in order to make the appropriate adjustment to the extra command-line arguments. The `networking.k8s.io/v1beta1` is no longer supported. Use [`networking.k8s.io/v1`](https://kubernetes.io/docs/reference/using-api/deprecation-guide/#ingressclass-v122). ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/alertmanager ``` --- ### Overview (`charts/jiralert/Readme.md`) # jiralert JIRAlert implements Alertmanager's webhook HTTP API and connects to one or more Jira instances to create highly configurable Jira issues. **Homepage:** ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/jiralert` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `jiralert` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/jiralert ``` _See [configuration](#configuration) below._ _See [`helm install`](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [`helm uninstall`](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/jiralert ``` --- ### Overview (`charts/kube-prometheus-stack/README.md`) # kube-prometheus-stack Installs core components of the [kube-prometheus stack](https://github.com/prometheus-operator/kube-prometheus), a collection of Kubernetes manifests, [Grafana](http://grafana.com/) dashboards, and [Prometheus rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) combined with documentation and scripts to provide easy to operate end-to-end Kubernetes cluster monitoring with [Prometheus](https://prometheus.io/) using the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator). See the [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) readme for details about components, dashboards, and alerts. _Note: This chart was formerly named `prometheus-operator` chart, now renamed to more clearly reflect that it installs the `kube-prometheus` project stack, within which Prometheus Operator is only one component. This chart does not install all components of `kube-prometheus`, notably excluding the Prometheus Adapter and Prometheus black-box exporter._ ## Prerequisites - Kubernetes 1.19+ - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `kube-prometheus-stack` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Helm Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Dependencies By default this chart installs additional, dependent charts: - [prometheus-community/kube-state-metrics](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-state-metrics) - [prometheus-community/prometheus-node-exporter](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-node-exporter) - [grafana/grafana](https://github.com/grafana/helm-charts/tree/main/charts/grafana) To disable dependencies during installation, see [multiple releases](#multiple-releases) below. _See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command documentation._ #### Grafana Dashboards This chart provisions a collection of curated Grafana dashboards that are automatically loaded into Grafana via ConfigMaps. These dashboards are rendered into the Helm chart under [`templates/grafana/`](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack/templates/grafana/), but **this is not their source of truth**. The dashboards originate from various upstream projects and are gathered and processed using scripts in the [`hack/`](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack/hack) directory. For details on how these dashboards are sourced and kept up to date, refer to the [hack/README.md](https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/hack/README.md). > **Note:** The dashboards referenced in the `hack` scripts are usually **not the original source** either. Most originate from separate **Prometheus mixin repositories** (e.g., [kubernetes-mixin](https://github.com/kubernetes-monitoring/kubernetes-mixin)) and are processed through `jsonnet` tooling before being included here. To find the original source in case you want to modify it you may have to search even further upstream. If you wish to contribute or modify dashboards, please follow the guidance in the `hack/README.md` to ensure consistency and reproducibility. ### Uninstall Helm Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ CRDs created by this chart are not removed by default and should be manually cleaned up: ```console kubectl delete crd alertmanagerconfigs.monitoring.coreos.com kubectl delete crd alertmanagers.monitoring.coreos.com kubectl delete crd podmonitors.monitoring.coreos.com kubectl delete crd probes.monitoring.coreos.com kubectl delete crd prometheusagents.monitoring.coreos.com kubectl delete crd prometheuses.monitoring.coreos.com kubectl delete crd prometheusrules.monitoring.coreos.com kubectl delete crd scrapeconfigs.monitoring.coreos.com kubectl delete crd servicemonitors.monitoring.coreos.com kubectl delete crd thanosrulers.monitoring.coreos.com ``` ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] ``` With Helm v3, CRDs created by this chart are not updated by default and should be manually updated. Consult also the [Helm Documentation on CRDs](https://helm.sh/docs/chart_best_practices/custom_resource_definitions). CRDs update lead to a major version bump. The Chart's [appVersion](https://github.com/prometheus-community/helm-charts/blob/13ed7098db2f78c2bbcdab6c1c3c7a95b4b94574/charts/kube-prometheus-stack/Chart.yaml#L36) refers to the [`prometheus-operator`](https://github.com/prometheus-operator/prometheus-operator/tree/main)'s version with matching CRDs. _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. See [UPGRADE.md](https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/UPGRADE.md) for breaking changes between versions. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments: ```console helm show values oci://ghcr.io/prometheus-community/charts/kube-prometheus-stack ``` You may also `helm show values` on this chart's [dependencies](#dependencies) for additional options. For templated Grafana datasource definitions (e.g. when using Helm flow control), use `grafana.additionalDataSourcesString`, which is rendered via `tpl`. ### HTTPRoute timeouts Set `timeouts` on a route to configure request and backend request timeouts for its generated HTTPRoute rule: ```yaml prometheus: route: main: enabled: true parentRefs: - name: gateway timeouts: request: 120s backendRequest: 60s ``` The same settings are available under `alertmanager.route`, `thanosRuler.route`, and the `routePerReplica` settings for Prometheus and Alertmanager. Timeouts are only rendered for `kind: HTTPRoute`. They do not apply to generated HTTPS redirect rules or propagate to `additionalRules`; configure timeouts directly on additional rules when needed. Leaving `timeouts` empty preserves the Gateway controller's defaults. This requires Gateway API CRDs that support HTTPRoute timeouts (available in the Standard channel since v1.2.0) and a Gateway controller that supports the corresponding timeout features. When both values are set, `backendRequest` must not exceed `request`, unless `request` is `"0s"`. See the [Gateway API timeout documentation](https://gateway-api.sigs.k8s.io/reference/api-types/httproute/#timeouts-optional) for duration semantics and controller support requirements. ### Authentication of the control-plane ServiceMonitors The built-in ServiceMonitors for kubelet, kube-apiserver, kube-controller-manager, kube-scheduler, kube-etcd, kube-proxy, coredns and kube-dns authenticate through Kubernetes objects rather than through files on the scraper's filesystem. The bearer token comes from a Secret referenced by `authorization`, and the CA comes from the `kube-root-ca.crt` ConfigMap that Kubernetes maintains in every namespace. This keeps the ServiceMonitors valid when `prometheus.prometheusSpec.arbitraryFSAccessThroughSMs.deny` is `true`, and when they are scraped by Grafana Alloy's `prometheus.operator.servicemonitors` component, which rejects filesystem references by default since v1.19.0. The chart creates the credential itself: `prometheus.serviceAccount.createTokenSecret` (enabled by default) renders a `kubernetes.io/service-account-token` Secret named `-token`, which every component references by default: ```yaml kubelet: serviceMonitor: authorization: type: Bearer credentials: name: '{{ include "kube-prometheus-stack.prometheus.tokenSecretName" . }}' key: token tlsConfig: insecureSkipVerify: true ca: configMap: name: kube-root-ca.crt key: ca.crt ``` Both `authorization` and `tlsConfig` are rendered as-is, so any field of the Prometheus Operator [SafeAuthorization](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.SafeAuthorization) and [SafeTLSConfig](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.SafeTLSConfig) types can be set. Set `authorization` to `null` to scrape a component without authentication. `kubeApiServer` keeps its TLS settings under `kubeApiServer.tlsConfig`; `coreDns` and `kubeDns` have no `tlsConfig`, since those endpoints are scraped over HTTP. That Secret is only rendered alongside the Prometheus service account, so it also requires `prometheus.enabled` and `prometheus.serviceAccount.create`. Leaving a component on the default `authorization` while the Secret is not rendered fails the release with an explanatory message, rather than producing a ServiceMonitor that references a Secret which will never exist. When the control plane is scraped by a Prometheus this chart does not deploy, point each enabled component at the scraper's own credential; `ci/08-external-scraper-values.yaml` is a complete example. To use your own credential, disable `prometheus.serviceAccount.createTokenSecret` and point the components at your Secret. The Secret must live in the namespace of the ServiceMonitor, which is the release namespace unless `prometheus.prometheusSpec.ignoreNamespaceSelectors` is enabled. Because Helm deep-merges values, replacing the CA reference requires clearing the default explicitly: ```yaml kubelet: serviceMonitor: tlsConfig: ca: configMap: null secret: name: kubelet-scrape-auth key: ca.crt ``` `kubeEtcd` is the only component that scrapes with client certificates: ```yaml kubeEtcd: serviceMonitor: scheme: https tlsConfig: insecureSkipVerify: false ca: secret: name: etcd-client-cert key: etcd-ca cert: secret: name: etcd-client-cert key: etcd-client keySecret: name: etcd-client-cert key: etcd-client-key ``` ### Prometheus High Availability (HA) For a basic HA setup, run multiple Prometheus replicas: ```yaml prometheus: prometheusSpec: replicas: 2 podAntiAffinity: "hard" externalLabels: cluster: prod-eu1 ``` Important notes: 1. `replicas` controls how many Prometheus pods are deployed for each shard. 2. Keep anti-affinity enabled (or hardened) to avoid scheduling all replicas on one node. 3. Do not clear replica/instance external labels in HA setups (`replicaExternalLabelNameClear` / `prometheusExternalLabelNameClear`), otherwise deduplication and alert/source identification become harder. 4. Querying replicas through a Kubernetes Service provides availability, but not sample deduplication across replicas by itself. For global/deduplicated querying, use a Thanos Query layer (or another backend that performs deduplication). See also Prometheus Operator HA guidance: - [Prometheus Operator HA docs](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/high-availability.md#prometheus) ### Multiple releases The same chart can be used to run multiple Prometheus instances in the same cluster if required. To achieve this, it is necessary to run only one instance of prometheus-operator and a pair of alertmanager pods for an HA configuration, while all other components need to be disabled. To disable a dependency during installation, set `kubeStateMetrics.enabled`, `nodeExporter.enabled` and `grafana.enabled` to `false`. ## Work-Arounds for Known Issues ### Running on private GKE clusters When Google configure the control plane for private clusters, they automatically configure VPC peering between your Kubernetes cluster’s network and a separate Google managed project. In order to restrict what Google are able to access within your cluster, the firewall rules configured restrict access to your Kubernetes pods. This means that in order to use the webhook component with a GKE private cluster, you must configure an additional firewall rule to allow the GKE control plane access to your webhook pod. You can read more information on how to add firewall rules for the GKE control plane nodes in the [GKE docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules) Alternatively, you can disable the hooks by setting `prometheusOperator.admissionWebhooks.enabled=false`. ### Argo CD The operator CRDs are larger than the 262144 byte limit on the `kubectl.kubernetes.io/last-applied-configuration` annotation β€” `crd-prometheuses.yaml` alone is around 840 KiB β€” so a client-side apply fails with `metadata.annotations: Too long`. Sync the application with `ServerSideApply=true`. ## PrometheusRules Admission Webhooks With Prometheus Operator version 0.30+, the core Prometheus Operator pod exposes an endpoint that will integrate with the `validatingwebhookconfiguration` Kubernetes feature to prevent malformed rules from being added to the cluster. ### How the Chart Configures the Hooks A validating and mutating webhook configuration requires the endpoint to which the request is sent to use TLS. It is possible to set up custom certificates to do this, but in most cases, a self-signed certificate is enough. The setup of this component requires some more complex orchestration when using helm. The steps are created to be idempotent and to allow turning the feature on and off without running into helm quirks. 1. A pre-install hook provisions a certificate into the same namespace using a format compatible with provisioning using end user certificates. If the certificate already exists, the hook exits. 2. The prometheus operator pod is configured to use a TLS proxy container, which will load that certificate. 3. Validating and Mutating webhook configurations are created in the cluster, with their failure mode set to Ignore. This allows rules to be created by the same chart at the same time, even though the webhook has not yet been fully set up - it does not have the correct CA field set. 4. A post-install hook reads the CA from the secret created by step 1 and patches the Validating and Mutating webhook configurations. This process will allow a custom CA provisioned by some other process to also be patched into the webhook configurations. The chosen failure policy is also patched into the webhook configurations ### Alternatives It should be possible to use [jetstack/cert-manager](https://github.com/jetstack/cert-manager) if a more complete solution is required, but it has not been tested. You can enable automatic self-signed TLS certificate provisioning via cert-manager by setting the `prometheusOperator.admissionWebhooks.certManager.enabled` value to true. ### Limitations Because the operator can only run as a single pod, there is potential for this component failure to cause rule deployment failure. Because this risk is outweighed by the benefit of having validation, the feature is enabled by default. ## Developing Prometheus Rules and Grafana Dashboards This chart Grafana Dashboards and Prometheus Rules are just a copy from [prometheus-operator/prometheus-operator](https://github.com/prometheus-operator/prometheus-operator) and other sources, synced (with alterations) by scripts in [hack](hack) folder. In order to introduce any changes you need to first [add them to the original repository](https://github.com/prometheus-operator/kube-prometheus/blob/main/docs/customizations/developing-prometheus-rules-and-grafana-dashboards.md) and then sync there by scripts. ## Further Information For more in-depth documentation of configuration options meanings, please see - [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator) - [Prometheus](https://prometheus.io/docs/introduction/overview/) - [Grafana](https://github.com/grafana/helm-charts/tree/main/charts/grafana#grafana-helm-chart) ## prometheus.io/scrape The prometheus operator does not support annotation-based discovery of services, using the `PodMonitor` or `ServiceMonitor` CRD in its place as they provide far more configuration options. For information on how to use PodMonitors/ServiceMonitors, please see the documentation on the `prometheus-operator/prometheus-operator` documentation here: - [ServiceMonitors](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/developer/getting-started.md#using-servicemonitors) - [PodMonitors](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/developer/getting-started.md#using-podmonitors) - [Running Exporters](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/user-guides/running-exporters.md) By default, Prometheus discovers PodMonitors and ServiceMonitors within its namespace, that are labeled with the same release tag as the prometheus-operator release. Sometimes, you may need to discover custom PodMonitors/ServiceMonitors, for example used to scrape data from third-party applications. An easy way of doing this, without compromising the default PodMonitors/ServiceMonitors discovery, is allowing Prometheus to discover all PodMonitors/ServiceMonitors within its namespace, without applying label filtering. To do so, you can set `prometheus.prometheusSpec.podMonitorSelectorNilUsesHelmValues` and `prometheus.prometheusSpec.serviceMonitorSelectorNilUsesHelmValues` to `false`. ## Migrating from stable/prometheus-operator chart ## Zero downtime Since `kube-prometheus-stack` is fully compatible with the `stable/prometheus-operator` chart, a migration without downtime can be achieved. However, the old name prefix needs to be kept. If you want the new name please follow the step by step guide below (with downtime). You can override the name to achieve this: ```console helm upgrade prometheus-operator prometheus-community/kube-prometheus-stack -n monitoring --reuse-values --set nameOverride=prometheus-operator ``` **Note**: It is recommended to run this first with `--dry-run --debug`. ## Redeploy with new name (downtime) If the **prometheus-operator** values are compatible with the new **kube-prometheus-stack** chart, please follow the below steps for migration: > The guide presumes that chart is deployed in `monitoring` namespace and the deployments are running there. If in other namespace, please replace the `monitoring` to the deployed namespace. 1. Patch the PersistenceVolume created/used by the prometheus-operator chart to `Retain` claim policy: ```console kubectl patch pv/ -p '{"spec":{"persistentVolumeReclaimPolicy":"Retain"}}' ``` **Note:** To execute the above command, the user must have a cluster wide permission. Please refer [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) 2. Uninstall the **prometheus-operator** release and delete the existing PersistentVolumeClaim, and verify PV become Released. ```console helm uninstall prometheus-operator -n monitoring kubectl delete pvc/ -n monitoring ``` Additionally, you have to manually remove the remaining `prometheus-operator-kubelet` service. ```console kubectl delete service/prometheus-operator-kubelet -n kube-system ``` You can choose to remove all your existing CRDs (ServiceMonitors, Podmonitors, etc.) if you want to. 3. Remove current `spec.claimRef` values to change the PV's status from Released to Available. ```console kubectl patch pv/ --type json -p='[{"op": "remove", "path": "/spec/claimRef"}]' -n monitoring ``` **Note:** To execute the above command, the user must have a cluster wide permission. Please refer to [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) After these steps, proceed to a fresh **kube-prometheus-stack** installation and make sure the current release of **kube-prometheus-stack** matching the `volumeClaimTemplate` values in the `values.yaml`. The binding is done via matching a specific amount of storage requested and with certain access modes. For example, if you had storage specified as this with **prometheus-operator**: ```yaml volumeClaimTemplate: spec: storageClassName: gp2 accessModes: ["ReadWriteOnce"] resources: requests: storage: 50Gi ``` You have to specify matching `volumeClaimTemplate` with 50Gi storage and `ReadWriteOnce` access mode. Additionally, you should check the current AZ of your legacy installation's PV, and configure the fresh release to use the same AZ as the old one. If the pods are in a different AZ than the PV, the release will fail to bind the existing one, hence creating a new PV. This can be achieved either by specifying the labels through `values.yaml`, e.g. setting `prometheus.prometheusSpec.nodeSelector` to: ```yaml nodeSelector: failure-domain.beta.kubernetes.io/zone: east-west-1a ``` or passing these values as `--set` overrides during installation. The new release should now re-attach your previously released PV with its content. ## Migrating from coreos/prometheus-operator chart The multiple charts have been combined into a single chart that installs prometheus operator, prometheus, alertmanager, grafana as well as the multitude of exporters necessary to monitor a cluster. There is no simple and direct migration path between the charts as the changes are extensive and intended to make the chart easier to support. The capabilities of the old chart are all available in the new chart, including the ability to run multiple prometheus instances on a single cluster - you will need to disable the parts of the chart you do not wish to deploy. You can check out the tickets for this change at [prometheus-operator/prometheus-operator #592](https://github.com/prometheus-operator/prometheus-operator/issues/592) and [helm/charts #6765](https://github.com/helm/charts/pull/6765). ### High-level overview of Changes #### Added dependencies The chart has added 3 [dependencies](#dependencies). - Node-Exporter, Kube-State-Metrics: These components are loaded as dependencies into the chart, and are relatively simple components - Grafana: The Grafana chart is more feature-rich than this chart - it contains a sidecar that is able to load data sources and dashboards from configmaps deployed into the same cluster. For more information check out the [documentation for the chart](https://github.com/grafana/helm-charts/blob/main/charts/grafana/README.md) #### Kubelet Service Because the kubelet service has a new name in the chart, make sure to clean up the old kubelet service in the `kube-system` namespace to prevent counting container metrics twice. #### Persistent Volumes If you would like to keep the data of the current persistent volumes, it should be possible to attach existing volumes to new PVCs and PVs that are created using the conventions in the new chart. For example, in order to use an existing Azure disk for a helm release called `prometheus-migration` the following resources can be created: ```yaml apiVersion: v1 kind: PersistentVolume metadata: name: pvc-prometheus-migration-prometheus-0 spec: accessModes: - ReadWriteOnce azureDisk: cachingMode: None diskName: pvc-prometheus-migration-prometheus-0 diskURI: /subscriptions/f5125d82-2622-4c50-8d25-3f7ba3e9ac4b/resourceGroups/sample-migration-resource-group/providers/Microsoft.Compute/disks/pvc-prometheus-migration-prometheus-0 fsType: "" kind: Managed readOnly: false capacity: storage: 1Gi persistentVolumeReclaimPolicy: Delete storageClassName: prometheus volumeMode: Filesystem ``` ```yaml apiVersion: v1 kind: PersistentVolumeClaim metadata: labels: app.kubernetes.io/name: prometheus prometheus: prometheus-migration-prometheus name: prometheus-prometheus-migration-prometheus-db-prometheus-prometheus-migration-prometheus-0 namespace: monitoring spec: accessModes: - ReadWriteOnce resources: requests: storage: 1Gi storageClassName: prometheus volumeMode: Filesystem volumeName: pvc-prometheus-migration-prometheus-0 ``` The PVC will take ownership of the PV and when you create a release using a persistent volume claim template it will use the existing PVCs as they match the naming convention used by the chart. For other cloud providers similar approaches can be used. #### KubeProxy The metrics bind address of kube-proxy is default to `127.0.0.1:10249` that prometheus instances **cannot** access to. You should expose metrics by changing `metricsBindAddress` field value to `0.0.0.0:10249` if you want to collect them. Depending on the cluster, the relevant part `config.conf` will be in ConfigMap `kube-system/kube-proxy` or `kube-system/kube-proxy-config`. For example: ```console kubectl -n kube-system edit cm kube-proxy ``` ```yaml apiVersion: v1 data: config.conf: |- apiVersion: kubeproxy.config.k8s.io/v1alpha1 kind: KubeProxyConfiguration # ... # metricsBindAddress: 127.0.0.1:10249 metricsBindAddress: 0.0.0.0:10249 # ... kubeconfig.conf: |- # ... kind: ConfigMap metadata: labels: app: kube-proxy name: kube-proxy namespace: kube-system ``` --- ### Overview (`charts/kube-state-metrics/README.md`) # kube-state-metrics Helm Chart Installs the [kube-state-metrics agent](https://github.com/kubernetes/kube-state-metrics). ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/kube-state-metrics` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `kube-state-metrics` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-state-metrics [flags] ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-state-metrics [flags] ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Migrating from stable/kube-state-metrics and kubernetes/kube-state-metrics You can upgrade in-place: 1. [upgrade](#upgrading-chart) your existing release name using the new chart repository ## Upgrading to v8.0.0 This version drops support for configuring `CiliumNetworkPolicy` as it is a vendor specific resource. In addition, the `networkPolicy.flavor` setting is no longer persistent and can be safely dropped as only Kubernetes `NetworkPolicy` resources are supported. ## Upgrading to v6.0.0 This version drops support for deprecated Pod Security Policy resources. ## Upgrading to v3.0.0 v3.0.0 includes kube-state-metrics v2.0, see the [changelog](https://github.com/kubernetes/kube-state-metrics/blob/release-2.0/CHANGELOG.md) for major changes on the application-side. The upgraded chart now the following changes: - Dropped support for helm v2 (helm v3 or later is required) - collectors key was renamed to resources - namespace key was renamed to namespaces ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments: ```console helm show values oci://ghcr.io/prometheus-community/charts/kube-state-metrics ``` ### Admission policy collectors kube-state-metrics v2.20.0 and later supports the following admission policy collectors. They use the `admissionregistration.k8s.io/v1` API and are opt-in in this chart to preserve compatibility with older Kubernetes versions and image overrides. | Collectors | Required Kubernetes version | | --- | --- | | `validatingadmissionpolicies`, `validatingadmissionpolicybindings` | [v1.30 or later](https://kubernetes.io/docs/reference/access-authn-authz/validating-admission-policy/) | | `mutatingadmissionpolicies`, `mutatingadmissionpolicybindings` | [v1.36 or later](https://kubernetes.io/docs/reference/access-authn-authz/mutating-admission-policy/) | Enable only the collectors supported by your cluster through `collectorsExtra` or `collectors`. For example, on Kubernetes v1.36 or later: ```yaml collectorsExtra: - mutatingadmissionpolicies - mutatingadmissionpolicybindings - validatingadmissionpolicies - validatingadmissionpolicybindings ``` On Kubernetes v1.30 through v1.35, enable only the two validating admission policy collectors. Do not enable these collectors when overriding the image to a kube-state-metrics version older than v2.20.0. These resources are cluster-scoped and require cluster-wide RBAC permissions. With the default RBAC settings, the chart adds `list` and `watch` permissions only for the selected collectors. If you manage RBAC separately, grant those permissions on the selected resources in the `admissionregistration.k8s.io` API group. ### kube-rbac-proxy You can enable `kube-state-metrics` endpoint protection using `kube-rbac-proxy`. By setting `kubeRBACProxy.enabled: true`, this chart will deploy one RBAC proxy container per endpoint (metrics & telemetry). To authorize access, authenticate your requests (via a `ServiceAccount` for example) with a `ClusterRole` attached such as: ```yaml apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: kube-state-metrics-read rules: - apiGroups: [ "" ] resources: ["services/kube-state-metrics"] verbs: - get ``` See [kube-rbac-proxy examples](https://github.com/brancz/kube-rbac-proxy/tree/master/examples/resource-attributes) for more details. ### auth-filter As an alternative to `kube-rbac-proxy`, `kube-state-metrics` can authenticate and authorize requests itself using its built-in `--auth-filter`. Set `authFilter.enabled: true` to add the `--auth-filter` flag and the `create` permissions on `tokenreviews` and `subjectaccessreviews` that the filter requires. Scrapers must then authenticate (for example via a `ServiceAccount` token) and be authorized to `get` the `kube-state-metrics` service. See the upstream [Authentication / Authorization](https://github.com/kubernetes/kube-state-metrics/blob/main/docs/README.md#protecting-metrics-endpoints) documentation for the scraper-side `ClusterRole` and `ClusterRoleBinding`. --- ### Overview (`charts/prom-label-proxy/README.md`) # prom-label-proxy A proxy that enforces a given label in a given PromQL query. **Homepage:** ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prom-label-proxy` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prom-label-proxy` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prom-label-proxy ``` _See [configuration](#configuration) below._ _See [`helm install`](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [`helm uninstall`](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prom-label-proxy ``` ### kube-rbac-proxy You can enable `prom-label-proxy` endpoint protection using `kube-rbac-proxy`. By setting `kubeRBACProxy.enabled: true`, this chart will deploy one RBAC proxy container for `config.listenAddress`. With the below example `values.yaml` : ```yaml config: upstream: http://prometheus:9090 extraArgs: - --enable-label-apis=true - --header-name=X-Namespace kubeRBACProxy: enabled: true config: authorization: rewrites: byHttpHeader: name: X-Namespace resourceAttributes: apiVersion: v1 resource: namespaces subresource: metrics namespace: "{{ .Value }}" ``` To authorize access, authenticate your requests (via a `ServiceAccount` for example) with a `Role` attached such as: ```yaml apiVersion: v1 kind: ServiceAccount metadata: name: tenant1-metrics-reader namespace: tenant1 --- apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: tenant1-metrics namespace: tenant1 rules: - apiGroups: [ '' ] resources: - namespaces/metrics verbs: [ "create", "get" ] --- --- apiVersion: rbac.authorization.k8s.io/v1 kind: RoleBinding metadata: name: tenant1-metrics-reader namespace: tenant1 roleRef: apiGroup: rbac.authorization.k8s.io kind: Role name: tenant1-metrics subjects: - kind: ServiceAccount name: tenant1-metrics-reader namespace: tenant1 ``` See [kube-rbac-proxy examples](https://github.com/brancz/kube-rbac-proxy/tree/master/examples/rewrites) for more details. --- ### Overview (`charts/prometheus-adapter/README.md`) # Prometheus Adapter Installs the [Prometheus Adapter](https://github.com/kubernetes-sigs/prometheus-adapter) for the Custom Metrics API. Custom metrics are used in Kubernetes by [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) to scale workloads based upon your own metric pulled from an external metrics provider like Prometheus. This chart complements the [metrics-server](https://github.com/helm/charts/tree/master/stable/metrics-server) chart that provides resource only metrics. ## Prerequisites Kubernetes 1.21+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-adapter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-adapter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Helm Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-adapter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Helm Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Helm Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ### To 5.0.0 This version removes support for the deprecated Kubernetes API `policy/v1beta1` for PodDisruptionBudgets. It also removes the deprecated `PodSecurityPolicy` resource. Minimum Kubernetes version >= 1.21 is now required. #### To 4.2.0 Readiness and liveness probes are now fully configurable through values `readinessProbe` and `livenessProbe`. The previous values have been kept as defaults. #### To 4.0.0 Previously, security context of the container was set directly in the deployment template. This release makes it configurable through the new configuration variable `securityContext` whilst keeping the previously set values as defaults. Furthermore, previous variable `runAsUser` is now set in `securityContext` and is not used any longer. Please, use `securityContext.runAsUser` instead. In the same security context, `seccompProfile` has been enabled and set to type `RuntimeDefault`. #### To 3.0.0 Due to a change in deployment labels, the upgrade requires `helm upgrade --force` in order to re-create the deployment. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-adapter ``` ### Prometheus Service Endpoint To use the chart, ensure the `prometheus.url` and `prometheus.port` are configured with the correct Prometheus service endpoint. If Prometheus is exposed under HTTPS the host's CA Bundle must be exposed to the container using `extraVolumes` and `extraVolumeMounts`. ### Adapter Rules Additionally, the chart comes with a set of default rules out of the box but they may pull in too many metrics or not map them correctly for your needs. Therefore, it is recommended to populate `rules.custom` with a list of rules (see the [config document](https://github.com/kubernetes-sigs/prometheus-adapter/blob/master/docs/config.md) for the proper format). ### Horizontal Pod Autoscaler Metrics Finally, to configure your Horizontal Pod Autoscaler to use the custom metric, see the custom metrics section of the [HPA walkthrough](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/#autoscaling-on-multiple-metrics-and-custom-metrics). The Prometheus Adapter can serve three different [metrics APIs](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-metrics-apis): ### Custom Metrics Enabling this option will cause custom metrics to be served at `/apis/custom.metrics.k8s.io/v1beta1`. Enabled by default when `rules.default` is true, but can be customized by populating `rules.custom`: ```yaml rules: custom: - seriesQuery: '{__name__=~"^some_metric_count$"}' resources: template: <<.Resource>> name: matches: "" as: "my_custom_metric" metricsQuery: sum(<<.Series>>{<<.LabelMatchers>>}) by (<<.GroupBy>>) ``` ### External Metrics Enabling this option will cause external metrics to be served at `/apis/external.metrics.k8s.io/v1beta1`. Can be enabled by populating `rules.external`: ```yaml rules: external: - seriesQuery: '{__name__=~"^some_metric_count$"}' resources: template: <<.Resource>> name: matches: "" as: "my_external_metric" metricsQuery: sum(<<.Series>>{<<.LabelMatchers>>}) by (<<.GroupBy>>) ``` ### Resource Metrics Enabling this option will cause resource metrics to be served at `/apis/metrics.k8s.io/v1beta1`. Resource metrics will allow pod CPU and Memory metrics to be used in [Horizontal Pod Autoscalers](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/) as well as the `kubectl top` command. Can be enabled by populating `rules.resource`: ```yaml rules: resource: cpu: containerQuery: | sum by (<<.GroupBy>>) ( rate(container_cpu_usage_seconds_total{container!="",<<.LabelMatchers>>}[3m]) ) nodeQuery: | sum by (<<.GroupBy>>) ( rate(node_cpu_seconds_total{mode!="idle",mode!="iowait",mode!="steal",<<.LabelMatchers>>}[3m]) ) resources: overrides: node: resource: node namespace: resource: namespace pod: resource: pod containerLabel: container memory: containerQuery: | round(sum by (<<.GroupBy>>) ( avg_over_time(container_memory_working_set_bytes{container!="",<<.LabelMatchers>>}[3m]) )) nodeQuery: | round(sum by (<<.GroupBy>>) ( avg_over_time(node_memory_MemTotal_bytes{<<.LabelMatchers>>}[3m]) - avg_over_time(node_memory_MemAvailable_bytes{<<.LabelMatchers>>}[3m]) )) resources: overrides: node: resource: node namespace: resource: namespace pod: resource: pod containerLabel: container window: 3m ``` **NOTE:** Setting a value for `rules.resource` will also deploy the resource metrics API service, providing the same functionality as [metrics-server](https://github.com/helm/charts/tree/master/stable/metrics-server). As such it is not possible to deploy them both in the same cluster. --- ### Overview (`charts/prometheus-blackbox-exporter/README.md`) # Prometheus Blackbox Exporter Prometheus exporter for blackbox testing Learn more: [https://github.com/prometheus/blackbox_exporter](https://github.com/prometheus/blackbox_exporter) This chart creates a Blackbox-Exporter deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.8+ with Beta APIs enabled - Helm >= 3.0 ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-blackbox-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-blackbox-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-blackbox-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 11.0.0 This version removes support for the deprecated Kubernetes API `extensions/v1beta1`, `networking.k8s.io/v1beta1`, and `rbac.authorization.k8s.io/v1beta1`. and associated attributes. #### To 10.0.0 - `extraEnvFromSecret` got replaced with `extraEnvFrom` - `extraEnv` handling got changed to use k8s env definitions as list of maps #### To 9.0.0 This version remove pod security policy as it is deprecated. #### To 8.0.0 - The default image is set to `quay.io/prometheus/blackbox-exporter` instead `prom/blackbox-exporter` - `image.repository` is now split into `image.registry` and `image.repository`. For the old behavior, set `image.registry` to an empty string and only use `image.repository`. #### To 7.0.0 This version introduces the `securityContext` and `podSecurityContext` and removes `allowICMP`option. All previous values are setup as default. In case that you want to enable previous functionality for `allowICMP` you need to explicit enabled with the following configuration: ```yaml securityContext: readOnlyRootFilesystem: true allowPrivilegeEscalation: false capabilities: add: ["NET_RAW"] ``` #### To 6.0.0 This version introduces the relabeling field for the ServiceMonitor. All values in the list `additionalRelabeling` will now appear under `relabelings` instead of `metricRelabelings`. #### To 5.0.0 This version removes Helm 2 support. Also the ingress config has changed, so you have to adapt to the example in the values.yaml. #### To 4.0.0 This version create the service account by default and introduce pod security policy, it can be enabled by setting `pspEnabled: true`. #### To 2.0.0 This version removes the `podDisruptionBudget.enabled` parameter and changes the default value of `podDisruptionBudget` to `{}`, in order to fix Helm 3 compatibility. In order to upgrade, please remove `podDisruptionBudget.enabled` from your custom values.yaml file and set the content of `podDisruptionBudget`, for example: ```yaml podDisruptionBudget: maxUnavailable: 0 ``` #### To 1.0.0 This version introduce the new recommended labels. In order to upgrade, delete the Deployment before upgrading: ```bash kubectl delete deployment [RELEASE_NAME]-prometheus-blackbox-exporter ``` Note that this will cause downtime of the blackbox. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-blackbox-exporter ``` ### Binary protocol (TCP) modules (PostgreSQL, LDAP, etc.) If your module configuration requires binary send payloads β€” for example probing [PostgreSQL SSL negotiation](https://github.com/prometheus/blackbox_exporter/pull/1441) or [LDAP STARTTLS](https://github.com/prometheus/blackbox_exporter/issues/295) β€” you cannot configure them via the `config:` value in `values.yaml`. The contents of `config:` are passed through `toYaml` in the ConfigMap template, which round-trips the values through Helm's YAML parser, which decodes `!!binary` tags and re-encodes them as UTF-8 strings. Any byte β‰₯ `0x80` is silently corrupted or dropped. The failure only manifests at probe time as a cryptic byte-mismatch error, with no warning during `helm install` or `helm template`. **Workaround:** create the blackbox config as a Kubernetes Secret outside of Helm and reference it via `configExistingSecretName`: ```yaml configExistingSecretName: blackbox-binary-config ``` The Secret must contain a `blackbox.yaml` key: ```bash kubectl create secret generic blackbox-binary-config \ --from-file=blackbox.yaml=./blackbox.yaml ``` This bypasses the `toYaml` pipeline entirely and delivers the config verbatim. --- ### Overview (`charts/prometheus-cloudwatch-exporter/README.md`) # Prometheus Cloudwatch Exporter An exporter for [Amazon CloudWatch](http://aws.amazon.com/cloudwatch/), for Prometheus. This chart bootstraps a [cloudwatch exporter](http://github.com/prometheus/cloudwatch_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - [kube2iam](../../stable/kube2iam) installed to used the **aws.role** config option otherwise configure **aws.aws_access_key_id** and **aws.aws_secret_access_key** or **aws.secret.name** - Or an [IAM Role for service account](https://aws.amazon.com/blogs/opensource/introducing-fine-grained-iam-roles-service-accounts/) attached to a service account with an annotation. If you run the pod as nobody in `securityContext.runAsUser` then also set `securityContext.fsGroup` to the same value so it will be able to access to the mounted secret. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-cloudwatch-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-cloudwatch-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console # Helm 3 $ helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-cloudwatch-exporter # Helm 2 $ helm install --name [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-cloudwatch-exporter ``` _See [Configuring](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console # Helm 3 $ helm uninstall [RELEASE_NAME] # Helm 2 # helm delete --purge [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console # Helm 3 or 2 $ helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 $ helm inspect values oci://ghcr.io/prometheus-community/charts/prometheus-cloudwatch-exporter # Helm 3 $ helm show values oci://ghcr.io/prometheus-community/charts/prometheus-cloudwatch-exporter ``` ### AWS Credentials or Role For Cloudwatch Exporter to operate properly, you must configure either AWS credentials or an AWS role with the [correct policy](https://github.com/prometheus/cloudwatch_exporter#credentials-and-permissions). - To configure AWS credentials by value, set `aws.aws_access_key_id` to your [AWS_ACCESS_KEY_ID], and `aws.aws_secret_access_key` to [AWS_SECRET_ACCESS_KEY]. - To configure AWS credentials by secret, you must store them in a secret (`kubectl create secret generic [SECRET_NAME] --from-literal=access_key=[AWS_ACCESS_KEY_ID] --from-literal=secret_key=[AWS_SECRET_ACCESS_KEY]`) and set `aws.secret.name` to [SECRET_NAME] - To configure an AWS role (with correct policy linked above), set `aws.role` to [ROLE_NAME] --- ### Overview (`charts/prometheus-conntrack-stats-exporter/README.md`) # Conntrack Stats Exporter Prometheus Conntrack Stats exporter for various metrics about Conntrack, written in Go. Learn more: This chart creates an Conntrack-Stats-Exporter daemonset on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.10+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-conntrack-stats-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-conntrack-stats-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-conntrack-stats-exporter ``` The command deploys Conntrack-Stats Exporter on the Kubernetes cluster using the default configuration. _See [configuration](#configuration) below._ _See [`helm install`](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [`helm uninstall`](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-conntrack-stats-exporter ``` > **Tip**: You can use the default [values.yaml](values.yaml) --- ### Overview (`charts/prometheus-consul-exporter/README.md`) # Prometheus Consul Exporter A Prometheus exporter for [Consul](https://www.consul.io/) metrics. This chart creates a [Consul Exporter](https://github.com/prometheus/consul_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.9+ with Beta APIs enabled - Helm 3 ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-consul-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-consul-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-consul-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### From 0.5.x to 1.0.0 Helm `apiVersion` has been increased to `v2` in version 1.0.0. As a result, Helm v3 is required to install the chart. Please, see notes on [migration from Helm v2 to Helm v3](https://helm.sh/docs/topics/v2_v3_migration/). ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-consul-exporter ``` ### Consul Server Info Set `consulServer` to `[MY_CONSUL_HOST]:[MY_CONSUL_PORT]`. ### Flags Check the [Flags](https://github.com/prometheus/consul_exporter#flags) list and add to the `options` block in your value overrides. --- ### Overview (`charts/prometheus-couchdb-exporter/README.md`) # prometheus-couchdb-exporter A Prometheus exporter for [CouchDB](https://couchdb.apache.org/) metrics. This chart bootstraps a [CouchDB Exporter](https://github.com/gesellix/couchdb-prometheus-exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Helm 3.7+ Helm v2 was no longer supported from chart version 1.0.0. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-couchdb-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-couchdb-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-couchdb-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 1.0.0 Helm v2 was no longer supported from chart version 1.0.0. _See [Migrating Helm v2 to v3](https://helm.sh/docs/topics/v2_v3_migration/) guide._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-couchdb-exporter ``` --- ### Overview (`charts/prometheus-druid-exporter/README.md`) # Prometheus Druid Exporter A Prometheus exporter for [Druid](https://druid.apache.org/) metrics. Installs the [Druid Exporter](https://github.com/opstree/druid-exporter) for [Prometheus](https://prometheus.io/). Some of the metrics collections are:- - Druid's health metrics - Druid's datasource metrics - Druid's segment metrics - Druid's supervisor metrics - Druid's tasks metrics - Druid's components metrics like:- broker, historical, ingestion(kafka), coordinator, sys ## Prerequisites - Kubernetes 1.16+ - Helm 3.7+ Helm v2 was no longer supported from chart version 1.0.0. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-druid-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-druid-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-druid-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 1.0.0 Helm v2 was no longer supported from chart version 1.0.0. _See [Migrating Helm v2 to v3](https://helm.sh/docs/topics/v2_v3_migration/) guide._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](https://github.com/prometheus-community/helm-charts/blob/main/charts/prometheus-druid-exporter/values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-druid-exporter ``` ### Druid Server Connection To use this chart, ensure that `druidURL` is populated with valid Druid URL. Basically this is the URL of druid router or coordinator service. An example could be:- ```console http://druid.opstreelabs.in ``` ### Service Monitor The chart comes with a ServiceMonitor for use with the [kube-pometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack). If you're not using the Prometheus Operator, you can disable the ServiceMonitor by setting `serviceMonitor.enabled` to `false` and it will auto generate the following `podAnnotations` into deployment.yaml: ```yaml podAnnotations: prometheus.io/path: /metrics prometheus.io/port: metrics prometheus.io/scrape: "true" ``` --- ### Overview (`charts/prometheus-elasticsearch-exporter/README.md`) # Prometheus Elasticsearch Exporter Prometheus exporter for various metrics about Elasticsearch, written in Go. For more information, please, see the project's [repository](https://github.com/prometheus-community/elasticsearch_exporter). This chart creates an Elasticsearch exporter deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Helm 3.7+ - Kubernetes 1.19+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-elasticsearch-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-elasticsearch-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Helm Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-elasticsearch-exporter ``` The command deploys Elasticsearch Exporter on the Kubernetes cluster using the default configuration. _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Helm Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Helm Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-elasticsearch-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ### To 7.0.0 In Release 7.0.0, the chart has dropped support for PodSecurityPolicy, which was remvoed in k8s 1.25. #### To 6.0.0 In release 6.0, the chart API version has been increased to v2. From now on, the chart supports Helm 3 only. The minimum Kubernetes version supported by the chart has been raised to 1.19. Labels and selectors have been replaced following [Helm 3 label and annotation best practices](https://helmsh/docs/chart_best_practices/labels/): | Previous | Current | |---------------------|------------------------------| | app | app.kubernetes.io/name | | chart | helm.sh/chart | | [none] | app.kubernetes.io/version | | heritage | app.kubernetes.io/managed-by | | release | app.kubernetes.io/instance | As the change is affecting immutable selector labels, the deployment must be deleted before upgrading the release, e.g.: ```console kubectl delete deploy -l app=prometheus-elasticsearch-exporter ``` Once the resources have been deleted, you can upgrade the release: ```console helm upgrade -i RELEASE_NAME prometheus-community/prometheus-elasticsearch-exporter ``` #### To 5.0.0 `securityContext` has been renamed to `podSecurityContext` and `securityContext.enabled` has no effect anymore. To mirror the behaviour of `securityContext.enabled=false` of 4.x unset `podSecurityContext`. ```console helm install --set podSecurityContext=null my-exporter stable/elasticsearch-exporter ``` In 5.0.0 `securityContext` refers to the container's securityContext instead which was not configurable in earlier versions. The naming is aligned with the base charts created by Helm. Default values for `podSecurityContext` and `securityContext` have been updated to be compatible with the Pod Security Standard level "restricted". Most notably `seccompProfile.type` is set to `RuntimeDefault`. #### To 4.0.0 While migrating the chart from `stable/elasticsearch-exporter` it was renamed to `prometheus-elasticsearch-exporter`. If you want to upgrade from a previous version and you need to keep the old resource names (`Service`, `Deployment`, etc) you can set `fullnameOverride` and `nameOverride` to do so. The example below shows how those values should be set for a `my-exporter` release of the previous chart. ```console helm install my-exporter stable/elasticsearch-exporter helm upgrade my-exporter . --set fullnameOverride=my-exporter-elasticsearch-exporter --set nameOverride=elasticsearch-exporter ``` #### To 3.0.0 `prometheusRule.rules` are now processed as Helm template, allowing to set variables in them. This means that if a rule contains a {{ $value }}, Helm will try replacing it and probably fail. You now need to escape the rules (see `values.yaml`) for examples. #### To 2.0.0 Some Kubernetes APIs used from 1.x have been deprecated. You need to update your cluster to Kubernetes 1.10+ to support new definitions used in 2.x. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-elasticsearch-exporter ``` > **Tip**: You can use the default [values.yaml](values.yaml) --- ### Overview (`charts/prometheus-fastly-exporter/README.md`) # Prometheus Fastly Exporter A Prometheus exporter for [Fastly](https://fastly.com/) metrics. This chart creates a [Fastly Exporter](https://github.com/fastly/fastly-exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.8+ with Beta APIs enabled ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-fastly-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-fastly-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-fastly-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ### Fastly token To use the chart, ensure the `fastly.token` is populated with a valid [Fastly API token](https://docs.fastly.com/guides/account-management-and-security/using-api-tokens#creating-api-tokens) or an existing secret (in the releases namespace) containing the key defined on `existingSecret.key`, with the token is referred via `existingSecret.name`. If no secret key is defined, the default value is `fastly-api-token`. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-fastly-exporter ``` ### Flags Check the filtering [Flags](https://github.com/fastly/fastly-exporter#filtering-services) list and add to the `options` block in your value overrides. --- ### Overview (`charts/prometheus-ipmi-exporter/README.md`) # Prometheus IPMI Exporter A Prometheus exporter for *IP Management Interface* metrics. This chart creates a [IPMI Exporter](https://github.com/prometheus-community/ipmi_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.33+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-ipmi-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-ipmi-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-ipmi-exporter ``` *See [configuration](#configuration) below.* *See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation.* ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. *See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation.* ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` *See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation.* ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-ipmi-exporter ``` ### ScrapeConfig vs ServiceMonitor This chart supports both ServiceMonitor (v1) and ScrapeConfig (v1alpha1) from prometheus-operator. **ScrapeConfig** is recommended for: - Scraping IPMI targets in remote mode (exporter as a proxy) - Using file-based service discovery - More flexibility with relabeling **Example - Remote IPMI scraping:** ```yaml scrapeConfig: enabled: true mode: remote # Uses /ipmi endpoint with target relabeling staticConfigs: - targets: - 192.168.1.10 - 192.168.1.11 ``` **Example - Local exporter metrics:** ```yaml scrapeConfig: enabled: true mode: local # Uses /metrics endpoint directly staticConfigs: - targets: - ipmi-exporter:9290 ``` --- ### Overview (`charts/prometheus-json-exporter/README.md`) # prometheus-json-exporter Prometheus exporter for scraping JSON by JSONPath. This chart bootstraps a [json_exporter](https://github.com/prometheus-community/json_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.10+ with Beta APIs enabled - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-json-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-json-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-json-exporter ``` _See [configuration](## Configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` #### From 0.7.x to 0.8.0 This version fixes configmap name according to the chart standard so that configmap will be recreated with subsequent deployment rollout. See [#3926](https://github.com/prometheus-community/helm-charts/pull/3926) for more context. ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-json-exporter ``` For more information please refer to the [json_exporter](https://github.com/prometheus-community/json_exporter) documentation. --- ### Overview (`charts/prometheus-kafka-exporter/README.md`) # Prometheus Kafka Exporter A Prometheus exporter for [Apacher Kafka](https://kafka.apache.org/) metrics. This chart bootstraps a [Kafka Exporter](https://github.com/danielqsj/kafka_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.25+ - Helm 3 Helm v2 is no longer supported from chart version 2.0.0. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-kafka-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-kafka-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-kafka-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-kafka-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-kafka-exporter/values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-kafka-exporter ``` ### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. #### 2.x to 3.x From version 3.0.0, support for pod security policies was removed. The minimum Kubernetes version required by the helm chart is 1.25. --- ### Overview (`charts/prometheus-memcached-exporter/README.md`) # prometheus-memcached-exporter Prometheus exporter for [Memcached](https://memcached.org/) metrics. This chart bootstraps a [Memcached exporter](https://github.com/prometheus/memcached_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.25+ - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-memcached-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-memcached-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-memcached-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-memcached-exporter ``` For more information please refer to the [Memcached exporter](https://github.com/prometheus/memcached_exporter) documentation. --- ### Overview (`charts/prometheus-modbus-exporter/README.md`) # prometheus-modbus-exporter Prometheus exporter for scraping metrics via modbus based protocol. ## Intro This chart bootstraps a [modbus_exporter](https://github.com/RichiH/modbus_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. The serviceMonitor objects are created for Prometheus Operator. ## Configuration The configuration of the modbus_exporter can be provided either via helm's custom values, or via an already existing (independently managed) configMap. Either way, every time the configuration is getting updated, the modbus_exporter is getting restarted in order to fetch it. This is done using sidecar reloader: . ## Tests This setup has been tested with both real unit (Janitza Power Analizer UMG series) as well as using an simulator . Other simulators (fully free) exist as well: 1. the one included as part of the test (fake server) in the , which uses (Go). 2. Many others, like pymodslave, based on py module: , which has its own demo simulator as well. ## Notes There are 4 types of read registries, hence 4 read function codes (1,2,3,4). Don't forget to prefix (first digit) your registry with the required function. Your address should be always 6 digits. E.g. for holding registry 22, the address is: 300022 (where the 3 denotes the holding registry function). More on Modbus function codes: ## Prerequisites - Kubernetes 1.10+ with Beta APIs enabled - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-modbus-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-modbus-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-modbus-exporter ``` _See [configuration](## Configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-modbus-exporter ``` For more information please refer to the [modbus_exporter](https://github.com/RichiH/modbus_exporter) documentation. --- ### Overview (`charts/prometheus-mongodb-exporter/README.md`) # Prometheus MongoDB Exporter A Prometheus exporter for [MongoDB](https://www.mongodb.com/) metrics. Installs the [MongoDB Exporter](https://github.com/percona/mongodb_exporter) for [Prometheus](https://prometheus.io/). The MongoDB Exporter collects and exports oplog, replica set, server status, sharding and storage engine metrics. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-mongodb-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-mongodb-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-mongodb-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. ##### From 2.x to 3.x This version uses the original percona/mongodb_exporter Docker image again, as described in the readme and Chart.yaml. It's maintained and it uses frequent Docker builds, so this is preferable for security reasons. The commnad arguments of the exporter have changed. If you have custom `extraArgs` settings you have to adjust them. Because of the newer version of the exporter image metrics may varry though, so you might need to adjust your dashboard querries or try out the "--compatible-mode" parameter in `extraArgs`. The `mongodb.uri` variable got "mongodb://monogdb:27017" as default parameter. Chart API was raisded to v2, so Helm 2 is not supported anymore. The servicemonitor has been disabled by default as prometheus operator might not be installed in cluster. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-mongodb-exporter ``` ### MongoDB Server Connection To use the chart, ensure the `mongodb.uri` is populated with a valid [MongoDB URI](https://docs.mongodb.com/manual/reference/connection-string) or an existing secret (in the releases namespace) containing the key defined on `existingSecret.key`, with the URI is referred via `existingSecret.name`. If no secret key is defined, the default value is `mongodb-uri`. If the MongoDB server requires authentication, credentials should be populated in the connection string as well. The MongoDB Exporter supports connecting to either a MongoDB replica set member, shard, or standalone instance. ### Service Monitor The chart comes with a ServiceMonitor for use with the [Prometheus Operator](https://github.com/helm/charts/tree/master/stable/prometheus-operator). By default, the ServiceMonitor is disabled. You can enable the ServiceMonitor by setting `serviceMonitor.enabled` to `true`. For the ServiceMonitor to be detected by the Prometheus Operator, you must add the selector label to `serviceMonitor.additionalLabels`. You can find this label under `spec.serviceMonitorSelector` of the Prometheus CRD. If you're not using the Prometheus Operator, you can instead populate the `podAnnotations` as below: ```yaml podAnnotations: prometheus.io/scrape: "true" prometheus.io/port: "metrics" ``` --- ### Overview (`charts/prometheus-mysql-exporter/README.md`) # Prometheus MySQL Exporter A Prometheus exporter for [MySQL](https://www.mysql.com/) metrics. This chart bootstraps a Prometheus [MySQL Exporter](https://github.com/prometheus/mysqld_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-mysql-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-mysql-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-mysql-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` #### Multiple-target probes mysql_exporter now support multi-target probes using the `/probe` route. To enable this feature, set `serviceMonitor.multipleTarget.enabled` to `true` and define your targets in `serviceMonitor.multipleTarget.targets`. Credentials for each target should be referenced either in targets section or in the associated config file. As an example, for a config file with two targets: ```yaml serviceMonitor: multipleTarget: enabled: true targets: - endpoint: mysql1.dns.local name: mysql1 port: 3307 user: user1 password: password1 - endpoint: mysql2.dns.local name: mysql2 user: user2 password: password2 ``` In case of Config file Target name should match the entry in the config file. Config file example for the above targets: ```cnf [client] user=NOT_USED password=NOT_USED [client.mysql1] user=user1 password=password1 [client.mysql2] user=user2 password=password2 ``` The configuration file can be: - referenced using `mysql.existingConfigSecret`; - created automatically in case user and password are specified for the target. If all your target use the same credentials, you can set `serviceMonitor.sharedSecret.enabled` to `true` and define the key name in `serviceMonitor.sharedSecret.name`. #### From 1.x to 2.x mysqld_exporter has been updated to [v0.15.0](https://github.com/prometheus/mysqld_exporter/releases/tag/v0.15.0), removing support for `DATA_SOURCE_NAME`. Configuration for exporter use `--config.my-cnf` with a custom cnf file (secret). If you use `mysql.existingSecret` to set full `DATA_SOURCE_NAME`, please set `mysql.existingConfigSecret.name` & `mysql.existingConfigSecret.key` to reference the secret config. ```yaml mysql: existingSecret: "my-data-source" ``` to: ```yaml mysql: existingConfigSecret: name: "config" key: "my.cnf" ``` If you use `mysql.param` to extend `DATA_SOURCE_NAME`, please set `mysql.additionalConfig` with extra params to extend my.cnf file. ```yaml mysql: param: "debug&connect-timeout=5" ``` to: ```yaml mysql: additionalConfig: - connect-timeout=5 - debug ``` This version uses [cloud-sql-proxy v2](https://github.com/GoogleCloudPlatform/cloud-sql-proxy/blob/main/migration-guide.md). If you use `cloudsqlproxy.ipAddressTypes` to set private connections, please set `cloudsqlproxy.privateIp`. ```yaml cloudsqlproxy: ipAddressTypes: PRIVATE,PUBLIC ``` to: ```yaml cloudsqlproxy: privateIp: true ``` #### To =< 1.0.0 Version 1.0.0 is a major update. - The chart now follows the new Kubernetes label recommendations: The simplest way to update is to do a force upgrade, which recreates the resources by doing a delete and an install. ```console helm upgrade prometheus-mysql-exporter prometheus-community/prometheus-mysql-exporter --force ``` ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](https://github.com/prometheus-community/helm-charts/blob/main/charts/prometheus-mysql-exporter/values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-mysql-exporter ``` ### MySQL Connection The exporter can connect to MySQL directly or using the [Cloud SQL Proxy](https://cloud.google.com/sql/docs/mysql/sql-proxy). - To configure direct MySQL connection by value, set `mysql.user`, `mysql.pass`, `mysql.host` and `mysql.port` (see additional options in the `mysql` configuration block) - To configure direct MySQL connection by secret, you must store a connection string in a secret, and set `mysql.existingSecret` to `[SECRET_NAME]` ### Exporter Documentation and Params Documentation for the MySQL Exporter can be found here: () A MySQL params overview can be found here: () ### Collector Flags Available collector flags can be found in the [values.yaml](https://github.com/prometheus-community/helm-charts/blob/main/charts/prometheus-mysql-exporter/values.yaml) and a description of each flag can be found in the [mysqld_exporter](https://github.com/prometheus/mysqld_exporter#collector-flags) repository. ### CloudSql Proxy Workload Identity Enable it with flag [`cloudsqlproxy.workloadIdentity`](https://github.com/prometheus-community/helm-charts/blob/main/charts/prometheus-mysql-exporter/values.yaml) To more details about Workload Identity visit [Use Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) ### Extra Manifests This chart supports deploying extra Kubernetes manifests alongside the MySQL exporter. This can be useful for creating additional resources like ConfigMaps, Secrets, or other Kubernetes objects. The `extraManifests` value supports two formats and is evaluated as a template, allowing you to use Helm template functions and access values like `.Release.Name`, `.Release.Namespace`, `.Chart.Name`, etc. #### Object Format (Recommended) Provides better IDE support, validation, and readability: ```yaml extraManifests: - apiVersion: v1 kind: ConfigMap metadata: name: "{{ .Release.Name }}-extra-config" namespace: "{{ .Release.Namespace }}" labels: app: "{{ .Chart.Name }}" data: extra-data: "value" - apiVersion: v1 kind: Secret metadata: name: "{{ .Release.Name }}-extra-secret" type: Opaque stringData: key: "secret-value" ``` #### String Format (Alternative) Uses YAML multiline strings with pipe `|`: ```yaml extraManifests: - | apiVersion: v1 kind: ConfigMap metadata: name: mysql-exporter-extra data: key: value - | apiVersion: v1 kind: Secret metadata: name: mysql-exporter-secret type: Opaque stringData: password: "{{ .Values.mysql.pass }}" ``` Both formats can be mixed in the same `extraManifests` array if needed. --- ### Overview (`charts/prometheus-nats-exporter/README.md`) # Prometheus NATS Exporter An Prometheus Exporter for [NATS](https://github.com/nats-io/k8s) metrics. This chart bootstraps a prometheus [NATS Exporter](https://github.com/nats-io/prometheus-nats-exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-nats-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-nats-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console # Helm 3 $ helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-nats-exporter # Helm 2 $ helm install --name [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-nats-exporter ``` _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console # Helm 3 $ helm uninstall [RELEASE_NAME] # Helm 2 # helm delete --purge [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console # Helm 3 or 2 $ helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 $ helm inspect values oci://ghcr.io/prometheus-community/charts/prometheus-nats-exporter # Helm 3 $ helm show values oci://ghcr.io/prometheus-community/charts/prometheus-nats-exporter ``` --- ### Overview (`charts/prometheus-nginx-exporter/README.md`) # NGINX Prometheus Exporter This chart bootstraps a [NGINX Prometheus Exporter](https://github.com/nginxinc/nginx-prometheus-exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.19+ with Beta APIs enabled - Helm 3 ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-nginx-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-nginx-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`](https://helm.sh/docs/helm/helm_repo/) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-nginx-exporter ``` _See [configuration](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-nginx-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 1.0 Chart release 1.0 reflects a major bump of the default NGINX Exporter image tag from major number 0 to 1. This release has switched to using flags in the new format (`--flag`) but still supports the deprecated format (`-flag`) transparently for NGINX Exporter below release 1.0.0. ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-nginx-exporter ``` --- ### Overview (`charts/prometheus-node-exporter/README.md`) # Prometheus Node Exporter Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors. This chart bootstraps a Prometheus [Node Exporter](http://github.com/prometheus/node_exporter) daemonset on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-node-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-node-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-node-exporter ``` _See [configuration](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-node-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### 3.x to 4.x Starting from version 4.0.0, the `node exporter` chart is using the [Kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). Therefore you have to delete the daemonset before you upgrade. ```console kubectl delete daemonset -l app=prometheus-node-exporter helm upgrade -i prometheus-node-exporter prometheus-community/prometheus-node-exporter ``` If you use your own custom [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitor) or [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmonitor), please ensure to upgrade their `selector` fields accordingly to the new labels. #### From 2.x to 3.x Change the following: ```yaml hostRootFsMount: true ``` to: ```yaml hostRootFsMount: enabled: true mountPropagation: HostToContainer ``` ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-node-exporter ``` ### kube-rbac-proxy You can enable `prometheus-node-exporter` endpoint protection using `kube-rbac-proxy`. By setting `kubeRBACProxy.enabled: true`, this chart will deploy a RBAC proxy container protecting the node-exporter endpoint. To authorize access, authenticate your requests (via a `ServiceAccount` for example) with a `ClusterRole` attached such as: ```yaml apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: prometheus-node-exporter-read rules: - apiGroups: [ "" ] resources: ["services/node-exporter-prometheus-node-exporter"] verbs: - get ``` See [kube-rbac-proxy examples](https://github.com/brancz/kube-rbac-proxy/tree/master/examples/resource-attributes) for more details. --- ### Overview (`charts/prometheus-operator-admission-webhook/README.md`) # Prometheus Operator Admission Webhook > The admission webhook service is able to > > - Validate requests ensuring that PrometheusRule and AlertmanagerConfig objects are semantically valid > - Mutate requests enforcing that all annotations of PrometheusRule objects are coerced into string values > - Convert AlertmanagerConfig objects between v1alpha1 and v1beta1 versions For more info, please, see the [Prometheus Operator](https://prometheus-operator.dev/docs) documentation. ## Prerequisites - Kubernetes 1.13+ with Beta APIs enabled - Helm 3 ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-operator-admission-webhook` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-operator-admission-webhook` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-operator-admission-webhook ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-operator-admission-webhook --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-operator-admission-webhook ``` --- ### Overview (`charts/prometheus-operator-crds/README.md`) # Prometheus Operator CRDs This chart brings Custom Resource Definitions (CRD) used by Prometheus Operator introducing the API group `monitoring.coreos.com`. The Prometheus Operator uses Kubernetes custom resources to simplify the deployment and configuration of Prometheus, Alertmanager and related monitoring components. For more information on Prometheus Operator and CRDs, please, see [documentation](https://prometheus-operator.dev/docs/operator/design/). ## Prerequisites - Kubernetes >= 1.16.0 - Helm 3 ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-operator-crds` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-operator-crds` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-operator-crds ``` _See [configuration](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release _including_ resources of Kind `Prometheus`, `Alertmanager`, `ServiceMonitor`, etc. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Upgrading to v6.0.0 The upgraded chart now the following changes: - `annotations` value has moved to `crds.annotations` ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-operator-crds ``` --- ### Overview (`charts/prometheus-pgbouncer-exporter/README.md`) # Prometheus PgBouncer Exporter Prometheus exporter for [PgBouncer](https://www.pgbouncer.org/) server metrics. This chart bootstraps a prometheus [pgbouncer exporter](https://github.com/prometheus-community/pgbouncer_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.16+ - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-pgbouncer-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-pgbouncer-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-pgbouncer-exporter ``` _See [configuration](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-pgbouncer-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-pgbouncer-exporter ``` --- ### Overview (`charts/prometheus-pingdom-exporter/README.md`) # Prometheus Pingdom Exporter - **Source:** The [prometheus-pingdom-exporter](https://github.com/kokuwaio/pingdom-exporter) processes [Pingdom](https://www.pingdom.com/) uptime check results for consumption by Prometheus. ## Prerequisites - Kubernetes 1.16+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-pingdom-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-pingdom-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-pingdom-exporter ``` ```markdown _See [configuration](#configuration) below._ ``` _See [`helm install`](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [`helm uninstall`](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To version 3.0.0 The Docker image has been change too . The config uses `pingdom.apiToken` only which is used as env var. The Docker port changed to `9158`. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-pingdom-exporter ``` --- ### Overview (`charts/prometheus-pingmesh-exporter/README.md`) # Prometheus Pingmesh Exporter [pingmesh architecture](https://kubeservice.cn/2022/10/21/devops-k8s-pingmesh/) An Prometheus exporter that exposes information from ping message. This chart creates a [Pingmesh Exporter](https://github.com/kubeservice-stack/pingmesh-agent) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.8+ with Beta APIs enabled ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-pingmesh-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-pingmesh-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-pingmesh-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### From 0.22.0 to 1.0.1 ```console helm upgrade [RELEASE_NAME] prometheus-pingmesh-exporter --version 1.0.1 ``` ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 $ helm inspect values oci://ghcr.io/prometheus-community/charts/prometheus-pingmesh-exporter # Helm 3 $ helm show values oci://ghcr.io/prometheus-community/charts/prometheus-pingmesh-exporter ``` See [kubeservice-stack/pingmesh-agent/README.md](https://github.com/kubeservice-stack/pingmesh-agent) for further information. ## pingmesh pinglist configuration ```console setting: # the maximum amount of concurrent to ping, uint concurrent_limit: 20 # interval to exec ping in seconds, float interval: 60.0 # The maximum delay time to ping in milliseconds, float delay: 200 # ping timeout in seconds, float timeout: 2.0 # send ip addr source_ip_addr: 0.0.0.0 # send ip protocal ip_protocol: ip6 mesh: add-ping-public: name: ping-public-demo type: OtherIP ips : - 127.0.0.1 - 8.8.8.8 - kubernetes.default.svc.cluster.local ``` --- ### Overview (`charts/prometheus-postgres-exporter/README.md`) # Prometheus Postgres Exporter Prometheus exporter for [PostgreSQL](https://www.postgresql.org/about/servers/) server metrics. This chart bootstraps a Prometheus [Postgres exporter](https://github.com/prometheus-community/postgres_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.16+ - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-postgres-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-postgres-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-postgres-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-postgres-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 8.0.0 The hardcoded fallback password previously baked into the generated `Secret` when `config.datasource.password` was unset has been removed. The chart now fails at render time if no password source is configured. Before upgrading, set exactly one of the following: - `config.datasource.password` (templated with `tpl`) - `config.datasource.passwordFile` - `config.datasource.passwordSecret` (reference to an existing `Secret`) - `config.datasourceSecret` (reference to an existing `Secret` providing the full data source URI) Releases that previously installed without a password were producing a `Secret` containing a known plaintext value and an exporter that could not authenticate; configuring one of the options above is required to upgrade. #### To 7.0.0 Labels and selectors have been replaced following [Helm 3 label and annotation best practices](https://helmsh/docs/chart_best_practices/labels/): | Previous | Current | |---------------------|------------------------------| | app | app.kubernetes.io/name | | chart | helm.sh/chart | | [none] | app.kubernetes.io/version | | heritage | [none] | | release | app.kubernetes.io/instance | As the change is affecting immutable selector labels, the deployment must be deleted before upgrading the release, e.g.: ```console kubectl delete deploy -l app=prometheus-postgres-exporter --cascade=orphan ``` Once the resources have been deleted, you can upgrade the release: ```console helm upgrade -i RELEASE_NAME prometheus-community/prometheus-postgres-exporter ``` #### To 6.0.0 Image repository has been split into two values: the new `image.registry` value and the already existing `image.repository` value. No change is required when using the default for `image.repository`. If you have previously modified field `image.repository`, please, set the two fields accordingly. #### To 5.0.0 Deprecated options `auto-discover-databases`, `constantLabels`, `exclude-databases` & `include-databases` has been removed. Deprecated custom query config has been removed. Deprecated PodSecurityPolicy and K8S beta API versions have been removed. Chart.yaml appVersion field is used as default image tag. Labels are templated now. Add default securityContext and PodSecurityContext. LivenessProbe timeout has been raised to 3. #### To 4.6.0 This release adds functionality to template the variables inside `config.datasource` by means of allowing the `tpl` function in the resources that make use of it. This functionality is useful when you want to do sub-charting (e.g. in a postgres chart) and you want to avoid the duplication of variables inside `config.datasource`. Compared to the previous release (4.5.0) the only thing that changed is the fact that you can no longer leave the `config.datasource.host` variable blank. Leaving it blank could cause errors with the `tpl` function. However, the default value was changed to `''` so this error is not expected to happen. #### To 4.0.0 This release removes the `pg_database` query from `config.queries` as it has been converted to a built-in collector in postgres_exporter v0.11.0. Any customizations to the removed query are now rendered useless and thus should be removed. #### To 3.0.0 This release introduces changes to accommodate Postgres 13 or newer versions by default. Older Postgres instances have now to overwrite the `pg_stat_statements` query of `config.queries` with following selection: ```postgresql SELECT t2.rolname, t3.datname, queryid, calls, total_time / 1000 as total_time_seconds, min_time / 1000 as min_time_seconds, max_time / 1000 as max_time_seconds, mean_time / 1000 as mean_time_seconds, stddev_time / 1000 as stddev_time_seconds, rows, shared_blks_hit, shared_blks_read, shared_blks_dirtied, shared_blks_written, local_blks_hit, local_blks_read, local_blks_dirtied, local_blks_written, temp_blks_read, temp_blks_written, blk_read_time / 1000 as blk_read_time_seconds, blk_write_time / 1000 as blk_write_time_seconds FROM pg_stat_statements t1 JOIN pg_roles t2 ON (t1.userid = t2.oid) JOIN pg_database t3 ON (t1.dbid = t3.oid) WHERE t2.rolname != 'rdsadmin' AND queryid IS NOT NULL ` ``` #### To 2.0.0 The primary change in 2.0.0 is the Chart API from v1 to v2. This now requires Helm3. Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 2.0.0. The following example assumes that the release name is prometheus-postgres-exporter: ```console kubectl patch deployment prometheus-postgres-exporter --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]' ``` ## Configuration This chart can scrape metrics using either a [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitor) (`serviceMonitor.enabled`) or a [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmonitor) (`podMonitor.enabled`) for the Prometheus Operator. Use PodMonitor when scraping pods directly without going through the Kubernetes Service. See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run this command: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-postgres-exporter ``` --- ### Overview (`charts/prometheus-pushgateway/README.md`) # Prometheus Pushgateway This chart bootstraps a Prometheus [Pushgateway](http://github.com/prometheus/pushgateway) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. An optional prometheus `ServiceMonitor` can be enabled, should you wish to use this gateway with [Prometheus Operator](https://github.com/coreos/prometheus-operator). ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-pushgateway` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-pushgateway` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-pushgateway ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-pushgateway --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 3.0.0 Previously, as dynamic labels were also set on the statefulset's volume claim template, it was not possible to upgrade a chart release in a usual manner whilst using a statefulset and persistence due to the volume claim template's fields being immutable. This release removes the dynamic labels from the statefulset's volume claim template. If you have configured a statefulset with persistent storage, please, delete the statefulset before upgrading: ```console kubectl delete sts -l app.kubernetes.io/name=prometheus-pushgateway --cascade=orphan ``` #### To 2.0.0 Chart API version has been upgraded to v2 so Helm 3 is needed from now on. Docker image tag is used from Chart.yaml appVersion field by default now. Version 2.0.0 also adapted [Helm label and annotation best practices](https://helm.sh/docs/chart_best_practices/labels/). Specifically, labels mapping is listed below: ```console OLD => NEW ---------------------------------------- heritage => app.kubernetes.io/managed-by chart => helm.sh/chart [container version] => app.kubernetes.io/version app => app.kubernetes.io/name release => app.kubernetes.io/instance ``` Therefore, depending on the way you've configured the chart, the previous StatefulSet or Deployment need to be deleted before upgrade. If `runAsStatefulSet: false` (this is the default): ```console kubectl delete deploy -l app=prometheus-pushgateway ``` If `runAsStatefulSet: true`: ```console kubectl delete sts -l app=prometheus-pushgateway ``` After that do the actual upgrade: ```console helm upgrade -i prometheus-pushgateway prometheus-community/prometheus-pushgateway ``` ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-pushgateway ``` --- ### Overview (`charts/prometheus-rabbitmq-exporter/README.md`) # prometheus-rabbitmq-exporter Prometheus Exporter for [RabbitMQ](https://www.rabbitmq.com/) metrics. This chart bootstraps a [RabbitMQ Exporter](https://github.com/kbudde/rabbitmq_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## DEPRECATION WARNING The exporter used in this chart is deprecated and will not receive further updates! See: ## Prerequisites - Kubernetes 1.8+ with Beta APIs enabled ## Get Repository Info ```console helm repo add prometheus-community https://prometheus-community.github.io/helm-charts helm repo update ``` _See [`helm repo`](https://helm.sh/docs/helm/helm_repo/) for command documentation._ ## Install Chart ```console # Helm 3 $ helm install [RELEASE_NAME] prometheus-community/prometheus-rabbitmq-exporter # Helm 2 $ helm install --name [RELEASE_NAME] prometheus-community/prometheus-rabbitmq-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ## Uninstall Chart ```console # Helm 3 $ helm uninstall [RELEASE_NAME] # Helm 2 # helm delete --purge [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ## Upgrading Chart ```console # Helm 3 or 2 $ helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ### To 2.0.0 From 2.0.0 rabbit exporter is using the prometheus-rabbit-exporter image 1.0.0. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 $ helm inspect values prometheus-community/prometheus-rabbitmq-exporter # Helm 3 $ helm show values prometheus-community/prometheus-rabbitmq-exporter ``` ### RabbitMQ Connection - To configure RabbitMQ connection by value, set `rabbitmq.url`, `rabbitmq.user` and `rabbitmq.password` (see additional options in the `rabbitmq` configuration block) - To configure RabbitMQ password by secret, you must store the password string in a secret, and set `rabbitmq.existingPasswordSecret` to `[SECRET_NAME]` --- ### Overview (`charts/prometheus-redis-exporter/README.md`) # prometheus-redis-exporter Prometheus exporter for [Redis](https://redis.io/) metrics. This chart bootstraps a [Redis exporter](https://github.com/oliver006/redis_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.10+ with Beta APIs enabled - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-redis-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-redis-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-redis-exporter ``` _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 5.0.0 From 5.0.0 redis exporter is using the [Kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/). Therefore you have to delete the deployment before you upgrade. ```console kubectl delete deployment -l app=prometheus-redis-exporter helm upgrade -i prometheus-redis-exporter prometheus-community/prometheus-redis-exporter ``` From 5.0.0 redis exporter helm chart supports multiple targets. By enabling `serviceMonitor.multipleTarget` and settings the targets in `serviceMonitor.targets`, multiple redis instance can be scraped. ```yaml serviceMonitor: enabled: true multipleTarget: true telemetryPath: /scrape targets: - url: redis://my-redis:6379 name: foo - url: redis://my-redis-cluster:6379 name: bar additionalRelabeling: - sourceLabels: [type] targetLabel: type replacement: cluster ``` #### To 3.0.1 The default tag for the exporter image is now `v1.x.x`. This major release includes changes to the names of various metrics and no longer directly supports the configuration (and scraping) of multiple redis instances; that is now the Prometheus server's responsibility. You'll want to use [this dashboard](https://github.com/oliver006/redis_exporter/blob/master/contrib/grafana_prometheus_redis_dashboard.json) now. Please see the [redis_exporter GitHub page](https://github.com/oliver006/redis_exporter#upgrading-from-0x-to-1x) for more details. ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-redis-exporter ``` For more information please refer to the [redis_exporter](https://github.com/oliver006/redis_exporter) documentation. ### Redis Connection - To configure Redis connection by value set `redisAddress` string (example format: `redis://myredis:6379`) - To configure Redis connection by configmap set `redisAddressConfig.enabled` to `true`, set `redisAddressConfig.configmap.name` and `redisAddressConfig.configmap.key` values - To configure auth by value, set `auth.enabled` to `true`, and `auth.redisPassword` value - To configure auth by secret, set `auth.secret.name` and `auth.secret.key` values ### Using a custom LUA-Script First, you need to deploy the script with a configmap. This is an example script from mentioned in the [redis_exporter-image repository](https://github.com/oliver006/redis_exporter/blob/master/contrib/sample_collect_script.lua) ```yaml apiVersion: v1 kind: ConfigMap metadata: name: prometheus-redis-exporter-script data: script: |- -- Example collect script for -script option -- This returns a Lua table with alternating keys and values. -- Both keys and values must be strings, similar to a HGETALL result. -- More info about Redis Lua scripting: https://redis.io/commands/eval local result = {} -- Add all keys and values from some hash in db 5 redis.call("SELECT", 5) local r = redis.call("HGETALL", "some-hash-with-stats") if r ~= nil then for _,v in ipairs(r) do table.insert(result, v) -- alternating keys and values end end -- Set foo to 42 table.insert(result, "foo") table.insert(result, "42") -- note the string, use tostring() if needed return result ``` If you want to use this script for collecting metrics, you could do this by just set `script.configmap` to the name of the configmap (e.g. `prometheus-redis-exporter-script`) and `script.keyname` to the configmap-key holding the script (eg. `script`). The required variables inside the container will be set automatically. --- ### Overview (`charts/prometheus-smartctl-exporter/README.md`) # Prometheus smartctl Exporter Prometheus smartctl Exporter makes _smartctl_ statistics available to Prometheus for scraping. For more information on the exporter, please see the project's [repository](https://github.com/prometheus-community/smartctl_exporter). ## Prerequisites - Kubernetes 1.13+ with Beta APIs enabled - Helm 3 - smartmontools 7.0+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-smartctl-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-smartctl-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-smartctl-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```shell helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-smartctl-exporter --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-smartctl-exporter ``` --- ### Overview (`charts/prometheus-snmp-exporter/README.md`) # Prometheus SNMP Exporter An Prometheus exporter that exposes information gathered from SNMP. This chart creates a [SNMP Exporter](https://github.com/prometheus/snmp_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.8+ with Beta APIs enabled ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-snmp-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-snmp-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-snmp-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. #### To 1.0.0 This version allows multiple Targets to be specified when using ServiceMonitor. When you use ServiceMonitor, please rewrite below: ```yaml serviceMonitor: enabled: true params: enabled: true conf: module: - if_mib target: - 127.0.0.1 ``` to this: ```yaml serviceMonitor: enabled: true params: - module: - if_mib name: device1 target: 127.0.0.1 ``` #### To 2.0.0 This version changes the `serviceMonitor.namespace` value from `monitoring` to the namespace the release is deployed to. #### To 3.0.0 This version upgrades snmp-exporter version to 0.24.1, which introduces breaking change to configuration format. See [Module and Auth Split Migration](https://github.com/prometheus/snmp_exporter/blob/main/auth-split-migration.md) for more details. #### To 4.0.0 This version contain major changes & The [configmap-reload](https://github.com/jimmidyson/configmap-reload) container was replaced by the [prometheus-config-reloader](https://github.com/prometheus-operator/prometheus-operator/tree/main/cmd/prometheus-config-reloader). #### To 5.0.0 This version changes the default image repository from using DockerHub to Quay. #### To 6.0.0 This version changes the default health check path from `/health` to `/` #### To 7.0.0 This version changes the sysUpTime metric by removing from the if_mib module and including it as part of the new system module, along with other useful system related metrics. Update your scrape definitions to include the system module if you need sysUpTime. #### To 8.0.0 This version changes the additional metrics values to always be a string. #### To 9.0.0 This version adds ability to enable config-reloader on demand, also to specify custom --watched-dir and ability to mount snmp-exporter pods extraVolumeMounts for consistency of mounted configs. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 $ helm inspect values oci://ghcr.io/prometheus-community/charts/prometheus-snmp-exporter # Helm 3 $ helm show values oci://ghcr.io/prometheus-community/charts/prometheus-snmp-exporter ``` See [prometheus/snmp_exporter/README.md](https://github.com/prometheus/snmp_exporter/) for further information. ### Prometheus Configuration The snmp exporter needs to be passed the address as a parameter, this can be done with relabelling. Example config: ```yaml scrape_configs: - job_name: 'snmp' static_configs: - targets: - 192.168.1.2 # SNMP device. metrics_path: /snmp params: module: [if_mib] relabel_configs: - source_labels: [__address__] target_label: __param_target - source_labels: [__param_target] target_label: instance - target_label: __address__ replacement: my-service-name:9116 # The SNMP exporter's Service name and port. ``` Example configuration via a ServiceMonitor ```yaml serviceMonitor: enabled: true relabelings: - sourceLabels: [__param_target] targetLabel: instance params: - module: - fortigate_snmp name: device1 target: 192.168.1.2 # SNMP device ``` --- ### Overview (`charts/prometheus-sql-exporter/README.md`) # Prometheus SQL Exporter Prometheus exporter for SQL testing Learn more: [https://github.com/justwatchcom/sql_exporter](https://github.com/justwatchcom/sql_exporter) This chart creates a SQL-Exporter deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.27+ - Helm >= 3.0 ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-sql-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-sql-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-sql-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-sql-exporter ``` --- ### Overview (`charts/prometheus-stackdriver-exporter/README.md`) # Stackdriver Exporter Prometheus exporter for Stackdriver, allowing for Google Cloud metrics. You must have appropriate IAM permissions for this exporter to work. If you are passing in an IAM key then you must have: * monitoring.metricDescriptors.list * monitoring.timeSeries.list These are contained within `roles/monitoring.viewer`. If you're using legacy access scopes, then you must have `https://www.googleapis.com/auth/monitoring.read`. Learn more: This chart creates a Stackdriver-Exporter deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites * Kubernetes 1.8+ with Beta APIs enabled ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). * OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-stackdriver-exporter` * Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-stackdriver-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console # Helm 3 $ helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-stackdriver-exporter --set 'stackdriver.projectIds[0]=google-project-name' # Helm 2 $ helm install --name [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-stackdriver-exporter --set 'stackdriver.projectIds[0]=google-project-name' ``` The command deploys Stackdriver-Exporter on the Kubernetes cluster using the default configuration. _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console # Helm 3 $ helm uninstall [RELEASE_NAME] # Helm 2 # helm delete --purge [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console # Helm 3 or 2 $ helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. ##### 4.x to 5.x The deprecated `stackdriver.projectId` and `stackdriver.metrics.typePrefixes` parameters have been removed. Replace: ```yaml stackdriver: projectId: my-project metrics: typePrefixes: compute.googleapis.com/instance/cpu ``` with: ```yaml stackdriver: projectIds: - my-project metrics: prefixes: - compute.googleapis.com/instance/cpu ``` ##### 3.x to 4.x The Helm parameter `stackdriver.metrics.filters` is changed to support multiple values instead of a single value. If you are using this parameter, please adjust. ```console stackdriver: metrics: filters: - filter-1 - filter-2 ``` ##### 2.x to 3.x Due to a change in deployment labels, **removal** of its deployment needs to done manually prior to upgrading: ```console kubectl delete deployments.apps -l app=prometheus-stackdriver-exporter --cascade=orphan ``` If this is not done, when upgrading via helm (even with `helm upgrade --force`) an error will occur indicating that the deployment cannot be modified: ```console invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app.kubernetes.io/instance":"example", "app.kubernetes.io/name":"prometheus-stackdriver-exporter"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable ``` Since chart version 3.x, [Kubernetes recommended labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/) have been **added**. The following labels are now **removed** in all manifests (including labels used as selector for `Deployment` kind): ```yaml ... metadata: labels: app: prometheus-stackdriver-exporter chart: prometheus-stackdriver-exporter-2.X.X heritage: Helm release: example ... spec: ... selector: matchLabels: app: prometheus-stackdriver-exporter release: example ... ``` If you use your own custom [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#servicemonitor) or [PodMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#podmonitor), please ensure to upgrade their `selector` fields accordingly to the new labels. ##### 1.x to 2.x Since chart version 2.0.0, the exporter is configured via flags/arguments instead of environment variables due to a [breaking change in the exporter](https://github.com/prometheus-community/stackdriver_exporter/pull/142). If you already use `.Values.extraArgs` you might want to check for conflicting command arguments. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console # Helm 2 $ helm inspect values oci://ghcr.io/prometheus-community/charts/prometheus-stackdriver-exporter # Helm 3 $ helm show values oci://ghcr.io/prometheus-community/charts/prometheus-stackdriver-exporter ``` > **Tip**: You can use the default [values.yaml](values.yaml), as long as you provide a value for stackdriver.projectIds. ### Namespace Override Set `namespaceOverride` to deploy chart resources into a namespace different from the Helm release namespace. ## Google Storage Metrics In order to get metrics for GCS you need to ensure the metrics interval is > 24h. You can read more information about this in [this bug report](https://github.com/frodenas/stackdriver_exporter/issues/14). The easiest way to do this is to create two separate exporters with different prefixes and intervals, to ensure you gather all appropriate metrics. --- ### Overview (`charts/prometheus-statsd-exporter/README.md`) # prometheus-statsd-exporter Prometheus Exporter for [Statsd](https://github.com/statsd/statsd) metrics. This chart bootstraps a [Statsd Exporter](https://github.com/prometheus/statsd_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.19+ with Beta APIs enabled - Helm 3+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-statsd-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-statsd-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-statsd-exporter ``` _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-statsd-exporter ``` ### Statsd Exporter Server - Use early created ConfigMap with file `statsd.mappingConf` contained in data or specify mapping values in `statsd.mappingConfig` #### Upgrading an existing Release to a new major version A major chart version change (like v1.2.3 -> v2.0.0) indicates that there is an incompatible breaking change needing manual actions. ##### 0.x to 1.x Support for Kubernetes versions older then 1.19 has been removed. --- ### Overview (`charts/prometheus-systemd-exporter/README.md`) # Prometheus Systemd Exporter Prometheus exporter for systemd units, written in Go. This chart bootstraps a prometheus [systemd exporter](https://github.com/prometheus-community/systemd_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-systemd-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-systemd-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-systemd-exporter ``` _See [configuration](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-systemd-exporter ``` ### Exported Systemd units Default values generate metrics for `kubelet.service` and `docker.service` systemd units. Units to generate metrics for are configurable by means of `config.systemd.collector.unitInclude`. To generate metrics for all units override default values with: ```yaml config: systemd: collector: unitInclude: - '.+' ``` --- ### Overview (`charts/prometheus-to-sd/README.md`) # prometheus-to-sd [prometheus-to-sd](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd) is a simple component that can scrape metrics stored in prometheus text format from one or multiple components and push them to the Stackdriver ## Prerequisites - a service exposing metrics in prometheus format - k8s cluster should run on GCE or GKE ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-to-sd` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-to-sd` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-to-sd ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] [CHART] --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-to-sd ``` For more information please refer to the [prometheus-to-sd](https://github.com/GoogleCloudPlatform/k8s-stackdriver/tree/master/prometheus-to-sd) documentation. ### Metrics Sources Multiple metrics sources can be defined. To configure, set `metricsSources` value (example: `http://kube-state-metrics:8080`) --- ### Overview (`charts/prometheus-windows-exporter/README.md`) # Prometheus `Windows Exporter` Prometheus exporter for hardware and OS metrics exposed by Windows kernels, written in Go with pluggable metric collectors. This chart bootstraps a prometheus [`Windows Exporter`](http://github.com/prometheus-community/windows_exporter) daemonset on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-windows-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-windows-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-windows-exporter ``` _See [configuration](#configuring) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ## Configuring See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-windows-exporter ``` --- ### Overview (`charts/prometheus-yet-another-cloudwatch-exporter/README.md`) # yet-another-cloudwatch-exporter YACE, or `yet another cloudwatch exporter`, is a Prometheus exporter for AWS CloudWatch metrics. This chart bootstraps a [YACE](https://github.com/prometheus-community/yet-another-cloudwatch-exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus-yet-another-cloudwatch-exporter` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus-yet-another-cloudwatch-exporter` The installation instructions use the OCI registry. Refer to the [`helm repo`]([`helm repo`](https://helm.sh/docs/helm/helm_repo/)) command documentation for information on installing charts via the traditional repository. ### Install Chart ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus-yet-another-cloudwatch-exporter ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus-yet-another-cloudwatch-exporter ``` ## Migrate from nerdswords/helm-charts (before version 0.39.0) If you are migrate from the [`nerdswords/helm-charts` repository](https://github.com/nerdswords/helm-charts/tree/main/charts/yet-another-cloudwatch-exporter), you must consider the following changes: - the chart name has changed from `yet-another-cloudwatch-exporter` to `prometheus-yet-another-cloudwatch-exporter`. - to avoid conflicts with the new chart name, you can set the `nameOverride` value to `yet-another-cloudwatch-exporter` in your `values.yaml` file. --- ### Overview (`charts/prometheus/README.md`) # Prometheus [Prometheus](https://prometheus.io/), a [Cloud Native Computing Foundation](https://cncf.io/) project, is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true. This chart bootstraps a [Prometheus](https://prometheus.io/) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. ## Prerequisites - Kubernetes 1.19+ - Helm 3.7+ ## Usage The chart is distributed as an [OCI Artifact](https://helm.sh/docs/topics/registries/) as well as via a traditional [Helm Repository](https://helm.sh/docs/topics/chart_repository/). - OCI Artifact: `oci://ghcr.io/prometheus-community/charts/prometheus` - Helm Repository: `https://prometheus-community.github.io/helm-charts` with chart `prometheus` The installation instructions use the OCI registry. Refer to the [`helm repo`](https://helm.sh/docs/helm/helm_repo/) command documentation for information on installing charts via the traditional repository. ### Install Chart Starting with version 16.0, the Prometheus chart requires Helm 3.7+ in order to install successfully. Please check your `helm` release before installation. ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus ``` _See [configuration](#configuration) below._ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._ ### Dependencies By default this chart installs additional, dependent charts: - [alertmanager](https://github.com/prometheus-community/helm-charts/tree/main/charts/alertmanager) - [kube-state-metrics](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-state-metrics) - [prometheus-node-exporter](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-node-exporter) - [prometheus-pushgateway](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-pushgateway) To disable the dependency during installation, set `alertmanager.enabled`, `kube-state-metrics.enabled`, `prometheus-node-exporter.enabled` and `prometheus-pushgateway.enabled` to `false`. _See [helm dependency](https://helm.sh/docs/helm/helm_dependency/) for command documentation._ ### Uninstall Chart ```console helm uninstall [RELEASE_NAME] ``` This removes all the Kubernetes components associated with the chart and deletes the release. _See [helm uninstall](https://helm.sh/docs/helm/helm_uninstall/) for command documentation._ ### Updating values.schema.json A [`values.schema.json`](https://helm.sh/docs/topics/charts/#schema-files) file has been added to validate chart values. When `values.yaml` file has a structure change (i.e. add a new field, change value type, etc.), modify `values.schema.json` file manually or run `helm schema-gen values.yaml > values.schema.json` to ensure the schema is aligned with the latest values. Refer to [helm plugin `helm-schema-gen`](https://github.com/karuppiah7890/helm-schema-gen) for plugin installation instructions. ### Upgrading Chart ```console helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prometheus --install ``` _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ #### To 29.0 Starting with version 29.0, the default `kubernetes_sd_configs` roles for several scrape configurations have been migrated from `endpoints` to `endpointslice` due to the deprecation of the former in Kubernetes release 1.33. Affected scrape configurations in `scrapeConfigs`: - `kubernetes-api-servers` - `kubernetes-service-endpoints` - `kubernetes-service-endpoints-slow` Users who currently apply custom relabelings with the `endpoints` labels should adjust their configuration for the `endpointslice` labels before upgrading. #### To 28.0 Scrape configs previously defined in field `serverFiles."prometheus.yml".scrape_configs` (array) have been moved in the new field `scrapeConfigs` (map). The contents of the scrape configs have not changed. Each scrape config can be disabled by setting `enabled` to _false_, each key becomes the default value of `job_name`. Further scrape configs can be inserted as new keys whereby these get enabled by default. A scrape config expects native Prometheus' configuration. Field `extraScrapeConfigs` can still be used for additional scrape configs and is not affected by the change. Using the new field is not mandatory, `serverFiles."prometheus.yml".scrape_configs` works in the same way as before but is _unset_ by default. Users wishing to continue using this field via a custom values file should unset `scrapeConfigs` before upgrading: ```yaml scrapeConfigs: null ``` Similarly, users who wish to make use of the new field but have modified the previous default scrape configs should transfer the modifications in `scrapeConfigs` and remove the previous scrape configs. Some examples: - Skip certificate verification for API servers (default is not to skip the verification) ```yaml scrapeConfigs: kubernetes-api-servers: tls_config: insecure_skip_verify: true ``` - Add basic auth in the default scrape config for prometheus ```yaml scrapeConfigs: prometheus: basic_auth: username: "admin" password_file: /etc/private/auth-passwd ``` - Disable scrape config _kubernetes-pods-slow_ ```yaml scrapeConfigs: kubernetes-pods-slow: enabled: false ``` - Add a new scrape config with `job_name` set to _foo_ (gets enabled by default) ```yaml scrapeConfigs: foo: honor_labels: true kubernetes_sd_configs: - role: service relabel_configs: - source_labels: [__meta_kubernetes_service_annotation_prometheus_io_probe] action: keep regex: true ``` #### To 27.0 Prometheus' configuration parameter `insecure_skip_verify` in scrape configs `serverFiles."prometheus.yml".scrape_configs` has been commented out keeping thus the default Prometheus' value. If certificate verification must be skipped, please, set the configuration parameter in your scrape configs. #### To 26.0 This release changes default version of prometheus to v3.0.0, See official [migration guide](https://prometheus.io/docs/prometheus/latest/migration/#prometheus-3-0-migration-guide) and [release notes](https://github.com/prometheus/prometheus/releases/tag/v3.0.0) for more details. #### To 25.0 The `server.remoteRead[].url` and `server.remoteWrite[].url` fields now support templating. Allowing for `url` values such as `https://{{ .Release.Name }}.example.com`. Any entries in these which previously included `{{` or `}}` must be escaped with `{{ "{{" }}` and `{{ "}}" }}` respectively. Entries which did not previously include the template-like syntax will not be affected. #### To 24.0 Require Kubernetes 1.19+ Release 1.0.0 of the _alertmanager_ replaced [configmap-reload](https://github.com/jimmidyson/configmap-reload) with [prometheus-config-reloader](https://github.com/prometheus-operator/prometheus-operator/tree/main/cmd/prometheus-config-reloader). Extra command-line arguments specified via `configmapReload.prometheus.extraArgs` are not compatible and will break with the new prometheus-config-reloader. Please, refer to the [sources](https://github.com/prometheus-operator/prometheus-operator/blob/main/cmd/prometheus-config-reloader/main.go) in order to make the appropriate adjustment to the extra command-line arguments. #### To 23.0 Release 5.0.0 of the _kube-state-metrics_ chart introduced a separation of the `image.repository` value in two distinct values: ```console image: registry: registry.k8s.io repository: kube-state-metrics/kube-state-metrics ``` If a custom values file or CLI flags set `kube-state.metrics.image.repository`, please, set the new values accordingly. If you are upgrading _prometheus-pushgateway_ with the chart and _prometheus-pushgateway_ has been deployed as a statefulset with a persistent volume, the statefulset must be deleted before upgrading the chart, e.g.: ```bash kubectl delete sts -l app.kubernetes.io/name=prometheus-pushgateway -n monitoring --cascade=orphan ``` Users are advised to review changes in the corresponding chart releases before upgrading. #### To 22.0 The `app.kubernetes.io/version` label has been removed from the pod selector. Therefore, you must delete the previous StatefulSet or Deployment before upgrading. Performing this operation will cause **Prometheus to stop functioning** until the upgrade is complete. ```console kubectl delete deploy,sts -l app.kubernetes.io/name=prometheus ``` #### To 21.0 The Kubernetes labels have been updated to follow [Helm 3 label and annotation best practices](https://helm.sh/docs/chart_best_practices/labels/). Specifically, labels mapping is listed below: | OLD | NEW | |--------------------|------------------------------| |heritage | app.kubernetes.io/managed-by | |chart | helm.sh/chart | |[container version] | app.kubernetes.io/version | |app | app.kubernetes.io/name | |release | app.kubernetes.io/instance | Therefore, depending on the way you've configured the chart, the previous StatefulSet or Deployment need to be deleted before upgrade. If `runAsStatefulSet: false` (this is the default): ```console kubectl delete deploy -l app=prometheus ``` If `runAsStatefulSet: true`: ```console kubectl delete sts -l app=prometheus ``` After that do the actual upgrade: ```console helm upgrade -i prometheus prometheus-community/prometheus ``` #### To 20.0 The [configmap-reload](https://github.com/jimmidyson/configmap-reload) container was replaced by the [prometheus-config-reloader](https://github.com/prometheus-operator/prometheus-operator/tree/main/cmd/prometheus-config-reloader). Extra command-line arguments specified via configmapReload.prometheus.extraArgs are not compatible and will break with the new prometheus-config-reloader, refer to the [sources](https://github.com/prometheus-operator/prometheus-operator/blob/main/cmd/prometheus-config-reloader/main.go) in order to make the appropriate adjustment to the extra command-line arguments. #### To 19.0 Prometheus has been updated to version v2.40.5. Prometheus-pushgateway was updated to version 2.0.0 which adapted [Helm label and annotation best practices](https://helm.sh/docs/chart_best_practices/labels/). See the [upgrade docs of the prometheus-pushgateway chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-pushgateway#to-200) to see what's to do, before you upgrade Prometheus! The condition in Chart.yaml to disable kube-state-metrics has been changed from `kubeStateMetrics.enabled` to `kube-state-metrics.enabled` The Docker image tag is used from appVersion field in Chart.yaml by default. Unused subchart configs has been removed and subchart config is now on the bottom of the config file. If Prometheus is used as deployment the updatestrategy has been changed to "Recreate" by default, so Helm updates work out of the box. `.Values.server.extraTemplates` & `.Values.server.extraObjects` has been removed in favour of `.Values.extraManifests`, which can do the same. `.Values.server.enabled` has been removed as it's useless now that all components are created by subcharts. All files in `templates/server` directory has been moved to `templates` directory. ```bash helm upgrade [RELEASE_NAME] prometheus-community/prometheus --version 19.0.0 ``` #### To 18.0 Version 18.0.0 uses alertmanager service from the [alertmanager chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/alertmanager). If you've made some config changes, please check the old `alertmanager` and the new `alertmanager` configuration section in values.yaml for differences. Note that the `configmapReload` section for `alertmanager` was moved out of dedicated section (`configmapReload.alertmanager`) to alertmanager embedded (`alertmanager.configmapReload`). Before you update, please scale down the `prometheus-server` deployment to `0` then perform upgrade: ```bash # In 17.x kubectl scale deploy prometheus-server --replicas=0 # Upgrade helm upgrade [RELEASE_NAME] prometheus-community/prometheus --version 18.0.0 ``` #### To 17.0 Version 17.0.0 uses pushgateway service from the [prometheus-pushgateway chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-pushgateway). If you've made some config changes, please check the old `pushgateway` and the new `prometheus-pushgateway` configuration section in values.yaml for differences. Before you update, please scale down the `prometheus-server` deployment to `0` then perform upgrade: ```bash # In 16.x kubectl scale deploy prometheus-server --replicas=0 # Upgrade helm upgrade [RELEASE_NAME] prometheus-community/prometheus --version 17.0.0 ``` #### To 16.0 Starting from version 16.0 embedded services (like alertmanager, node-exporter etc.) are moved out of Prometheus chart and the respecting charts from this repository are used as dependencies. Version 16.0.0 moves node-exporter service to [prometheus-node-exporter chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-node-exporter). If you've made some config changes, please check the old `nodeExporter` and the new `prometheus-node-exporter` configuration section in values.yaml for differences. Before you update, please scale down the `prometheus-server` deployment to `0` then perform upgrade: ```bash # In 15.x kubectl scale deploy prometheus-server --replicas=0 # Upgrade helm upgrade [RELEASE_NAME] prometheus-community/prometheus --version 16.0.0 ``` #### To 15.0 Version 15.0.0 changes the relabeling config, aligning it with the [Prometheus community conventions](https://github.com/prometheus/prometheus/pull/9832). If you've made manual changes to the relabeling config, you have to adapt your changes. Before you update please execute the following command, to be able to update kube-state-metrics: ```bash kubectl delete deployments.apps -l app.kubernetes.io/instance=prometheus,app.kubernetes.io/name=kube-state-metrics --cascade=orphan ``` #### To 9.0 Version 9.0 adds a new option to enable or disable the Prometheus Server. This supports the use case of running a Prometheus server in one k8s cluster and scraping exporters in another cluster while using the same chart for each deployment. To install the server `server.enabled` must be set to `true`. #### To 5.0 As of version 5.0, this chart uses Prometheus 2.x. This version of prometheus introduces a new data format and is not compatible with prometheus 1.x. It is recommended to install this as a new release, as updating existing releases will not work. See the [prometheus docs](https://prometheus.io/docs/prometheus/latest/migration/#storage) for instructions on retaining your old data. Prometheus version 2.x has made changes to alertmanager, storage and recording rules. Check out [the 2.x migration guide](https://prometheus.io/docs/prometheus/2.55/migration/). Users of this chart will need to update their alerting rules to the new format before they can upgrade. #### Example Migration Assuming you have an existing release of the prometheus chart, named `prometheus-old`. In order to update to prometheus 2.x while keeping your old data do the following: 1. Update the `prometheus-old` release. Disable scraping on every component besides the prometheus server, similar to the configuration below: ```yaml alertmanager: enabled: false alertmanagerFiles: alertmanager.yml: "" kubeStateMetrics: enabled: false nodeExporter: enabled: false pushgateway: enabled: false server: extraArgs: storage.local.retention: 720h serverFiles: alerts: "" prometheus.yml: "" rules: "" ``` 1. Deploy a new release of the chart with version 5.0+ using prometheus 2.x. In the values.yaml set the scrape config as usual, and also add the `prometheus-old` instance as a remote-read target. ```yaml prometheus.yml: ... remote_read: - url: http://prometheus-old/api/v1/read ... ``` Old data will be available when you query the new prometheus instance. ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: ```console helm show values oci://ghcr.io/prometheus-community/charts/prometheus ``` You may similarly use the above configuration commands on each chart [dependency](#dependencies) to see its configurations. ### Scraping Pod Metrics via Annotations This chart uses a default configuration that causes prometheus to scrape a variety of kubernetes resource types, provided they have the correct annotations. In this section we describe how to configure pods to be scraped; for information on how other resource types can be scraped you can do a `helm template` to get the kubernetes resource definitions, and then reference the prometheus configuration in the ConfigMap against the prometheus documentation for [relabel_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) and [kubernetes_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config). In order to get prometheus to scrape pods, you must add annotations to the pods as below: ```yaml metadata: annotations: prometheus.io/scrape: "true" prometheus.io/path: /metrics prometheus.io/port: "8080" ``` You should adjust `prometheus.io/path` based on the URL that your pod serves metrics from. `prometheus.io/port` should be set to the port that your pod serves metrics from. Note that the values for `prometheus.io/scrape` and `prometheus.io/port` must be enclosed in double quotes. ### Sharing Alerts Between Services Note that when [installing](#install-chart) or [upgrading](#upgrading-chart) you may use multiple values override files. This is particularly useful when you have alerts belonging to multiple services in the cluster. For example, ```yaml # values.yaml # ... # service1-alert.yaml serverFiles: alerts: service1: - alert: anAlert # ... # service2-alert.yaml serverFiles: alerts: service2: - alert: anAlert # ... ``` ```console helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/prom-label-proxy -f values.yaml -f service1-alert.yaml -f service2-alert.yaml ``` ### RBAC Configuration Roles and RoleBindings resources will be created automatically for `server` service. To manually setup RBAC you need to set the parameter `rbac.create=false` and specify the service account to be used for each service by setting the parameters: `serviceAccounts.{{ component }}.create` to `false` and `serviceAccounts.{{ component }}.name` to the name of a pre-existing service account. > **Tip**: You can refer to the default `*-clusterrole.yaml` and `*-clusterrolebinding.yaml` files in [templates](templates/) to customize your own. ### ConfigMap Files AlertManager is configured through [alertmanager.yml](https://prometheus.io/docs/alerting/configuration/). This file (and any others listed in `alertmanagerFiles`) will be mounted into the `alertmanager` pod. Prometheus is configured through [prometheus.yml](https://prometheus.io/docs/operating/configuration/). This file (and any others listed in `serverFiles`) will be mounted into the `server` pod. ### Ingress TLS If your cluster allows automatic creation/retrieval of TLS certificates (e.g. [cert-manager](https://github.com/jetstack/cert-manager)), please refer to the documentation for that mechanism. To manually configure TLS, first create/retrieve a key & certificate pair for the address(es) you wish to protect. Then create a TLS secret in the namespace: ```console kubectl create secret tls prometheus-server-tls --cert=path/to/tls.cert --key=path/to/tls.key ``` Include the secret's name, along with the desired hostnames, in the alertmanager/server Ingress TLS section of your custom `values.yaml` file: ```yaml server: ingress: ## If true, Prometheus server Ingress will be created ## enabled: true ## Prometheus server Ingress hostnames ## Must be provided if Ingress is enabled ## hosts: - prometheus.domain.com ## Prometheus server Ingress TLS configuration ## Secrets must be manually created in the namespace ## tls: - secretName: prometheus-server-tls hosts: - prometheus.domain.com ``` ### NetworkPolicy Enabling Network Policy for Prometheus will secure connections to Alert Manager and Kube State Metrics by only accepting connections from Prometheus Server. All inbound connections to Prometheus Server are still allowed. To enable network policy for Prometheus, install a networking plugin that implements the Kubernetes NetworkPolicy spec, and set `networkPolicy.enabled` to true. If NetworkPolicy is enabled for Prometheus' scrape targets, you may also need to manually create a networkpolicy which allows it. --- ### Overview (`charts/kube-prometheus-stack/hack/README.md`) # kube-prometheus-stack hacks ## [update_mixins.sh](update_mixins.sh) This script is a useful wrapper to run `sync_prometheus_rules.py` and `sync_grafana_dashboards.py`. It clones all dependency dashboards into a tmp folder. And it lets you know if you are missing commandline-tools necessary for the update to complete. Therefore, if you want to create a PR that updates the mixins, please run `./hack/update_mixins.sh` from the charts directory (`./charts/kube-prometheus-stack`). ## [sync_prometheus_rules.py](sync_prometheus_rules.py) This script generates prometheus rules set for alertmanager from any properly formatted kubernetes YAML based on defined input, splitting rules to separate files based on group name. Currently following imported: - [prometheus-operator/kube-prometheus rules set](https://github.com/prometheus-operator/kube-prometheus/blob/main/manifests/kubernetesControlPlane-prometheusRule.yaml) - In order to modify these rules: - prepare and merge PR into [kubernetes-mixin](https://github.com/kubernetes-monitoring/kubernetes-mixin/tree/master/rules) master and/or release branch - run import inside your fork of [prometheus-operator/kube-prometheus](https://github.com/prometheus-operator/kube-prometheus/tree/main) ```bash jb update make generate ``` - prepare and merge PR with imported changes into `prometheus-operator/kube-prometheus` master and/or release branch - run sync_prometheus_rules.py inside your fork of this repository - send PR with changes to this repository - [etcd-io/etcd rules set](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet). - In order to modify these rules: - prepare and merge PR into [etcd-io/etcd](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet) repository - run sync_prometheus_rules.py inside your fork of this repository - send PR with changes to this repository ## [sync_grafana_dashboards.py](sync_grafana_dashboards.py) This script generates grafana dashboards from json files, splitting them to separate files based on group name. Currently following imported: - [prometheus-operator/kube-prometheus dashboards](https://github.com/prometheus-operator/kube-prometheus/tree/main/manifests/grafana-deployment.yaml) - In order to modify these dashboards: - prepare and merge PR into [kubernetes-mixin](https://github.com/kubernetes-monitoring/kubernetes-mixin/tree/master/dashboards) master and/or release branch - run import inside your fork of [prometheus-operator/kube-prometheus](https://github.com/prometheus-operator/kube-prometheus/tree/main) ```bash jb update make generate ``` - prepare and merge PR with imported changes into `prometheus-operator/kube-prometheus` master and/or release branch - run sync_grafana_dashboards.py inside your fork of this repository - send PR with changes to this repository - [etcd-io/website dashboard](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet) - In order to modify this dashboard: - prepare and merge PR into [etcd-io/etcd](https://github.com/etcd-io/etcd/blob/main/contrib/mixin/mixin.libsonnet) repository - run sync_grafana_dashboards.py inside your fork of this repository - send PR with changes to this repository [CoreDNS dashboard](https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/templates/grafana/dashboards-1.14/k8s-coredns.yaml) is the only dashboard which is maintained in this repository and can be changed without import. --- ### Overview (`charts/kube-prometheus-stack/charts/crds/README.md`) # crds subchart See: [https://github.com/prometheus-community/helm-charts/issues/3548](https://github.com/prometheus-community/helm-charts/issues/3548) --- ### Overview (`charts/kube-prometheus-stack/hack/minikube/README.md`) # Testing on Minikube The configuration in this folder lets you locally test the setup on minikube. Use cmd.sh to set up components and hack a working etcd scrape configuration. Run the commands in the sequence listed in the script to get a local working minikube cluster. If you're using windows, there's a commented-out section that you should add to the minikube command. --- --- METRICS --- - Files Extracted: 49 - Estimated Token Budget: ~51323 tokens - Canonical Reference: https://codewiki.google/github.com/prometheus-community/helm-charts