feat: added customEnv option

You can add a default.customEnv list of environment variables to every service, or a customEnv list for single services. Ticket: MC-6856 Signed-off-by: Roberto Giovanardi <[email protected]>
mendersoftware · Jan 30, 2024 · 3cfbfdb · 3cfbfdb
1 parent 82d01fa
commit 3cfbfdb
Show file tree

Hide file tree

Showing 17 changed files with 104 additions and 1 deletion.
diff --git a/mender/CHANGELOG.md b/mender/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## master
 * Fix mongodb uri creation when using the mongodb subchart and replicast architecture
+* Added customEnv option to set default or per-service custom env variables
 
 ## Version 5.4.1
 * Upgrade to Mender version `3.7.1`.

diff --git a/mender/templates/_helpers.tpl b/mender/templates/_helpers.tpl
@@ -279,3 +279,14 @@ Create the name of the service account
 {{- default "default" $dot.Values.serviceAccount.name }}
 {{- end }}
 {{- end }}
+
+{{/*
+Synopsis:
+{{- include "mender.customEnvs" (merge (deepCopy .dot.Values.<service>) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
+*/}}
+{{- define "mender.customEnvs" -}}
+{{- with .customEnvs }}
+{{- toYaml . }}
+{{- println "" }}
+{{- end }}
+{{- end -}}
diff --git a/mender/templates/auditlogs/_podtemplate.yaml b/mender/templates/auditlogs/_podtemplate.yaml
@@ -67,6 +67,7 @@ spec:
     env:
     - name: AUDITLOGS_AUDITLOG_EXPIRE_SECONDS
       value: {{ .dot.Values.auditlogs.logRetentionSeconds | int | toString | quote }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.auditlogs) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
     # Supported configuration settings: https://github.com/mendersoftware/auditlogs/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.
     envFrom:

diff --git a/mender/templates/create-artifact-worker/deployment.yaml b/mender/templates/create-artifact-worker/deployment.yaml
@@ -78,6 +78,7 @@ spec:
           value: "1"
         - name: CREATE_ARTIFACT_DEPLOYMENTS_URL
           value: http://{{ .Values.deployments.service.name }}:{{ .Values.deployments.service.port }}
+        {{- include "mender.customEnvs" (merge (deepCopy .Values.create_artifact_worker) (deepCopy (default (dict) .Values.default))) | nindent 8 }}
         envFrom:
         - prefix: WORKFLOWS_
           secretRef:

diff --git a/mender/templates/deployments/_podtemplate.yaml b/mender/templates/deployments/_podtemplate.yaml
@@ -93,6 +93,7 @@ spec:
       value: "true"
     {{- end }}
     {{- end }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.deployments) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/deployments/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/templates/device-auth/_podtemplate.yaml b/mender/templates/device-auth/_podtemplate.yaml
@@ -120,6 +120,7 @@ spec:
     - name: DEVICEAUTH_REDIS_LIMITS_EXPIRE_SEC
       value: {{ .dot.Values.useradm.env.DEVICEAUTH_REDIS_LIMITS_EXPIRE_SEC | default "3600" | quote }}
     {{- end }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.device_auth) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/deviceauth/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/templates/deviceconfig/_podtemplate.yaml b/mender/templates/deviceconfig/_podtemplate.yaml
@@ -74,6 +74,7 @@ spec:
     # Workflows orchestrator address
     - name: DEVICECONFIG_WORKFLOWS_URL
       value: http://mender-workflows-server:8080/
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.deviceconfig) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/deviceconfig/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/templates/deviceconnect/_podtemplate.yaml b/mender/templates/deviceconnect/_podtemplate.yaml
@@ -90,6 +90,8 @@ spec:
         {{.hostname}} https://{{.hostname}} wss://{{.hostname}}
         {{- end }}
 
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.deviceconnect) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
+
     # Supported configuration settings: https://github.com/mendersoftware/deviceconnect/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.
     envFrom:

diff --git a/mender/templates/devicemonitor/_podtemplate.yaml b/mender/templates/devicemonitor/_podtemplate.yaml
@@ -73,6 +73,8 @@ spec:
     - name: DEVICEMONITOR_WORKFLOWS_URL
       value: {{ .dot.Values.device_auth.env.DEVICEMONITOR_WORKFLOWS_URL | quote }}
 
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.devicemonitor) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
+
     # Supported configuration settings: https://github.com/mendersoftware/devicemonitor/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.
     envFrom:

diff --git a/mender/templates/generate-delta-worker/deployment.yaml b/mender/templates/generate-delta-worker/deployment.yaml
@@ -73,6 +73,7 @@ spec:
           value: "1"
         - name: GENERATE_DELTA_DEPLOYMENTS_URL
           value: http://{{ .Values.deployments.service.name }}:{{ .Values.deployments.service.port }}
+        {{- include "mender.customEnvs" (merge (deepCopy .Values.generate_delta_worker) (deepCopy (default (dict) .Values.default))) | nindent 8 }}
         envFrom:
         - prefix: WORKFLOWS_
           secretRef:

