tweak helm chart

Signed-off-by: Alexander Trost <[email protected]>

Author: galexrt

Dockerfile

@@ -5,11 +5,11 @@ ARG REVISION="N/A"
 
 LABEL org.opencontainers.image.authors="Alexander Trost <[email protected]>" \
     org.opencontainers.image.created="${BUILD_DATE}" \
-    org.opencontainers.image.title="galexrt/container-node_exporter-smartmon" \
+    org.opencontainers.image.title="galexrt/container-node_exporter-textfiles" \
     org.opencontainers.image.description="Container Image with the Prometheus Community's node-exporter-textfile-collector-scripts Repository checked out, with some utilities installed." \
-    org.opencontainers.image.documentation="https://github.com/galexrt/container-node_exporter-smartmon/blob/main/README.md" \
-    org.opencontainers.image.url="https://github.com/galexrt/container-node_exporter-smartmon" \
-    org.opencontainers.image.source="https://github.com/galexrt/container-node_exporter-smartmon" \
+    org.opencontainers.image.documentation="https://github.com/galexrt/container-node_exporter-textfiles/blob/main/README.md" \
+    org.opencontainers.image.url="https://github.com/galexrt/container-node_exporter-textfiles" \
+    org.opencontainers.image.source="https://github.com/galexrt/container-node_exporter-textfiles" \
     org.opencontainers.image.revision="${REVISION}" \
     org.opencontainers.image.vendor="galexrt" \
     org.opencontainers.image.version="N/A"

Makefile

@@ -18,20 +18,20 @@ container-build:
 	docker build \
 		--build-arg BUILD_DATE="$(shell date -u +'%Y-%m-%dT%H:%M:%SZ')" \
 		--build-arg VCS_REF="$(shell git rev-parse HEAD)" \
-		-t ghcr.io/galexrt/node-exporter-smartmon:$(VERSION) \
+		-t ghcr.io/galexrt/node-exporter-textfiles:$(VERSION) \
 		.
-	docker tag ghcr.io/galexrt/node-exporter-smartmon:$(VERSION) quay.io/galexrt/node-exporter-smartmon:$(VERSION)
+	docker tag ghcr.io/galexrt/node-exporter-textfiles:$(VERSION) quay.io/galexrt/node-exporter-textfiles:$(VERSION)
 
 	if [ "$(VERSION)" != "$(VERSION_SHORT)" ]; then \
-		docker tag ghcr.io/galexrt/node-exporter-smartmon:$(VERSION) ghcr.io/galexrt/node-exporter-smartmon:$(VERSION_SHORT); \
-		docker tag ghcr.io/galexrt/node-exporter-smartmon:$(VERSION) quay.io/galexrt/node-exporter-smartmon:$(VERSION_SHORT); \
+		docker tag ghcr.io/galexrt/node-exporter-textfiles:$(VERSION) ghcr.io/galexrt/node-exporter-textfiles:$(VERSION_SHORT); \
+		docker tag ghcr.io/galexrt/node-exporter-textfiles:$(VERSION) quay.io/galexrt/node-exporter-textfiles:$(VERSION_SHORT); \
 	fi
 
 container-push:
-	docker push ghcr.io/galexrt/node-exporter-smartmon:$(VERSION)
-	docker push quay.io/galexrt/node-exporter-smartmon:$(VERSION)
+	docker push ghcr.io/galexrt/node-exporter-textfiles:$(VERSION)
+	docker push quay.io/galexrt/node-exporter-textfiles:$(VERSION)
 
 	if [ "$(VERSION)" != "$(VERSION_SHORT)" ]; then \
-		docker push ghcr.io/galexrt/node-exporter-smartmon:$(VERSION_SHORT); \
-		docker push quay.io/galexrt/node-exporter-smartmon:$(VERSION_SHORT); \
+		docker push ghcr.io/galexrt/node-exporter-textfiles:$(VERSION_SHORT); \
+		docker push quay.io/galexrt/node-exporter-textfiles:$(VERSION_SHORT); \
 	fi

README.md

