[vmware-exporter] Improve Grafana dashboards

* [vmware-exporter] New Chart

* Update repo README

README.md

@@ -28,7 +28,8 @@ See [charts folder](./charts) for a complete list.
 * [zigbee2mqttassistant](./charts/zigbee2mqttassistant) - A WebUI for Zigbee2MQTT.
 * [hg612-exporter](./charts/hg612-exporter) - A Prometheus exporter for HG612 xDSL Modems.
 * [aaisp-exporter](./charts/aaisp-exporter) - A Prometheus exporter for [Andrews & Arnold](https://www.aa.net.uk/) CHAOSv2 API.
-* [plex-exporter](./charts/plex-exporter) - A Prometheus exporter for Plex Media Server
+* [plex-exporter](./charts/plex-exporter) - A Prometheus exporter for Plex Media Server.
+* [vmware-exporter](./charts/vmware-exporter) - A Prometheus exporter for VMware vSphere.
 
 ## License
 

charts/plex-exporter/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: 0.2.2
 description: A prometheus exporter for Plex Media Server
 name: plex-exporter
-version: 0.0.2
+version: 0.0.3
 kubeVersion: ">=1.16.0-0"
 keywords:
   - plex-exporter

charts/plex-exporter/README.md

@@ -1,6 +1,6 @@
 # plex-exporter
 
-![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![AppVersion: 0.2.2](https://img.shields.io/badge/AppVersion-0.2.2-informational?style=flat-square)
+![Version: 0.0.3](https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square) ![AppVersion: 0.2.2](https://img.shields.io/badge/AppVersion-0.2.2-informational?style=flat-square)
 
 A prometheus exporter for Plex Media Server
 
@@ -98,6 +98,34 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [0.0.3]
+
+#### Added
+
+- N/A
+
+#### Changed
+
+- Fixed autodiscovery configuration issues when using `envFrom`
+
+#### Removed
+
+- N/A
+
+### [0.0.2]
+
+#### Added
+
+- Support for auto discovery
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
 ### [0.0.1]
 
 #### Added

charts/plex-exporter/README_CHANGELOG.md.gotmpl

@@ -9,6 +9,20 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [0.0.3]
+
+#### Added
+
+- N/A
+
+#### Changed
+
+- Fixed autodiscovery configuration issues when using `envFrom`
+
+#### Removed
+
+- N/A
+
 ### [0.0.2]
 
 #### Added

charts/plex-exporter/ci/autodiscovery-env.yml

@@ -0,0 +1,5 @@
+---
+env:
+  PLEX_TOKEN: a0a0a0a0a
+plex:
+  autodiscover: true

charts/plex-exporter/ci/autodiscovery.yml

@@ -1,4 +1,4 @@
 ---
 plex:
-  server: test
+  autodiscover: true
   token: a0a0a0a0a0

charts/plex-exporter/templates/common.yaml

@@ -4,16 +4,16 @@
 {{/* Append the hardcoded settings */}}
 {{- define "plex-exporter.harcodedValues" -}}
 args:
-  {{- if .Values.plex.autodiscover -}}
-  - "--auto-discover"
-  {{- else -}}
+  {{ if .Values.plex.server }}
   - "--plex-server"
   - "{{ .Values.plex.server }}"
-  {{- end -}}
-  {{- if .Values.plex.token -}}
+  {{ else }}
+  - "--auto-discover"
+  {{ end }}
+  {{ if .Values.plex.token }}
   - "--token"
   - "{{ .Values.plex.token }}"
-  {{- end -}}
+  {{ end }}
 {{- end -}}
 {{- $_ := mergeOverwrite .Values (include "plex-exporter.harcodedValues" . | fromYaml) -}}
 

charts/vmware-exporter/.helmignore

@@ -0,0 +1,26 @@
+# 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
+.vscode/
+# OWNERS file for Kubernetes
+OWNERS
+# helm-docs templates
+*.gotmpl

charts/vmware-exporter/Chart.yaml

@@ -0,0 +1,19 @@
+apiVersion: v2
+appVersion: 0.18.2
+description: A prometheus exporter for vSphere vCenter
+name: vmware-exporter
+version: 0.1.1
+kubeVersion: ">=1.16.0-0"
+keywords:
+- vmware-exporter
+home: https://github.com/nikdoof/helm-charts/tree/master/charts/vmware-exporter
+sources:
+- https://github.com/pryorda/vmware_exporter
+- https://hub.docker.com/r/pryorda/vmware_exporter/tags
+maintainers:
+- name: nikdoof
+  email: andy@tensixtyone.com
+dependencies:
+- name: common
+  repository: https://library-charts.k8s-at-home.com
+  version: 4.2.0

charts/vmware-exporter/README.md

@@ -0,0 +1,149 @@
+# vmware-exporter
+
+![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![AppVersion: 0.18.2](https://img.shields.io/badge/AppVersion-0.18.2-informational?style=flat-square)
+
+A prometheus exporter for vSphere vCenter
+
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/nikdoof/helm-charts/issues/new/choose)**
+
+## Source Code
+
+* <https://github.com/pryorda/vmware_exporter>
+* <https://hub.docker.com/r/pryorda/vmware_exporter/tags>
+
+## Requirements
+
+Kubernetes: `>=1.16.0-0`
+
+## Dependencies
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://library-charts.k8s-at-home.com | common | 4.2.0 |
+
+## TL;DR
+
+```console
+helm repo add nikdoof-helm-charts https://nikdoof.github.io/helm-charts/
+helm repo update
+helm install vmware-exporter nikdoof-helm-charts/vmware-exporter
+```
+
+## Installing the Chart
+
+To install the chart with the release name `vmware-exporter`
+
+```console
+helm install vmware-exporter nikdoof-helm-charts/vmware-exporter
+```
+
+## Uninstalling the Chart
+
+To uninstall the `vmware-exporter` deployment
+
+```console
+helm uninstall vmware-exporter
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+
+## Configuration
+
+Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install vmware-exporter \
+  --set modem.host="192.168.1.1"\
+    nikdoof-helm-charts/vmware-exporter
+```
+
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install vmware-exporter nikdoof-helm-charts/vmware-exporter -f values.yaml
+```
+
+## Custom configuration
+
+N/A
+
+## Values
+
+**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| env | object | See below | environment variables. See more environment variables in the [vmware-exporter documentation](https://github.com/pryorda/vmware_exporter). |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
+| image.repository | string | `"pryorda/vmware_exporter"` | image repository |
+| image.tag | string | `"v0.18.2"` | image tag |
+| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
+| metrics.dashboards | object | See values.yaml | Enable and configure Grafana dashboard ConfigMaps for the chart under this key. |
+| metrics.dashboards.namespace | string | `nil` | Namespace to create the dashboards ConfigMap under. |
+| metrics.enabled | bool | See values.yaml | Enable and configure a Prometheus serviceMonitor for the chart under this key. |
+| metrics.prometheusRule | object | See values.yaml | Enable and configure Prometheus Rules for the chart under this key. |
+| metrics.prometheusRule.rules | list | See prometheusrules.yaml | Configure additionial rules for the chart under this key. |
+| metrics.serviceMonitor.interval | string | `"1m"` |  |
+| metrics.serviceMonitor.labels | object | `{}` |  |
+| metrics.serviceMonitor.scrapeTimeout | string | `"30s"` |  |
+| service | object | See values.yaml | Configures service settings for the chart. |
+
+## Changelog
+
+All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### [0.1.1]
+
+#### Added
+
+- N/A
+
+#### Changed
+
+- Improved dashboard naming and tagging, re-saved on Grafana 8.3.
+
+#### Removed
+
+- N/A
+
+### [0.1.0]
+
+#### Added
+
+- Create a Grafana dashboard ConfigMap when `metrics.dashboards.create` is `true`
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[0.0.1]: #100
+
+### [0.0.1]
+
+#### Added
+
+- Initial version
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+## Support
+
+- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose)
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

charts/vmware-exporter/README.md.gotmpl

@@ -0,0 +1,143 @@
+{{- define "custom.repository.organization" -}}
+nikdoof-helm-charts
+{{- end -}}
+
+{{- define "custom.repository.url" -}}
+https://github.com/nikdoof/helm-charts
+{{- end -}}
+
+{{- define "custom.helm.url" -}}
+https://nikdoof.github.io/helm-charts/
+{{- end -}}
+
+{{- define "custom.helm.path" -}}
+{{ template "custom.repository.organization" . }}/{{ template "chart.name" . }}
+{{- end -}}
+
+{{- define "custom.notes" -}}
+**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/nikdoof/helm-charts/issues/new/choose)**
+{{- end -}}
+
+{{- define "custom.requirements" -}}
+## Requirements
+
+{{ template "chart.kubeVersionLine" . }}
+{{- end -}}
+
+{{- define "custom.dependencies" -}}
+## Dependencies
+
+{{ template "chart.requirementsTable" . }}
+{{- end -}}
+
+{{- define "custom.install.tldr" -}}
+## TL;DR
+
+```console
+helm repo add {{ template "custom.repository.organization" . }} {{ template "custom.helm.url" . }}
+helm repo update
+helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
+```
+{{- end -}}
+
+{{- define "custom.install" -}}
+## Installing the Chart
+
+To install the chart with the release name `{{ template "chart.name" . }}`
+
+```console
+helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
+```
+{{- end -}}
+
+{{- define "custom.uninstall" -}}
+## Uninstalling the Chart
+
+To uninstall the `{{ template "chart.name" . }}` deployment
+
+```console
+helm uninstall {{ template "chart.name" . }}
+```
+
+The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
+{{- end -}}
+
+{{- define "custom.configuration.header" -}}
+## Configuration
+{{- end -}}
+
+{{- define "custom.configuration.readValues" -}}
+Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+Other values may be used from the [values.yaml](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
+{{- end -}}
+
+{{- define "custom.configuration.example.set" -}}
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+```console
+helm install {{ template "chart.name" . }} \
+  --set modem.host="192.168.1.1"\
+    {{ template "custom.helm.path" . }}
+```
+{{- end -}}
+
+{{- define "custom.configuration.example.file" -}}
+Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
+
+```console
+helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -f values.yaml
+```
+{{- end -}}
+
+{{- define "custom.valuesSection" -}}
+## Values
+
+**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
+
+{{ template "chart.valuesTable" . }}
+{{- end -}}
+
+{{- define "custom.support" -}}
+## Support
+
+- Open an [issue](https://github.com/nikdoof/helm-charts/issues/new/choose)
+{{- end -}}
+
+{{ template "chart.header" . }}
+
+{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "custom.notes" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "custom.requirements" . }}
+
+{{ template "custom.dependencies" . }}
+
+{{ template "custom.install.tldr" . }}
+
+{{ template "custom.install" . }}
+
+{{ template "custom.uninstall" . }}
+
+{{ template "custom.configuration.header" . }}
+
+{{ template "custom.configuration.readValues" . }}
+
+{{ template "custom.configuration.example.set" . }}
+
+{{ template "custom.configuration.example.file" . }}
+
+{{ template "custom.custom.configuration" . }}
+
+{{ template "custom.valuesSection" . }}
+
+{{ template "custom.changelog" . }}
+
+{{ template "custom.support" . }}
+
+{{ template "helm-docs.versionFooter" . }}
+{{ "" }}

charts/vmware-exporter/README_CHANGELOG.md.gotmpl

@@ -0,0 +1,56 @@
+{{- define "custom.changelog.header" -}}
+## Changelog
+{{- end -}}
+
+{{- define "custom.changelog" -}}
+{{ template "custom.changelog.header" . }}
+
+All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common#changelog).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### [0.1.1]
+
+#### Added
+
+- N/A
+
+#### Changed
+
+- Improved dashboard naming and tagging, re-saved on Grafana 8.3.
+
+#### Removed
+
+- N/A
+
+### [0.1.0]
+
+#### Added
+
+- Create a Grafana dashboard ConfigMap when `metrics.dashboards.create` is `true`
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+[0.0.1]: #100
+
+### [0.0.1]
+
+#### Added
+
+- Initial version
+
+#### Changed
+
+- N/A
+
+#### Removed
+
+- N/A
+
+{{- end -}}

charts/vmware-exporter/README_CONFIG.md.gotmpl

@@ -0,0 +1,9 @@
+{{- define "custom.custom.configuration.header" -}}
+## Custom configuration
+{{- end -}}
+
+{{- define "custom.custom.configuration" -}}
+{{ template "custom.custom.configuration.header" . }}
+
+N/A
+{{- end -}}

charts/vmware-exporter/ci/test-values.yaml

@@ -0,0 +1,9 @@
+---
+env:
+  VSPHERE_USER: administrator@vsphere.my.domain.com
+  VSPHERE_PASSWORD: Secure-Pass
+  VSPHERE_HOST: test
+metrics:
+  enabled: true
+  dashboards:
+    create: true

charts/vmware-exporter/templates/NOTES.txt

@@ -0,0 +1 @@
+{{- include "common.notes.defaultNotes" . -}}

charts/vmware-exporter/templates/common.yaml

@@ -0,0 +1 @@
+{{ include "common.all" . }}

charts/vmware-exporter/templates/dashboard-configmap.yaml

@@ -0,0 +1,19 @@
+{{- if and .Values.metrics.enabled .Values.metrics.dashboards.create }}
+{{- $namespace := .Values.metrics.dashboards.namespace | default $.Release.Namespace }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "common.names.fullname" . }}
+  namespace: {{ $namespace }}
+  labels:
+    {{- include "common.labels" . | nindent 4 }}
+    {{- with .Values.metrics.dashboards.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+data:
+{{- range $path, $_ :=  .Files.Glob  "dashboards/*.json" }}
+{{- $filename := trimSuffix (ext $path) (base $path) }}
+  {{ base $path }}: |-
+{{ $.Files.Get $path | indent 4 }}
+{{- end }}
+{{- end }}

charts/vmware-exporter/templates/prometheusrules.yaml

@@ -0,0 +1,27 @@
+{{- if and .Values.metrics.enabled .Values.metrics.prometheusRule.enabled }}
+apiVersion: monitoring.coreos.com/v1
+kind: PrometheusRule
+metadata:
+  name: {{ include "common.names.fullname" . }}
+  labels:
+    {{- include "common.labels" . | nindent 4 }}
+    {{- with .Values.metrics.prometheusRule.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  groups:
+    - name: {{ include "common.names.fullname" . }}
+      rules:
+        - alert: VmwareExporterAbsent
+          annotations:
+            description: Vmware Exporter has disappeared from Prometheus service discovery.
+            summary: Vmware Exporter is down.
+          expr: |
+            absent(up{job=~".*{{ include "common.names.fullname" . }}.*"} == 1)
+          for: 5m
+          labels:
+            severity: critical
+        {{- with .Values.metrics.prometheusRule.rules }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+{{- end }}

charts/vmware-exporter/templates/servicemonitor.yaml

@@ -0,0 +1,24 @@
+{{- if .Values.metrics.enabled }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "common.names.fullname" . }}
+  labels:
+    {{- include "common.labels" . | nindent 4 }}
+    {{- with .Values.metrics.serviceMonitor.labels }}
+    {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "common.labels.selectorLabels" . | nindent 6 }}
+  endpoints:
+    - port: metrics
+      {{- with .Values.metrics.serviceMonitor.interval }}
+      interval: {{ . }}
+      {{- end }}
+      {{- with .Values.metrics.serviceMonitor.scrapeTimeout }}
+      scrapeTimeout: {{ . }}
+      {{- end }}
+      path: /metrics
+{{- end }}

charts/vmware-exporter/values.yaml

@@ -0,0 +1,75 @@
+#
+# IMPORTANT NOTE
+#
+# This chart inherits from our common library chart. You can check the default values/options here:
+# https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
+#
+
+image:
+  # -- image repository
+  repository: pryorda/vmware_exporter
+  # -- image tag
+  tag: v0.18.2
+  # -- image pull policy
+  pullPolicy: IfNotPresent
+
+# -- environment variables. See more environment variables in the [vmware-exporter documentation](https://github.com/pryorda/vmware_exporter).
+# @default -- See below
+env:
+  VSPHERE_IGNORE_SSL: "True"
+  VSPHERE_COLLECT_HOSTS: "True"
+  VSPHERE_COLLECT_DATASTORES: "True"
+  VSPHERE_COLLECT_VMS: "True"
+
+# -- Configures service settings for the chart.
+# @default -- See values.yaml
+service:
+  main:
+    ports:
+      http:
+        enabled: false
+      metrics:
+        enabled: true
+        protocol: TCP
+        port: 9272
+
+ingress:
+  # -- Enable and configure ingress settings for the chart under this key.
+  # @default -- See values.yaml
+  main:
+    enabled: false
+
+metrics:
+  # -- Enable and configure a Prometheus serviceMonitor for the chart under this key.
+  # @default -- See values.yaml
+  enabled: false
+  serviceMonitor:
+    interval: 1m
+    scrapeTimeout: 30s
+    labels: {}
+  # -- Enable and configure Prometheus Rules for the chart under this key.
+  # @default -- See values.yaml
+  prometheusRule:
+    enabled: false
+    labels: {}
+    # -- Configure additionial rules for the chart under this key.
+    # @default -- See prometheusrules.yaml
+    rules: []
+      # - alert: vmwareExporterAbsent
+      #   annotations:
+      #     description: vmware Exporter has disappeared from Prometheus service discovery.
+      #     summary: vmware Exporter is down.
+      #   expr: |
+      #     absent(up{job=~".*vmwareexporter.*"} == 1)
+      #   for: 5m
+      #   labels:
+      #     severity: critical
+  # -- Enable and configure Grafana dashboard ConfigMaps for the chart under this key.
+  # @default -- See values.yaml
+  dashboards:
+    create: false
+    # -- Namespace to create the dashboards ConfigMap under.
+    # @default -- The release's namespace
+    namespace:
+    labels:
+      grafana_dashboard: "true"