2021-02-26 21:25:43 +00:00
# kube-state-metrics Helm Chart
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
Installs the [kube-state-metrics agent ](https://github.com/kubernetes/kube-state-metrics ).
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
## Get Repo Info
```console
2021-06-01 16:40:34 +00:00
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
2021-02-26 21:25:43 +00:00
helm repo update
```
_See [helm repo ](https://helm.sh/docs/helm/helm_repo/ ) for command documentation._
## Install Chart
```console
2021-06-01 16:40:34 +00:00
helm install [RELEASE_NAME] prometheus-community/kube-state-metrics [flags]
2021-02-26 21:25:43 +00:00
```
_See [configuration ](#configuration ) below._
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
_See [helm install ](https://helm.sh/docs/helm/helm_install/ ) for command documentation._
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
## Uninstall Chart
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
```console
2021-06-01 16:40:34 +00:00
helm uninstall [RELEASE_NAME]
2021-02-26 21:25:43 +00:00
```
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._
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
## Upgrading Chart
2020-12-18 00:46:15 +00:00
2021-02-26 21:25:43 +00:00
```console
2021-06-01 16:40:34 +00:00
helm upgrade [RELEASE_NAME] prometheus-community/kube-state-metrics [flags]
2020-12-18 00:46:15 +00:00
```
2021-02-26 21:25:43 +00:00
_See [helm upgrade ](https://helm.sh/docs/helm/helm_upgrade/ ) for command documentation._
2021-06-01 16:40:34 +00:00
### Migrating from stable/kube-state-metrics and kubernetes/kube-state-metrics
2021-02-26 21:25:43 +00:00
You can upgrade in-place:
1. [get repo info ](#get-repo-info )
1. [upgrade ](#upgrading-chart ) your existing release name using the new chart repo
2021-06-01 16:40:34 +00:00
## 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
2020-12-18 00:46:15 +00:00
## Configuration
2021-02-26 21:25:43 +00:00
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 kube-state-metrics/kube-state-metrics
```
2021-06-01 16:40:34 +00:00
You may also run `helm show values` on this chart's [dependencies ](#dependencies ) for additional options.