Skip to content

kube-state-metrics

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

kube-state-metrics

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
templates
templates
 
 
.helmignore
.helmignore
 
 
Chart.yaml
Chart.yaml
 
 
README.md
README.md
 
 
values.yaml
values.yaml
 
 

README.md

kube-state-metrics Helm Chart

Installs the kube-state-metrics agent.

Usage

The chart is distributed as an OCI Artifact as well as via a traditional Helm 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) command documentation for information on installing charts via the traditional repository.

Install Chart

helm install [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-state-metrics [flags]

See configuration below.

See helm install for command documentation.

Uninstall Chart

helm uninstall [RELEASE_NAME]

This removes all the Kubernetes components associated with the chart and deletes the release.

See helm uninstall for command documentation.

Upgrading Chart

helm upgrade [RELEASE_NAME] oci://ghcr.io/prometheus-community/charts/kube-state-metrics [flags]

See helm upgrade for command documentation.

Migrating from stable/kube-state-metrics and kubernetes/kube-state-metrics

You can upgrade in-place:

  1. upgrade your existing release name using the new chart repository

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 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. To see all configurable options with detailed comments:

helm show values oci://ghcr.io/prometheus-community/charts/kube-state-metrics

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:

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 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 documentation for the scraper-side ClusterRole and ClusterRoleBinding.