Prometheus, a Cloud Native Computing Foundation 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.
$ helm install stable/prometheus
This chart bootstraps a Prometheus deployment on a Kubernetes cluster using the Helm package manager.
- Kubernetes 1.3+ with Beta APIs enabled
To install the chart with the release name my-release
:
$ helm install --name my-release stable/prometheus
The command deploys Prometheus on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
To uninstall/delete the my-release
deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
Prometheus version 2.x has made changes to alertmanager, storage and recording rules. Check out the migration guide here
Users of this chart will need to update their alerting rules to the new format before they can upgrade.
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 for instructions on retaining your old data.
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:
-
Update the
prometheus-old
release. Disable scraping on every component besides the prometheus server, similar to the configuration below: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: ""
-
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.prometheus.yml: ... remote_read: - url: http://prometheus-old/api/v1/read ...
Old data will be available when you query the new prometheus instance.
The following table lists the configurable parameters of the Prometheus chart and their default values.
Parameter | Description | Default |
---|---|---|
alertmanager.enabled |
If true, create alertmanager | true |
alertmanager.name |
alertmanager container name | alertmanager |
alertmanager.image.repository |
alertmanager container image repository | prom/alertmanager |
alertmanager.image.tag |
alertmanager container image tag | v0.15.3 |
alertmanager.image.pullPolicy |
alertmanager container image pull policy | IfNotPresent |
alertmanager.prefixURL |
The prefix slug at which the server can be accessed | `` |
alertmanager.baseURL |
The external url at which the server can be accessed | / |
alertmanager.extraArgs |
Additional alertmanager container arguments | {} |
alertmanager.configMapOverrideName |
Prometheus alertmanager ConfigMap override where full-name is {{.Release.Name}}-{{.Values.alertmanager.configMapOverrideName}} and setting this value will prevent the default alertmanager ConfigMap from being generated |
"" |
alertmanager.configFromSecret |
The name of a secret in the same kubernetes namespace which contains the Alertmanager config, setting this value will prevent the default alertmanager ConfigMap from being generated | "" |
alertmanager.configFileName |
The configuration file name to be loaded to alertmanager. Must match the key within configuration loaded from ConfigMap/Secret. | alertmanager.yml |
alertmanager.ingress.enabled |
If true, alertmanager Ingress will be created | false |
alertmanager.ingress.annotations |
alertmanager Ingress annotations | {} |
alertmanager.ingress.extraLabels |
alertmanager Ingress additional labels | {} |
alertmanager.ingress.hosts |
alertmanager Ingress hostnames | [] |
alertmanager.ingress.tls |
alertmanager Ingress TLS configuration (YAML) | [] |
alertmanager.nodeSelector |
node labels for alertmanager pod assignment | {} |
alertmanager.tolerations |
node taints to tolerate (requires Kubernetes >=1.6) | [] |
alertmanager.affinity |
pod affinity | {} |
alertmanager.schedulerName |
alertmanager alternate scheduler name | nil |
alertmanager.persistentVolume.enabled |
If true, alertmanager will create a Persistent Volume Claim | true |
alertmanager.persistentVolume.accessModes |
alertmanager data Persistent Volume access modes | [ReadWriteOnce] |
alertmanager.persistentVolume.annotations |
Annotations for alertmanager Persistent Volume Claim | {} |
alertmanager.persistentVolume.existingClaim |
alertmanager data Persistent Volume existing claim name | "" |
alertmanager.persistentVolume.mountPath |
alertmanager data Persistent Volume mount root path | /data |
alertmanager.persistentVolume.size |
alertmanager data Persistent Volume size | 2Gi |
alertmanager.persistentVolume.storageClass |
alertmanager data Persistent Volume Storage Class | unset |
alertmanager.persistentVolume.subPath |
Subdirectory of alertmanager data Persistent Volume to mount | "" |
alertmanager.podAnnotations |
annotations to be added to alertmanager pods | {} |
alertmanager.replicaCount |
desired number of alertmanager pods | 1 |
alertmanager.statefulSet.enabled |
If true, use a statefulset instead of a deployment for pod management | false |
alertmanager.statefulSet.podManagementPolicy |
podManagementPolicy of alertmanager pods | OrderedReady |
alertmanager.statefulSet.headless.annotations |
annotations for alertmanager headless service | {} |
alertmanager.statefulSet.headless.labels |
labels for alertmanager headless service | {} |
alertmanager.statefulSet.headless.enableMeshPeer |
If true, enable the mesh peer endpoint for the headless service | {} |
alertmanager.statefulSet.headless.servicePort |
alertmanager headless service port | 80 |
alertmanager.priorityClassName |
alertmanager priorityClassName | nil |
alertmanager.resources |
alertmanager pod resource requests & limits | {} |
alertmanager.securityContext |
Custom security context for Alert Manager containers | {} |
alertmanager.service.annotations |
annotations for alertmanager service | {} |
alertmanager.service.clusterIP |
internal alertmanager cluster service IP | "" |
alertmanager.service.externalIPs |
alertmanager service external IP addresses | [] |
alertmanager.service.loadBalancerIP |
IP address to assign to load balancer (if supported) | "" |
alertmanager.service.loadBalancerSourceRanges |
list of IP CIDRs allowed access to load balancer (if supported) | [] |
alertmanager.service.servicePort |
alertmanager service port | 80 |
alertmanager.service.type |
type of alertmanager service to create | ClusterIP |
alertmanagerFiles.alertmanager.yml |
Prometheus alertmanager configuration | example configuration |
configmapReload.name |
configmap-reload container name | configmap-reload |
configmapReload.image.repository |
configmap-reload container image repository | jimmidyson/configmap-reload |
configmapReload.image.tag |
configmap-reload container image tag | v0.2.2 |
configmapReload.image.pullPolicy |
configmap-reload container image pull policy | IfNotPresent |
configmapReload.extraArgs |
Additional configmap-reload container arguments | {} |
configmapReload.extraVolumeDirs |
Additional configmap-reload volume directories | {} |
configmapReload.extraConfigmapMounts |
Additional configmap-reload configMap mounts | [] |
configmapReload.resources |
configmap-reload pod resource requests & limits | {} |
initChownData.enabled |
If false, don't reset data ownership at startup | true |
initChownData.name |
init-chown-data container name | init-chown-data |
initChownData.image.repository |
init-chown-data container image repository | busybox |
initChownData.image.tag |
init-chown-data container image tag | latest |
initChownData.image.pullPolicy |
init-chown-data container image pull policy | IfNotPresent |
initChownData.resources |
init-chown-data pod resource requests & limits | {} |
kubeStateMetrics.enabled |
If true, create kube-state-metrics | true |
kubeStateMetrics.name |
kube-state-metrics container name | kube-state-metrics |
kubeStateMetrics.image.repository |
kube-state-metrics container image repository | quay.io/coreos/kube-state-metrics |
kubeStateMetrics.image.tag |
kube-state-metrics container image tag | v1.5.0 |
kubeStateMetrics.image.pullPolicy |
kube-state-metrics container image pull policy | IfNotPresent |
kubeStateMetrics.args |
kube-state-metrics container arguments | {} |
kubeStateMetrics.nodeSelector |
node labels for kube-state-metrics pod assignment | {} |
kubeStateMetrics.podAnnotations |
annotations to be added to kube-state-metrics pods | {} |
kubeStateMetrics.deploymentAnnotations |
annotations to be added to kube-state-metrics deployment | {} |
kubeStateMetrics.tolerations |
node taints to tolerate (requires Kubernetes >=1.6) | [] |
kubeStateMetrics.replicaCount |
desired number of kube-state-metrics pods | 1 |
kubeStateMetrics.priorityClassName |
kube-state-metrics priorityClassName | nil |
kubeStateMetrics.resources |
kube-state-metrics resource requests and limits (YAML) | {} |
kubeStateMetrics.securityContext |
Custom security context for kube-state-metrics containers | {} |
kubeStateMetrics.service.annotations |
annotations for kube-state-metrics service | {prometheus.io/scrape: "true"} |
kubeStateMetrics.service.clusterIP |
internal kube-state-metrics cluster service IP | None |
kubeStateMetrics.service.externalIPs |
kube-state-metrics service external IP addresses | [] |
kubeStateMetrics.service.loadBalancerIP |
IP address to assign to load balancer (if supported) | "" |
kubeStateMetrics.service.loadBalancerSourceRanges |
list of IP CIDRs allowed access to load balancer (if supported) | [] |
kubeStateMetrics.service.servicePort |
kube-state-metrics service port | 80 |
kubeStateMetrics.service.type |
type of kube-state-metrics service to create | ClusterIP |
nodeExporter.enabled |
If true, create node-exporter | true |
nodeExporter.name |
node-exporter container name | node-exporter |
nodeExporter.image.repository |
node-exporter container image repository | prom/node-exporter |
nodeExporter.image.tag |
node-exporter container image tag | v0.17.0 |
nodeExporter.image.pullPolicy |
node-exporter container image pull policy | IfNotPresent |
nodeExporter.extraArgs |
Additional node-exporter container arguments | {} |
nodeExporter.extraHostPathMounts |
Additional node-exporter hostPath mounts | [] |
nodeExporter.extraConfigmapMounts |
Additional node-exporter configMap mounts | [] |
nodeExporter.hostNetwork |
If true, node-exporter pods share the host network namespace | true |
nodeExporter.hostPID |
If true, node-exporter pods share the host PID namespace | true |
nodeExporter.nodeSelector |
node labels for node-exporter pod assignment | {} |
nodeExporter.podAnnotations |
annotations to be added to node-exporter pods | {} |
nodeExporter.pod.labels |
labels to be added to node-exporter pods | {} |
nodeExporter.podSecurityPolicy.annotations |
Specify pod annotations in the pod security policy | {} |
nodeExporter.podSecurityPolicy.enabled |
Specify if a Pod Security Policy for node-exporter must be created | false |
nodeExporter.tolerations |
node taints to tolerate (requires Kubernetes >=1.6) | [] |
nodeExporter.priorityClassName |
node-exporter priorityClassName | nil |
nodeExporter.resources |
node-exporter resource requests and limits (YAML) | {} |
nodeExporter.securityContext |
securityContext for containers in pod | {} |
nodeExporter.service.annotations |
annotations for node-exporter service | {prometheus.io/scrape: "true"} |
nodeExporter.service.clusterIP |
internal node-exporter cluster service IP | None |
nodeExporter.service.externalIPs |
node-exporter service external IP addresses | [] |
nodeExporter.service.hostPort |
node-exporter service host port | 9100 |
nodeExporter.service.loadBalancerIP |
IP address to assign to load balancer (if supported) | "" |
nodeExporter.service.loadBalancerSourceRanges |
list of IP CIDRs allowed access to load balancer (if supported) | [] |
nodeExporter.service.servicePort |
node-exporter service port | 9100 |
nodeExporter.service.type |
type of node-exporter service to create | ClusterIP |
pushgateway.enabled |
If true, create pushgateway | true |
pushgateway.name |
pushgateway container name | pushgateway |
pushgateway.image.repository |
pushgateway container image repository | prom/pushgateway |
pushgateway.image.tag |
pushgateway container image tag | v0.6.0 |
pushgateway.image.pullPolicy |
pushgateway container image pull policy | IfNotPresent |
pushgateway.extraArgs |
Additional pushgateway container arguments | {} |
pushgateway.ingress.enabled |
If true, pushgateway Ingress will be created | false |
pushgateway.ingress.annotations |
pushgateway Ingress annotations | {} |
pushgateway.ingress.hosts |
pushgateway Ingress hostnames | [] |
pushgateway.ingress.tls |
pushgateway Ingress TLS configuration (YAML) | [] |
pushgateway.nodeSelector |
node labels for pushgateway pod assignment | {} |
pushgateway.podAnnotations |
annotations to be added to pushgateway pods | {} |
pushgateway.tolerations |
node taints to tolerate (requires Kubernetes >=1.6) | [] |
pushgateway.replicaCount |
desired number of pushgateway pods | 1 |
pushgateway.persistentVolume.enabled |
If true, Prometheus pushgateway will create a Persistent Volume Claim | false |
pushgateway.persistentVolume.accessModes |
Prometheus pushgateway data Persistent Volume access modes | [ReadWriteOnce] |
pushgateway.persistentVolume.annotations |
Prometheus pushgateway data Persistent Volume annotations | {} |
pushgateway.persistentVolume.existingClaim |
Prometheus pushgateway data Persistent Volume existing claim name | "" |
pushgateway.persistentVolume.mountPath |
Prometheus pushgateway data Persistent Volume mount root path | /data |
pushgateway.persistentVolume.size |
Prometheus pushgateway data Persistent Volume size | 2Gi |
pushgateway.persistentVolume.storageClass |
Prometheus server data Persistent Volume Storage Class | unset |
pushgateway.persistentVolume.subPath |
Subdirectory of Prometheus server data Persistent Volume to mount | "" |
pushgateway.priorityClassName |
pushgateway priorityClassName | nil |
pushgateway.resources |
pushgateway pod resource requests & limits | {} |
pushgateway.service.annotations |
annotations for pushgateway service | {} |
pushgateway.service.clusterIP |
internal pushgateway cluster service IP | "" |
pushgateway.service.externalIPs |
pushgateway service external IP addresses | [] |
pushgateway.service.loadBalancerIP |
IP address to assign to load balancer (if supported) | "" |
pushgateway.service.loadBalancerSourceRanges |
list of IP CIDRs allowed access to load balancer (if supported) | [] |
pushgateway.service.servicePort |
pushgateway service port | 9091 |
pushgateway.service.type |
type of pushgateway service to create | ClusterIP |
rbac.create |
If true, create & use RBAC resources | true |
server.name |
Prometheus server container name | server |
server.image.repository |
Prometheus server container image repository | prom/prometheus |
server.image.tag |
Prometheus server container image tag | v2.8.0 |
server.image.pullPolicy |
Prometheus server container image pull policy | IfNotPresent |
server.enableAdminApi |
If true, Prometheus administrative HTTP API will be enabled. Please note, that you should take care of administrative API access protection (ingress or some frontend Nginx with auth) before enabling it. | false |
server.skipTSDBLock |
If true, Prometheus skip TSDB locking. | false |
server.configPath |
Path to a prometheus server config file on the container FS | /etc/config/prometheus.yml |
server.global.scrape_interval |
How frequently to scrape targets by default | 1m |
server.global.scrape_timeout |
How long until a scrape request times out | 10s |
server.global.evaluation_interval |
How frequently to evaluate rules | 1m |
server.extraArgs |
Additional Prometheus server container arguments | {} |
server.prefixURL |
The prefix slug at which the server can be accessed | `` |
server.baseURL |
The external url at which the server can be accessed | `` |
server.env |
Prometheus server environment variables | [] |
server.extraHostPathMounts |
Additional Prometheus server hostPath mounts | [] |
server.extraConfigmapMounts |
Additional Prometheus server configMap mounts | [] |
server.extraSecretMounts |
Additional Prometheus server Secret mounts | [] |
server.extraVolumeMounts |
Additional Prometheus server Volume mounts | [] |
server.extraVolumes |
Additional Prometheus server Volumes | [] |
server.configMapOverrideName |
Prometheus server ConfigMap override where full-name is {{.Release.Name}}-{{.Values.server.configMapOverrideName}} and setting this value will prevent the default server ConfigMap from being generated |
"" |
server.ingress.enabled |
If true, Prometheus server Ingress will be created | false |
server.ingress.annotations |
Prometheus server Ingress annotations | [] |
server.ingress.extraLabels |
Prometheus server Ingress additional labels | {} |
server.ingress.hosts |
Prometheus server Ingress hostnames | [] |
server.ingress.tls |
Prometheus server Ingress TLS configuration (YAML) | [] |
server.nodeSelector |
node labels for Prometheus server pod assignment | {} |
server.tolerations |
node taints to tolerate (requires Kubernetes >=1.6) | [] |
server.affinity |
pod affinity | {} |
server.priorityClassName |
Prometheus server priorityClassName | nil |
server.schedulerName |
Prometheus server alternate scheduler name | nil |
server.persistentVolume.enabled |
If true, Prometheus server will create a Persistent Volume Claim | true |
server.persistentVolume.accessModes |
Prometheus server data Persistent Volume access modes | [ReadWriteOnce] |
server.persistentVolume.annotations |
Prometheus server data Persistent Volume annotations | {} |
server.persistentVolume.existingClaim |
Prometheus server data Persistent Volume existing claim name | "" |
server.persistentVolume.mountPath |
Prometheus server data Persistent Volume mount root path | /data |
server.persistentVolume.size |
Prometheus server data Persistent Volume size | 8Gi |
server.persistentVolume.storageClass |
Prometheus server data Persistent Volume Storage Class | unset |
server.persistentVolume.subPath |
Subdirectory of Prometheus server data Persistent Volume to mount | "" |
server.podAnnotations |
annotations to be added to Prometheus server pods | {} |
server.deploymentAnnotations |
annotations to be added to Prometheus server deployment | `{}' |
server.replicaCount |
desired number of Prometheus server pods | 1 |
server.statefulSet.enabled |
If true, use a statefulset instead of a deployment for pod management | false |
server.statefulSet.annotations |
annotations to be added to Prometheus server stateful set | `{}' |
server.statefulSet.podManagementPolicy |
podManagementPolicy of server pods | OrderedReady |
server.statefulSet.headless.annotations |
annotations for Prometheus server headless service | {} |
server.statefulSet.headless.labels |
labels for Prometheus server headless service | {} |
server.statefulSet.headless.servicePort |
Prometheus server headless service port | 80 |
server.resources |
Prometheus server resource requests and limits | {} |
server.securityContext |
Custom security context for server containers | {} |
server.service.annotations |
annotations for Prometheus server service | {} |
server.service.clusterIP |
internal Prometheus server cluster service IP | "" |
server.service.externalIPs |
Prometheus server service external IP addresses | [] |
server.service.loadBalancerIP |
IP address to assign to load balancer (if supported) | "" |
server.service.loadBalancerSourceRanges |
list of IP CIDRs allowed access to load balancer (if supported) | [] |
server.service.nodePort |
Port to be used as the service NodePort (ignored if server.service.type is not NodePort ) |
0 |
server.service.servicePort |
Prometheus server service port | 80 |
server.service.type |
type of Prometheus server service to create | ClusterIP |
server.sidecarContainers |
array of snippets with your sidecar containers for prometheus server | "" |
serviceAccounts.alertmanager.create |
If true, create the alertmanager service account | true |
serviceAccounts.alertmanager.name |
name of the alertmanager service account to use or create | {{ prometheus.alertmanager.fullname }} |
serviceAccounts.kubeStateMetrics.create |
If true, create the kubeStateMetrics service account | true |
serviceAccounts.kubeStateMetrics.name |
name of the kubeStateMetrics service account to use or create | {{ prometheus.kubeStateMetrics.fullname }} |
serviceAccounts.nodeExporter.create |
If true, create the nodeExporter service account | true |
serviceAccounts.nodeExporter.name |
name of the nodeExporter service account to use or create | {{ prometheus.nodeExporter.fullname }} |
serviceAccounts.pushgateway.create |
If true, create the pushgateway service account | true |
serviceAccounts.pushgateway.name |
name of the pushgateway service account to use or create | {{ prometheus.pushgateway.fullname }} |
serviceAccounts.server.create |
If true, create the server service account | true |
serviceAccounts.server.name |
name of the server service account to use or create | {{ prometheus.server.fullname }} |
server.terminationGracePeriodSeconds |
Prometheus server Pod termination grace period | 300 |
server.retention |
(optional) Prometheus data retention | "" |
serverFiles.alerts |
Prometheus server alerts configuration | {} |
serverFiles.rules |
Prometheus server rules configuration | {} |
serverFiles.prometheus.yml |
Prometheus server scrape configuration | example configuration |
extraScrapeConfigs |
Prometheus server additional scrape configuration | "" |
networkPolicy.enabled |
Enable NetworkPolicy | false |
Specify each parameter using the --set key=value[,key=value]
argument to helm install
. For example,
$ helm install stable/prometheus --name my-release \
--set server.terminationGracePeriodSeconds=360
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
$ helm install stable/prometheus --name my-release -f values.yaml
Tip: You can use the default values.yaml
Roles and RoleBindings resources will be created automatically for server
and kubeStateMetrics
services.
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 to customize your own.
AlertManager is configured through alertmanager.yml. This file (and any others listed in alertmanagerFiles
) will be mounted into the alertmanager
pod.
Prometheus is configured through prometheus.yml. This file (and any others listed in serverFiles
) will be mounted into the server
pod.
If your cluster allows automatic creation/retrieval of TLS certificates (e.g. kube-lego), 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:
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:
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
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.