helm/infrastructure/subcharts/prometheus/charts/kube-state-metrics/README.md

   1 # kube-state-metrics Helm Chart
   2
   3 * Installs the [kube-state-metrics agent](https://github.com/kubernetes/kube-state-metrics).
   4
   5 ## Installing the Chart
   6
   7 To install the chart with the release name `my-release`:
   8
   9 ```bash
  10 $ helm install stable/kube-state-metrics
  11 ```
  12
  13 ## Configuration
  14
  15 | Parameter                                    | Description                                                                           | Default                                    |
  16 |:---------------------------------------------|:--------------------------------------------------------------------------------------|:-------------------------------------------|
  17 | `image.repository`                           | The image repository to pull from                                                     | quay.io/coreos/kube-state-metrics          |
  18 | `image.tag`                                  | The image tag to pull from                                                            | `v1.9.5`                                   |
  19 | `image.pullPolicy`                           | Image pull policy                                                                     | `IfNotPresent`                             |
  20 | `replicas`                                   | Number of replicas                                                                    | `1`                                        |
  21 | `autosharding.enabled`                       | Set to `true` to automatically shard data across `replicas` pods. EXPERIMENTAL        | `false`                                    |
  22 | `service.port`                               | The port of the container                                                             | `8080`                                     |
  23 | `service.annotations`                        | Annotations to be added to the service                                                | `{}`                                       |
  24 | `customLabels`                               | Custom labels to apply to service, deployment and pods                                | `{}`                                       |
  25 | `hostNetwork`                                | Whether or not to use the host network                                                | `false`                                    |
  26 | `prometheusScrape`                           | Whether or not enable prom scrape                                                     | `true`                                     |
  27 | `rbac.create`                                | If true, create & use RBAC resources                                                  | `true`                                     |
  28 | `serviceAccount.create`                      | If true, create & use serviceAccount                                                  | `true`                                     |
  29 | `serviceAccount.name`                        | If not set & create is true, use template fullname                                    |                                            |
  30 | `serviceAccount.imagePullSecrets`            | Specify image pull secrets field                                                      | `[]`                                       |
  31 | `podSecurityPolicy.enabled`                  | If true, create & use PodSecurityPolicy resources                                     | `false`                                    |
  32 | `podSecurityPolicy.annotations`              | Specify pod annotations in the pod security policy                                    | {}                                         |
  33 | `securityContext.enabled`                    | Enable security context                                                               | `true`                                     |
  34 | `securityContext.fsGroup`                    | Group ID for the container                                                            | `65534`                                    |
  35 | `securityContext.runAsUser`                  | User ID for the container                                                             | `65534`                                    |
  36 | `priorityClassName`                          | Name of Priority Class to assign pods                                                 | `nil`                                      |
  37 | `nodeSelector`                               | Node labels for pod assignment                                                        | {}                                         |
  38 | `affinity`                                   | Affinity settings for pod assignment                                                  | {}                                         |
  39 | `tolerations`                                | Tolerations for pod assignment                                                        | []                                         |
  40 | `podAnnotations`                             | Annotations to be added to the pod                                                    | {}                                         |
  41 | `resources`                                  | kube-state-metrics resource requests and limits                                       | {}                                         |
  42 | `collectors.certificatesigningrequests`      | Enable the certificatesigningrequests collector.                                      | `true`                                     |
  43 | `collectors.configmaps`                      | Enable the configmaps collector.                                                      | `true`                                     |
  44 | `collectors.cronjobs`                        | Enable the cronjobs collector.                                                        | `true`                                     |
  45 | `collectors.daemonsets`                      | Enable the daemonsets collector.                                                      | `true`                                     |
  46 | `collectors.deployments`                     | Enable the deployments collector.                                                     | `true`                                     |
  47 | `collectors.endpoints`                       | Enable the endpoints collector.                                                       | `true`                                     |
  48 | `collectors.horizontalpodautoscalers`        | Enable the horizontalpodautoscalers collector.                                        | `true`                                     |
  49 | `collectors.ingresses`                       | Enable the ingresses collector.                                                       | `true`                                     |
  50 | `collectors.jobs`                            | Enable the jobs collector.                                                            | `true`                                     |
  51 | `collectors.limitranges`                     | Enable the limitranges collector.                                                     | `true`                                     |
  52 | `collectors.mutatingwebhookconfigurations`   | Enable the mutatingwebhookconfigurations collector.                                   | `false`                                    |
  53 | `collectors.namespaces`                      | Enable the namespaces collector.                                                      | `true`                                     |
  54 | `collectors.nodes`                           | Enable the nodes collector.                                                           | `true`                                     |
  55 | `collectors.persistentvolumeclaims`          | Enable the persistentvolumeclaims collector.                                          | `true`                                     |
  56 | `collectors.persistentvolumes`               | Enable the persistentvolumes collector.                                               | `true`                                     |
  57 | `collectors.poddisruptionbudgets`            | Enable the poddisruptionbudgets collector.                                            | `true`                                     |
  58 | `collectors.pods`                            | Enable the pods collector.                                                            | `true`                                     |
  59 | `collectors.replicasets`                     | Enable the replicasets collector.                                                     | `true`                                     |
  60 | `collectors.replicationcontrollers`          | Enable the replicationcontrollers collector.                                          | `true`                                     |
  61 | `collectors.resourcequotas`                  | Enable the resourcequotas collector.                                                  | `true`                                     |
  62 | `collectors.secrets`                         | Enable the secrets collector.                                                         | `true`                                     |
  63 | `collectors.services`                        | Enable the services collector.                                                        | `true`                                     |
  64 | `collectors.statefulsets`                    | Enable the statefulsets collector.                                                    | `true`                                     |
  65 | `collectors.storageclasses`                  | Enable the storageclasses collector.                                                  | `true`                                     |
  66 | `collectors.validatingwebhookconfigurations` | Enable the validatingwebhookconfigurations collector.                                 | `false`                                    |
  67 | `collectors.verticalpodautoscalers`          | Enable the verticalpodautoscalers collector.                                          | `false`                                    |
  68 | `collectors.volumeattachments`               | Enable the volumeattachments collector.                                               | `false`                                    |
  69 | `prometheus.monitor.enabled`                 | Set this to `true` to create ServiceMonitor for Prometheus operator                   | `false`                                    |
  70 | `prometheus.monitor.additionalLabels`        | Additional labels that can be used so ServiceMonitor will be discovered by Prometheus | `{}`                                       |
  71 | `prometheus.monitor.namespace`               | Namespace where servicemonitor resource should be created                             | `the same namespace as kube-state-metrics` |
  72 | `prometheus.monitor.honorLabels`             | Honor metric labels                                                                   | `false`                                    |
  73 | `namespaceOverride`                          | Override the deployment namespace                                                     | `""` (`Release.Namespace`)                 |