From 74b9dd78e96b7bb8ceaab3b30735e3fa5097ee85 Mon Sep 17 00:00:00 2001 From: Giancarlo Rubio Date: Fri, 16 Mar 2018 10:46:22 +0100 Subject: [PATCH] Create prometheus postgres exporter chart (#4076) * Create prometheus postgres exporter chart * Apply rbac best pratices for service account * create conditional to create serviceAccount --- .../prometheus-postgres-exporter/.helmignore | 21 +++ .../prometheus-postgres-exporter/Chart.yaml | 14 ++ stable/prometheus-postgres-exporter/README.md | 69 +++++++++ .../templates/NOTES.txt | 15 ++ .../templates/_helpers.tpl | 44 ++++++ .../templates/configmap.yaml | 12 ++ .../templates/deployment.yaml | 68 +++++++++ .../templates/secrets.yaml | 12 ++ .../templates/service.yaml | 19 +++ .../templates/serviceaccount.yaml | 12 ++ .../prometheus-postgres-exporter/values.yaml | 140 ++++++++++++++++++ 11 files changed, 426 insertions(+) create mode 100644 stable/prometheus-postgres-exporter/.helmignore create mode 100644 stable/prometheus-postgres-exporter/Chart.yaml create mode 100644 stable/prometheus-postgres-exporter/README.md create mode 100644 stable/prometheus-postgres-exporter/templates/NOTES.txt create mode 100644 stable/prometheus-postgres-exporter/templates/_helpers.tpl create mode 100644 stable/prometheus-postgres-exporter/templates/configmap.yaml create mode 100644 stable/prometheus-postgres-exporter/templates/deployment.yaml create mode 100644 stable/prometheus-postgres-exporter/templates/secrets.yaml create mode 100644 stable/prometheus-postgres-exporter/templates/service.yaml create mode 100644 stable/prometheus-postgres-exporter/templates/serviceaccount.yaml create mode 100644 stable/prometheus-postgres-exporter/values.yaml diff --git a/stable/prometheus-postgres-exporter/.helmignore b/stable/prometheus-postgres-exporter/.helmignore new file mode 100644 index 0000000000..f0c1319444 --- /dev/null +++ b/stable/prometheus-postgres-exporter/.helmignore @@ -0,0 +1,21 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj diff --git a/stable/prometheus-postgres-exporter/Chart.yaml b/stable/prometheus-postgres-exporter/Chart.yaml new file mode 100644 index 0000000000..7fcab2e2d0 --- /dev/null +++ b/stable/prometheus-postgres-exporter/Chart.yaml @@ -0,0 +1,14 @@ +apiVersion: v1 +appVersion: "0.4.4" +description: A Helm chart for prometheus postgres-exporter +name: prometheus-postgres-exporter +version: 0.1.0 +sources: +- https://github.com/wrouesnel/postgres_exporter +keywords: +- postgresql +- prometheus +- exporter +maintainers: +- email: gianrubio@gmail.com + name: gianrubio diff --git a/stable/prometheus-postgres-exporter/README.md b/stable/prometheus-postgres-exporter/README.md new file mode 100644 index 0000000000..fc572044a5 --- /dev/null +++ b/stable/prometheus-postgres-exporter/README.md @@ -0,0 +1,69 @@ +# Prometheus Postgres Exporter + +* Installs prometheus [postgres exporter](https://github.com/wrouesnel/postgres_exporter) + +## TL;DR; + +```console +$ helm install stable/prometheus-postgres-exporter +``` + +## Introduction + +This chart bootstraps a prometheus [postgres exporter](http://github.com/prometheus/postgres_exporter) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +$ helm install --name my-release stable/prometheus-postgres-exporter +``` + +The command deploys postgres exporter on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +$ helm delete my-release +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration + +The following tables lists the configurable parameters of the postgres Exporter chart and their default values. + +| Parameter | Description | Default | +| ------------------------------- | ------------------------------------------ | ---------------------------------------------------------- | +| `image` | Image | `wrouesnel/postgres_exporter` | +| `imageTag` | Image tag | `v0.4.4` | +| `imagePullPolicy` | Image pull policy | `IfNotPresent` | +| `service.type` | Service type | `ClusterIP` | +| `service.port` | The service port | `80` | +| `service.targetPort` | The target port of the container | `9187` | +| `resources` | | `{}` | +| `config.datasource` | Postgresql datasource configuration | | +| `config.queries` | SQL queries that the exporter will run | [postgres exporter defaults](https://github.com/wrouesnel/postgres_exporter/blob/master/queries.yaml) | +| `serviceAccount.create` | Specifies whether a service account should be created.| `true` | +| `serviceAccount.name` | Name of the service account.| | +| `tolerations` | Add tolerations | `[]` | +| `nodeSelector` | node labels for pod assignment | `{}` | +| `affinity` | node/pod affinities | `{}` | + + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```console +$ helm install --name my-release \ + --set serviceAccount.name=postgres \ + stable/prometheus-postgres-exporter +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +```console +$ helm install --name my-release -f values.yaml stable/prometheus-postgres-exporter +``` diff --git a/stable/prometheus-postgres-exporter/templates/NOTES.txt b/stable/prometheus-postgres-exporter/templates/NOTES.txt new file mode 100644 index 0000000000..1beb2698cd --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/NOTES.txt @@ -0,0 +1,15 @@ +1. Get the application URL by running these commands: +{{- if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "prometheus-postgres-exporter.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get svc -w {{ template "prometheus-postgres-exporter.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "prometheus-postgres-exporter.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "prometheus-postgres-exporter.name" . }},release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/stable/prometheus-postgres-exporter/templates/_helpers.tpl b/stable/prometheus-postgres-exporter/templates/_helpers.tpl new file mode 100644 index 0000000000..c56c4fd4b5 --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/_helpers.tpl @@ -0,0 +1,44 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "prometheus-postgres-exporter.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "prometheus-postgres-exporter.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "prometheus-postgres-exporter.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} + + +{{/* +Create the name of the service account to use +*/}} +{{- define "prometheus-postgres-exporter.serviceAccountName" -}} +{{- if .Values.serviceAccount.create -}} + {{ default (include "prometheus-postgres-exporter.fullname" .) .Values.serviceAccount.name }} +{{- else -}} + {{ default "default" .Values.serviceAccount.name }} +{{- end -}} +{{- end -}} \ No newline at end of file diff --git a/stable/prometheus-postgres-exporter/templates/configmap.yaml b/stable/prometheus-postgres-exporter/templates/configmap.yaml new file mode 100644 index 0000000000..52467b6faf --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/configmap.yaml @@ -0,0 +1,12 @@ +apiVersion: v1 +kind: ConfigMap +metadata: + name: {{ template "prometheus-postgres-exporter.fullname" . }} + labels: + app: {{ template "prometheus-postgres-exporter.name" . }} + chart: {{ template "prometheus-postgres-exporter.chart" . }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +data: + config.yaml: | +{{ printf .Values.config.queries | indent 4 }} \ No newline at end of file diff --git a/stable/prometheus-postgres-exporter/templates/deployment.yaml b/stable/prometheus-postgres-exporter/templates/deployment.yaml new file mode 100644 index 0000000000..4e88fd28a9 --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/deployment.yaml @@ -0,0 +1,68 @@ +apiVersion: apps/v1beta2 +kind: Deployment +metadata: + name: {{ template "prometheus-postgres-exporter.fullname" . }} + labels: + app: {{ template "prometheus-postgres-exporter.name" . }} + chart: {{ template "prometheus-postgres-exporter.chart" . }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + app: {{ template "prometheus-postgres-exporter.name" . }} + release: {{ .Release.Name }} + template: + metadata: + labels: + app: {{ template "prometheus-postgres-exporter.name" . }} + release: {{ .Release.Name }} + annotations: + checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }} + spec: + serviceAccountName: {{ template "prometheus-postgres-exporter.serviceAccountName" . }} + containers: + - name: {{ .Chart.Name }} + env: + - name: DATA_SOURCE_NAME + valueFrom: + secretKeyRef: + key: data_source_name + name: {{ template "prometheus-postgres-exporter.fullname" . }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.service.targetPort }} + protocol: TCP + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + resources: +{{ toYaml .Values.resources | indent 12 }} + volumeMounts: + - name: queries + mountPath: /etc + {{- with .Values.nodeSelector }} + nodeSelector: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: +{{ toYaml . | indent 8 }} + {{- end }} + volumes: + - configMap: + defaultMode: 420 + name: {{ template "prometheus-postgres-exporter.fullname" . }} + name: queries \ No newline at end of file diff --git a/stable/prometheus-postgres-exporter/templates/secrets.yaml b/stable/prometheus-postgres-exporter/templates/secrets.yaml new file mode 100644 index 0000000000..cf8fe2f540 --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/secrets.yaml @@ -0,0 +1,12 @@ +apiVersion: v1 +kind: Secret +metadata: + name: {{ template "prometheus-postgres-exporter.fullname" . }} + labels: + app: {{ template "prometheus-postgres-exporter.name" . }} + chart: {{ template "prometheus-postgres-exporter.chart" . }} + heritage: {{ .Release.Service }} + release: {{ .Release.Name }} +type: Opaque +data: + data_source_name: "{{ printf "postgresql://%s:%s@%s:%s/?sslmode=%s" .Values.config.datasource.user .Values.config.datasource.password .Values.config.datasource.host .Values.config.datasource.port .Values.config.datasource.sslmode | b64enc }}" diff --git a/stable/prometheus-postgres-exporter/templates/service.yaml b/stable/prometheus-postgres-exporter/templates/service.yaml new file mode 100644 index 0000000000..309227a343 --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/service.yaml @@ -0,0 +1,19 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ template "prometheus-postgres-exporter.fullname" . }} + labels: + app: {{ template "prometheus-postgres-exporter.name" . }} + chart: {{ template "prometheus-postgres-exporter.chart" . }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: {{ .Values.service.targetPort }} + protocol: TCP + name: http + selector: + app: {{ template "prometheus-postgres-exporter.name" . }} + release: {{ .Release.Name }} diff --git a/stable/prometheus-postgres-exporter/templates/serviceaccount.yaml b/stable/prometheus-postgres-exporter/templates/serviceaccount.yaml new file mode 100644 index 0000000000..23c98ba415 --- /dev/null +++ b/stable/prometheus-postgres-exporter/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ template "prometheus-postgres-exporter.serviceAccountName" . }} + labels: + app: {{ template "prometheus-postgres-exporter.name" . }} + chart: {{ template "prometheus-postgres-exporter.chart" . }} + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +{{- end -}} + \ No newline at end of file diff --git a/stable/prometheus-postgres-exporter/values.yaml b/stable/prometheus-postgres-exporter/values.yaml new file mode 100644 index 0000000000..63e968294c --- /dev/null +++ b/stable/prometheus-postgres-exporter/values.yaml @@ -0,0 +1,140 @@ +# Default values for prometheus-postgres-exporter. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: wrouesnel/postgres_exporter + tag: v0.4.4 + pullPolicy: IfNotPresent + +service: + type: ClusterIP + port: 80 + targetPort: 9187 + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +serviceAccount: + # Specifies whether a ServiceAccount should be created + create: true + # The name of the ServiceAccount to use. + # If not set and create is true, a name is generated using the fullname template + name: + +config: + datasource: + host: + user: + password: + port: "5432" + sslmode: disable + # this are the defaults queries that the exporter will run, extracted from: https://github.com/wrouesnel/postgres_exporter/blob/master/queries.yaml + queries: |- + pg_replication: + query: "SELECT EXTRACT(EPOCH FROM (now() - pg_last_xact_replay_timestamp()))::INT as lag" + metrics: + - lag: + usage: "GAUGE" + description: "Replication lag behind master in seconds" + + pg_postmaster: + query: "SELECT pg_postmaster_start_time as start_time_seconds from pg_postmaster_start_time()" + metrics: + - start_time_seconds: + usage: "GAUGE" + description: "Time at which postmaster started" + + pg_stat_user_tables: + query: "SELECT schemaname, relname, seq_scan, seq_tup_read, idx_scan, idx_tup_fetch, n_tup_ins, n_tup_upd, n_tup_del, n_tup_hot_upd, n_live_tup, n_dead_tup, n_mod_since_analyze, last_vacuum, last_autovacuum, last_analyze, last_autoanalyze, vacuum_count, autovacuum_count, analyze_count, autoanalyze_count FROM pg_stat_user_tables" + metrics: + - schemaname: + usage: "LABEL" + description: "Name of the schema that this table is in" + - relname: + usage: "LABEL" + description: "Name of this table" + - seq_scan: + usage: "COUNTER" + description: "Number of sequential scans initiated on this table" + - seq_tup_read: + usage: "COUNTER" + description: "Number of live rows fetched by sequential scans" + - idx_scan: + usage: "COUNTER" + description: "Number of index scans initiated on this table" + - idx_tup_fetch: + usage: "COUNTER" + description: "Number of live rows fetched by index scans" + - n_tup_ins: + usage: "COUNTER" + description: "Number of rows inserted" + - n_tup_upd: + usage: "COUNTER" + description: "Number of rows updated" + - n_tup_del: + usage: "COUNTER" + description: "Number of rows deleted" + - n_tup_hot_upd: + usage: "COUNTER" + description: "Number of rows HOT updated (i.e., with no separate index update required)" + - n_live_tup: + usage: "GAUGE" + description: "Estimated number of live rows" + - n_dead_tup: + usage: "GAUGE" + description: "Estimated number of dead rows" + - n_mod_since_analyze: + usage: "GAUGE" + description: "Estimated number of rows changed since last analyze" + - last_vacuum: + usage: "GAUGE" + description: "Last time at which this table was manually vacuumed (not counting VACUUM FULL)" + - last_autovacuum: + usage: "GAUGE" + description: "Last time at which this table was vacuumed by the autovacuum daemon" + - last_analyze: + usage: "GAUGE" + description: "Last time at which this table was manually analyzed" + - last_autoanalyze: + usage: "GAUGE" + description: "Last time at which this table was analyzed by the autovacuum daemon" + - vacuum_count: + usage: "COUNTER" + description: "Number of times this table has been manually vacuumed (not counting VACUUM FULL)" + - autovacuum_count: + usage: "COUNTER" + description: "Number of times this table has been vacuumed by the autovacuum daemon" + - analyze_count: + usage: "COUNTER" + description: "Number of times this table has been manually analyzed" + - autoanalyze_count: + usage: "COUNTER" + description: "Number of times this table has been analyzed by the autovacuum daemon" + + pg_database: + query: " SELECT pg_database.datname, pg_database_size(pg_database.datname) as size FROM pg_database" + metrics: + - datname: + usage: "LABEL" + description: "Name of the database" + - size: + usage: "GAUGE" + description: "Disk space used by the database" + +nodeSelector: {} + +tolerations: [] + +affinity: {}