diff --git a/mender/templates/gui/deployment.yaml b/mender/templates/gui/deployment.yaml
@@ -97,6 +97,7 @@ spec:
         - name: HAVE_MONITOR
           value: "true"
         {{- end }}
+        {{- include "mender.customEnvs" (merge (deepCopy .Values.gui) (deepCopy (default (dict) .Values.default))) | nindent 8 }}
 
 {{- if .Values.global.image.username }}
       imagePullSecrets:

diff --git a/mender/templates/inventory/_podtemplate.yaml b/mender/templates/inventory/_podtemplate.yaml
@@ -83,6 +83,7 @@ spec:
       value: {{ .dot.Values.useradm.env.INVENTORY_REDIS_CACHE_EXPIRE_SEC | default "1800" | quote }}
     {{- end }}
     {{- end }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.inventory) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/inventory-enterprise/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/templates/iot-manager/_podtemplate.yaml b/mender/templates/iot-manager/_podtemplate.yaml
@@ -66,6 +66,8 @@ spec:
 
     env:
     # Supported configuration settings: https://github.com/mendersoftware/iot-manager/blob/master/config.yaml
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.iot_manager) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
+
     # Set in order, last value for the key will be used in case duplications.
     envFrom:
     - prefix: IOT_MANAGER_

diff --git a/mender/templates/tenantadm/_podtemplate.yaml b/mender/templates/tenantadm/_podtemplate.yaml
@@ -82,6 +82,7 @@ spec:
     - name: TENANTADM_ENABLE_SELF_SERVICE_SIGN_UP
       value: {{ .dot.Values.global.hosted | quote }}
     {{- end }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.tenantadm) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/tenantadm/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/templates/useradm/_podtemplate.yaml b/mender/templates/useradm/_podtemplate.yaml
@@ -124,6 +124,7 @@ spec:
     - name: USERADM_REDIS_LIMITS_EXPIRE_SEC
       value: {{ .dot.Values.useradm.env.USERADM_REDIS_LIMITS_EXPIRE_SEC | default "3600" | quote }}
     {{- end }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.useradm) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/useradm/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/templates/workflows/_podtemplate.yaml b/mender/templates/workflows/_podtemplate.yaml
@@ -94,6 +94,7 @@ spec:
       value: "true"
     {{- end }}
     {{- end }}
+    {{- include "mender.customEnvs" (merge (deepCopy .dot.Values.workflows) (deepCopy (default (dict) .dot.Values.default))) | nindent 4 }}
 
     # Supported configuration settings: https://github.com/mendersoftware/workflows/blob/master/config.yaml
     # Set in order, last value for the key will be used in case duplications.

diff --git a/mender/values.yaml b/mender/values.yaml
@@ -69,6 +69,11 @@ default:
     enabled: false
     minAvailable: 1
 
+  # custom default envs for every service
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: WARN 
+
 serviceAccount:
   create: false
   name:
@@ -290,6 +295,11 @@ deployments:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 device_auth:
   enabled: true
   podAnnotations: {}
@@ -358,6 +368,11 @@ device_auth:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 # Generate Delta Worker feature
 # Experimental feature, still in beta
 # will be released in the next Mender versions
@@ -383,6 +398,11 @@ generate_delta_worker:
   nodeSelector: {}
   priorityClassName: ""
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 gui:
   enabled: true
   podAnnotations: {}
@@ -418,6 +438,11 @@ gui:
     runAsUser: 65534
   priorityClassName: ""
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 inventory:
   enabled: true
   podAnnotations: {}
@@ -472,6 +497,11 @@ inventory:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 tenantadm:
   enabled: true
   podAnnotations: {}
@@ -539,6 +569,10 @@ tenantadm:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
 
 useradm:
   enabled: true
@@ -608,6 +642,11 @@ useradm:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 workflows:
   enabled: true
   podAnnotations: {}
@@ -658,6 +697,11 @@ workflows:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 create_artifact_worker:
   enabled: true
   podAnnotations: {}
@@ -687,6 +731,11 @@ create_artifact_worker:
     runAsUser: 65534
   priorityClassName: ""
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 auditlogs:
   enabled: true
   podAnnotations: {}
@@ -724,7 +773,7 @@ auditlogs:
   hpa: {}
   pdb: {}
   priorityClassName: ""
- 
+
   ## Migration Job
 
   ## auditlogs.migrationRestartPolicy
@@ -741,6 +790,11 @@ auditlogs:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 iot_manager:
   enabled: true
   podAnnotations: {}
@@ -793,6 +847,11 @@ iot_manager:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 deviceconnect:
   enabled: true
   podAnnotations: {}
@@ -847,6 +906,11 @@ deviceconnect:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 deviceconfig:
   enabled: true
   podAnnotations: {}
@@ -899,6 +963,11 @@ deviceconfig:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 devicemonitor:
   enabled: true
   podAnnotations: {}
@@ -951,6 +1020,11 @@ devicemonitor:
   #     cpu: 150m
   #     memory: 64M
 
+  # custom envs
+  customEnvs: []
+  # - name: LOG_LEVEL
+  #   value: DEBUG 
+
 # Redis as a subchart
 # Using a bitnami sub-chart by default = test usage only
 # It's recommended to use a suitable Redis Cluster for Production