Update Helm Chart for v3 (#195)

Update the Helm chart for the next major version of the Script Exporter.

Author: ricoberger

.github/workflows/continuous-delivery.yaml

@@ -136,6 +136,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Lint
+        run: |
+          helm lint ./charts/script-exporter
+
+      - name: Template
+        run: |
+          helm template ./charts/script-exporter
+
       - name: Set Version
         id: version
         run: |

charts/script-exporter/Chart.yaml

@@ -5,5 +5,5 @@ description:
   Prometheus exporter to execute scripts and collect metrics from the output or
   the exit status.
 type: application
-version: 2.0.3
-appVersion: v2.24.3
+version: 3.0.0
+appVersion: v3.0.0

charts/script-exporter/templates/configmap.yaml

@@ -5,7 +5,7 @@ metadata:
   labels:
     {{- include "script-exporter.labels" . | nindent 4 }}
 data:
-  config.yaml: |
+  scripts.yaml: |
 {{ tpl .Values.config . | indent 4 }}
 
 {{- with .Values.scripts }}

charts/script-exporter/templates/deployment.yaml

@@ -37,8 +37,10 @@ spec:
           env:
             {{- toYaml . | nindent 12 }}
           {{- end }}
+          {{- with .Values.args }}
           args:
-            - -config.file={{ .Values.configFile | default "/etc/script-exporter/config.yaml" }}
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
           ports:
             - name: http
               containerPort: 9469
@@ -55,7 +57,7 @@ spec:
             {{- toYaml .Values.resources | nindent 12 }}
           volumeMounts:
             - name: config
-              mountPath: /etc/script-exporter
+              mountPath: /script_exporter/scripts
               readOnly: true
             {{- if .Values.volumeMounts }}
             {{- toYaml .Values.volumeMounts | nindent 12 }}

charts/script-exporter/values.yaml

@@ -1,4 +1,4 @@
-# Default values for script_exporter.
+# Default values for Script Exporter.
 # This is a YAML-formatted file.
 # Declare variables to be passed into your templates.
 
@@ -10,34 +10,32 @@ fullnameOverride: ""
 ##
 replicaCount: 1
 
-## Specify a list of image pull secrets, to avoid the DockerHub rate limit or to pull the script_exporter image from a
+## Specify a list of image pull secrets, to avoid the DockerHub rate limit or to pull the Script Exporter image from a
 ## private registry.
 ## See: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
 ##
 imagePullSecrets: []
 
-## Set the image which should be used for script_exporter.
+## Set the image which should be used for Script Exporter.
 ##
 image:
   repository: ghcr.io/ricoberger/script_exporter
   pullPolicy: IfNotPresent
   # Overrides the image tag whose default is the chart appVersion.
   tag: ""
 
-## Specify security settings for the created Pods. To set the security settings for the script_exporter Container use
+## Specify security settings for the created Pods. To set the security settings for the Script Exporter Container use
 ## the corresponding "securityContext" field.
 ## See: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod
 ##
-podSecurityContext:
-  {}
+podSecurityContext: {}
   # fsGroup: 2000
 
-## Specify security settings for the script_exporter Container. They override settings made at the Pod level via the
+## Specify security settings for the Script Exporter Container. They override settings made at the Pod level via the
 ## "podSecurityContext" when there is overlap.
 ## See: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container
 ##
-securityContext:
-  {}
+securityContext: {}
   # capabilities:
   #   drop:
   #   - ALL
@@ -50,8 +48,7 @@ securityContext:
 ## specify resources, uncomment the following lines, adjust them as necessary, and remove the curly braces after
 ## 'resources:'.
 ##
-resources:
-  {}
+resources: {}
   # limits:
   #   cpu: 100m
   #   memory: 128Mi
@@ -64,50 +61,51 @@ resources:
 ##
 nodeSelector: {}
 
-## Specify the tolerations for the script_exporter Pods.
+## Specify the tolerations for the Script Exporter Pods.
 ## See: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
 ##
 tolerations: []
 
-## Specify a node affinity or inter-pod affinity / anti-affinity for an advanced scheduling of the script_exporter Pods.
+## Specify a node affinity or inter-pod affinity / anti-affinity for an advanced scheduling of the Script Exporter Pods.
 ## See: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity
 ##
 affinity: {}
 
 ## Topology spread constraints rely on node labels to identify the topology domain(s) that each Node is in.
 ## See: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
 ##
-topologySpreadConstraints:
-  []
+topologySpreadConstraints: []
   # - maxSkew: 1
   #   topologyKey: topology.kubernetes.io/zone
   #   whenUnsatisfiable: DoNotSchedule
   #   labelSelector:
   #     matchLabels:
   #       app.kubernetes.io/name=hub
 
-## Specify additional volumes for the script_exporter deployment.
+## Specify additional volumes for the Script Exporter deployment.
 ## See: https://kubernetes.io/docs/concepts/storage/volumes/
 ##
-volumes:
-  []
+volumes: []
   # - name: scripts
   #   configMap:
   #     name: scripts
 
-## Specify additional volumeMounts for the script_exporter container.
+## Specify additional volumeMounts for the Script Exporter container.
 ## See: https://kubernetes.io/docs/concepts/storage/volumes/
 ##
-volumeMounts:
-  []
+volumeMounts: []
   # - name: scripts
-  #   mountPath: /scripts
+  #   mountPath: /script_exporter/scripts
   #   readOnly: true
 
-## Specify additional environment variables for the script_exporter container.
+## Specify additional arguments for the Script Exporter container.
 ##
-env:
-  []
+args:
+  - --config.files=/script_exporter/scripts/scripts.yaml
+
+## Specify additional environment variables for the Script Exporter container.
+##
+env: []
   # - name: MY_ENV_VAR
   #   value: MY_ENV_VALUE
 
@@ -168,17 +166,15 @@ serviceMonitor:
 
   ## MetricRelabelConfigs to apply to samples before ingestion.
   ##
-  metricRelabelings:
-    []
+  metricRelabelings: []
     # - action: keep
     #   regex: 'kube_(daemonset|deployment|pod|namespace|node|statefulset).+'
     #   sourceLabels: [__name__]
 
   ## RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few
   ## standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name.
   ##
-  relabelings:
-    []
+  relabelings: []
     # - sourceLabels: [__meta_kubernetes_pod_node_name]
     #   separator: ;
     #   regex: ^(.*)$
@@ -192,8 +188,7 @@ serviceMonitor:
   autoCreate:
     enabled: true
 
-  targets:
-    []
+  targets: []
     # - name: example                    # Human readable URL that will appear in Prometheus / AlertManager
     #   script: ping                     # Name of the script to target.
     #   labels: {}                       # Map of labels for ServiceMonitor. Overrides value set in `defaults`
@@ -234,40 +229,38 @@ selfServiceMonitor:
 
   ## MetricRelabelConfigs to apply to samples before ingestion.
   ##
-  metricRelabelings:
-    []
+  metricRelabelings: []
     # - action: keep
     #   regex: 'kube_(daemonset|deployment|pod|namespace|node|statefulset).+'
     #   sourceLabels: [__name__]
 
   ## RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few
   ## standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name.
   ##
-  relabelings:
-    []
+  relabelings: []
     # - sourceLabels: [__meta_kubernetes_pod_node_name]
     #   separator: ;
     #   regex: ^(.*)$
     #   targetLabel: nodename
     #   replacement: $1
     #   action: replace
 
-## The configuration file path for the script_exporter. It defaults to "/etc/script-exporter/config.yaml".
-configFile: ""
-
-## The configuration for the script_exporter as shown in
+## The configuration for the Script Exporter as shown in
 ## https://github.com/ricoberger/script_exporter/tree/main#usage-and-configuration
 ##
 config: |
   scripts:
-    - name: ping
-      command: /etc/script-exporter/ping.sh
+    - name: example
+      command:
+        - /script_exporter/scripts/example.sh
 
 ## A list of scripts which should be added to the container. It is also possible to add some scripts to the container,
 ## via the "volumes" and "volumeMounts" values.
 ##
 scripts:
-  ping.sh: |
-    #!/bin/bash
-    ping -c 3 $1 > /dev/null 2>&1
-    exit $?
+  example.sh: |
+    #!/usr/bin/env bash
+
+    echo '# HELP custom_metric A custom metric exported by the script'
+    echo '# TYPE custom_metric gauge'
+    echo 'custom_metric{script="example"} 1'