deploy/prometheus/charts/kube-state-metrics

kube-state-metrics Helm Chart

Installs the kube-state-metrics agent.

Get Repository Info

helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update

_See helm repo for command documentation._

Install Chart

helm install [RELEASE_NAME] prometheus-community/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] prometheus-community/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. get repository info
2. upgrade your existing release name using the new chart repository

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 prometheus-community/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.