@@ -1,11 +1,24 @@
-# container-node_exporter-smartmon
+# container-node_exporter-textfiles
 
-Container Image with the Prometheus Community's node-exporter-textfile-collector-scripts Repository checked out, with some utilities installed.
+<details>
+    <summary>
+        <b>NOTICE The repository and image have been renamed on 18.02.2022! For more information click this spoiler</b>
+    </summary>
+
+    The container images name has been changed from `galexrt/node-exporter-smartmon` to **`galexrt/node-exporter-textfiles`**.
+    E.g., the image on quay.io is now available at `quay.io/galexrt/node-exporter-smartmon`.
+
+    The repository name has been changed from `container-node_exporter-smartmon` to **`container-node_exporter-textfiles`**.
+
+    This has been done as the image in this repository is not just for running the `smartmon` textfile collector script(s) anymore.
+</details>
+
+Container Image for easily running textfile exporter scripts from the Prometheus Community to be collected by the prometheus/node_exporter.
 
 Container Image available from:
 
-* [Quay.io](https://quay.io/repository/galexrt/node-exporter-smartmon)
-* [GHCR.io](https://github.com/users/galexrt/packages/container/package/node-exporter-smartmon)
+* [Quay.io](https://quay.io/repository/galexrt/node-exporter-textfiles)
+* [GHCR.io](https://github.com/users/galexrt/packages/container/package/node-exporter-textfiles)
 
 Container Image Tags:
 
@@ -24,11 +37,11 @@ The entrypoint script is putting the output into the directory `/var/lib/node_ex
 
 ### Variables
 
-| Name              | Default       | Description                                                   |
-| ----------------- | ------------- | ------------------------------------------------------------- |
-| `SCRIPT`          | `smartmon.sh` | Which of the node_exporter textfile collector scripts to run. |
-| `OUTPUT_FILENAME` | `smartmon`    | Name of the output file (file ending is always `.prom`).      |
-| `INTERVAL`        | `300`         | Interval at which to run the script at.                       |
+| Name              | Default       | Description                                                      |
+| ----------------- | ------------- | ---------------------------------------------------------------- |
+| `SCRIPT`          | `smartmon.sh` | Which of the node_exporter textfile collector scripts to run.    |
+| `OUTPUT_FILENAME` | `smartmon`    | Name of the output file (file ending must not be added `.prom`). |
+| `INTERVAL`        | `300`         | Interval at which to run the script at.                          |
 
 Any flags / args given to the container are passed to the `SCRIPT` that will be executed.
 

charts/node-exporter-textfiles/templates/NOTES.txt

@@ -2,4 +2,4 @@ The node-exporter-textfiles DaemonSet has been deployed!
 
 Make sure to configure your node_exporter to pickup textfiles.
 For more information see the documentation at:
-https://github.com/galexrt/container-node_exporter-smartmon/main/docs/node_exporter.md
+https://github.com/galexrt/container-node_exporter-textfiles/main/docs/node_exporter.md

charts/node-exporter-textfiles/templates/daemonset.yaml

@@ -1,5 +1,5 @@
 apiVersion: apps/v1
-kind: Deployment
+kind: DaemonSet
 metadata:
   name: {{ include "node-exporter-textfiles.fullname" . }}
   labels:
@@ -29,13 +29,26 @@ spec:
         - name: {{ .name }}
           securityContext:
             {{- toYaml $.Values.securityContext | nindent 12 }}
-          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          image: "{{ $.Values.image.repository }}:{{ $.Values.image.tag | default $.Chart.AppVersion }}"
           imagePullPolicy: {{ $.Values.image.pullPolicy }}
           resources:
             {{- toYaml .resources | nindent 12 }}
+          env:
+            - name: SCRIPT
+              value: "{{ .script }}"
+            - name: OUTPUT_FILENAME
+              value: {{ .outputFilename | quote }}
+            - name: INTERVAL
+              value: "{{ .interval }}"
+            {{- with .additionalEnv }}
+            {{- toYaml . | nindent 12 }}
+            {{- end}}
           volumeMounts:
             - mountPath: /var/lib/node_exporter
               name: textfile
+            {{- with .additionalVolumeMounts }}
+            {{ toYaml . | nindent 12 }}
+            {{- end }}
       {{- end }}
       {{- with .Values.nodeSelector }}
       nodeSelector:
@@ -50,4 +63,4 @@ spec:
         {{- toYaml . | nindent 8 }}
       {{- end }}
       volumes:
-        {{- toYaml .Values.textfileVolumes | nindent 8 }}
+        {{- toYaml .Values.additionalVolumes | nindent 8 }}

charts/node-exporter-textfiles/templates/podsecuritypolicy.yaml

@@ -0,0 +1,38 @@
+{{- if .Values.podSecurityPolicy.enabled }}
+apiVersion: extensions/v1beta1
+kind: PodSecurityPolicy
+metadata:
+  name: {{ include "node-exporter-textfiles.fullname" . }}
+  labels:
+    {{- include "node-exporter-textfiles.labels" . | nindent 4 }}
+  annotations:
+{{- if .Values.podSecurityPolicy.annotations }}
+{{ toYaml .Values.podSecurityPolicy.annotations | indent 4 }}
+{{- end }}
+spec:
+  {{- toYaml .Values.podSecurityPolicy.spec | nindent 2 }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: {{ include "node-exporter-textfiles.fullname" . }}
+rules:
+- apiGroups: ['policy']
+  resources: ['podsecuritypolicies']
+  verbs: ['use']
+  resourceNames:
+  - {{ include "node-exporter-textfiles.fullname" . }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: {{ include "node-exporter-textfiles.fullname" . }}
+roleRef:
+  kind: ClusterRole
+  name: {{ include "node-exporter-textfiles.fullname" . }}
+  apiGroup: rbac.authorization.k8s.io
+subjects:
+- kind: ServiceAccount
+  name: {{ include "node-exporter-textfiles.serviceAccountName" . }}
+  namespace: {{ .Release.Namespace }}
+{{- end }}

charts/node-exporter-textfiles/values.yaml

@@ -5,7 +5,7 @@
 replicaCount: 1
 
 image:
-  repository: quay.io/galexrt/node-exporter-smartmon
+  repository: quay.io/galexrt/node-exporter-textfiles
   pullPolicy: IfNotPresent
   # Overrides the image tag whose default is the chart appVersion.
   tag: ""
@@ -16,6 +16,7 @@ fullnameOverride: ""
 
 serviceAccount:
   # Specifies whether a service account should be created
+  # Must be true if `podSecurityPolicy.enabled` is `true` (default)
   create: true
   # Annotations to add to the service account
   annotations: {}
@@ -28,7 +29,9 @@ podAnnotations: {}
 podSecurityContext: {}
   # fsGroup: 2000
 
-securityContext: {}
+securityContext:
+  # Privileged is required for most of the textfile scripts
+  privileged: true
   # capabilities:
   #   drop:
   #   - ALL
@@ -42,16 +45,28 @@ tolerations: []
 
 affinity: {}
 
-textfileVolumes:
+additionalVolumes:
   - name: textfile
     hostPath:
       path: /var/lib/node_exporter
       type: Directory
+  - hostPath:
+      path: /dev
+    name: host-dev
 
 textfiles:
   # List of textfiles script that should be run in the daemonset as separate containers
   - name: smartmon
     script: smartmon.py
+    # If unset, will default to the `name`
+    outputFilename: "smartmon"
+    # Defaults to `300`
+    interval: 900
+    additionalEnv: []
+    additionalVolumeMounts:
+      - mountPath: /dev
+        name: host-dev
+        readOnly: true
     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
@@ -63,3 +78,36 @@ textfiles:
       # requests:
       #   cpu: 100m
       #   memory: 128Mi
+
+podSecurityPolicy:
+  enabled: true
+  annotations: {}
+  spec:
+    privileged: true
+    allowPrivilegeEscalation: true
+    volumes:
+      - 'configMap'
+      - 'emptyDir'
+      - 'hostPath'
+      - 'secret'
+    allowedHostPaths:
+      # This must be the same as for the `additionalVolumes` hostPath volume paths
+      - pathPrefix: /var/lib/node_exporter
+        readOnly: false
+      - pathPrefix: /dev
+        readOnly: true
+    hostNetwork: false
+    hostPID: false
+    hostIPC: false
+    runAsUser:
+      rule: 'RunAsAny'
+    runAsGroup:
+      rule: 'RunAsAny'
+    seLinux:
+      rule: 'RunAsAny'
+    supplementalGroups:
+      rule: 'RunAsAny'
+    fsGroup:
+      rule: 'RunAsAny'
+    readOnlyRootFilesystem: false
+    hostPorts: []

docs/node_exporter.md

@@ -2,16 +2,39 @@
 
 ## Configuration
 
-The `node_exporter` must have these flags set:
+The `node_exporter` must have this flag set:
 
 ```console
---collector.textfile.directory=PATH
+--collector.textfile.directory=YOUR_TEXTFILE_OUTPUT_PATH
 ```
 
+(Where `YOUR_TEXTFILE_OUTPUT_PATH` when using this repos default would be `/var/lib/node_exporter`)
+
 Also ensure that you are not actively disabling the `textfile` exporter (it is enabled by default), for more information see: [GitHub prometheus/node_exporter - Collectors section](https://github.com/prometheus/node_exporter#collectors).
 
 ### Containerized
 
 If you are running node_exporter in containers (e.g., through Kubernetes), you need to add the textfile output path on the host to your node_exporter volumes.
 
 The access from the node_exporter can be set to readOnly, but the textfiles container must read write to that directory.
+
+When using the default values of the provided `node_exporter-textfiles` Helm Chart, you need to add a `hostPath` volume to your `node_exporter` to the path `/var/lib/node_exporter` and a `volumeMounts` entry.
+
+Example YAML snippets for your `node_exporter` DaemonSet in Kubernetes:
+
+```yaml
+additionalVolumes:
+- hostPath:
+    path: /dev
+  name: host-dev
+- hostPath:
+    path: /var/lib/node_exporter
+  name: host-textfile
+```
+
+```yaml
+volumeMounts:
+- mountPath: /var/lib/node_exporter
+  name: host-textfile
+  readOnly: false
+```

kubernetes/daemonset.yaml

@@ -1,22 +1,22 @@
 apiVersion: apps/v1
 kind: DaemonSet
 metadata:
-  name: node-exporter-smartmon
+  name: node-exporter-textfiles
   labels:
-    app.kubernetes.io/name: node-exporter-smartmon
+    app.kubernetes.io/name: node-exporter-textfiles
 spec:
   updateStrategy:
     rollingUpdate:
       maxUnavailable: 5
     type: RollingUpdate
   selector:
     matchLabels:
-      app.kubernetes.io/name: node-exporter-smartmon
+      app.kubernetes.io/name: node-exporter-textfiles
   template:
     metadata:
-      name: node-exporter-smartmon
+      name: node-exporter-textfiles
       labels:
-        app.kubernetes.io/name: node-exporter-smartmon
+        app.kubernetes.io/name: node-exporter-textfiles
     spec:
       tolerations:
         - key: node-role.kubernetes.io/master
@@ -26,7 +26,7 @@ spec:
           operator: "Exists"
       terminationGracePeriodSeconds: 5
       containers:
-      - image: quay.io/galexrt/node-exporter-smartmon:v20220203-125335-155
+      - image: quay.io/galexrt/node-exporter-textfiles:v20220203-125335-155
         name: smartmon
         env:
         - name: INTERVAL
@@ -49,7 +49,7 @@ spec:
         - mountPath: /var/lib/node_exporter
           name: host-textfile
           readOnly: false
-      - image: quay.io/galexrt/node-exporter-smartmon:v20220203-125335-155
+      - image: quay.io/galexrt/node-exporter-textfiles:v20220203-125335-155
         name: nvmemetrics
         env:
         - name: INTERVAL