Merge pull request #1332 from consideRatio/pr/z2jh-like-extraEnv

helm-chart: enhance extraEnv like in z2jh with jupyterhub.extraEnv helper

Author: yuvipanda

helm-chart/binderhub/schema.yaml

@@ -492,9 +492,38 @@ properties:
   extraVolumes: *extraVolumes-spec
   extraVolumeMounts: *extraVolumeMounts-spec
   extraEnv:
-    type: array
+    type: [object, array]
+    additionalProperties: true
     description: |
-      Env to add to the binder Pods.
+      Environment variables to add to the binder pods.
+
+      String literals with `$(ENV_VAR_NAME)` will be expanded by Kubelet which
+      is a part of Kubernetes.
+
+      ```yaml
+      extraEnv:
+        # basic notation (for literal values only)
+        MY_ENV_VARS_NAME1: "my env var value 1"
+
+        # explicit notation (the "name" field takes precedence)
+        BINDER_NAMESPACE:
+          name: BINDER_NAMESPACE
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.namespace
+
+        # implicit notation (the "name" field is implied)
+        PREFIXED_BINDER_NAMESPACE:
+          value: "my-prefix-$(BINDER_NAMESPACE)"
+        SECRET_VALUE:
+          valueFrom:
+            secretKeyRef:
+              name: my-k8s-secret
+              key: password
+      ```
+
+      For more information, see the [Kubernetes EnvVar
+      specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envvar-v1-core).
   podAnnotations:
     type: object
     additionalProperties: false

helm-chart/binderhub/templates/deployment.yaml

@@ -117,7 +117,7 @@ spec:
         {{- end }}
         {{- end }}
         {{- with .Values.extraEnv }}
-        {{- . | toYaml | nindent 8 }}
+        {{- include "jupyterhub.extraEnv" . | nindent 8 }}
         {{- end }}
         ports:
           - containerPort: 8585

helm-chart/binderhub/values.yaml

@@ -216,5 +216,5 @@ initContainers: []
 lifecycle: {}
 extraVolumes: []
 extraVolumeMounts: []
-extraEnv: []
+extraEnv: {}
 podAnnotations: {}

tools/templates/lint-and-validate-values.yaml

@@ -147,8 +147,9 @@ lifecycle: *lifecycle
 extraVolumes: []
 extraVolumeMounts: []
 extraEnv: &extraEnv
-  - name: MOCK_ENV_VAR_NAME1
+  IGNORED_KEY_NAME:
+    name: MOCK_ENV_VAR_NAME1
     value: MOCK_ENV_VAR_VALUE1
-  - name: MOCK_ENV_VAR_NAME2
+  MOCK_ENV_VAR_NAME2:
     value: MOCK_ENV_VAR_VALUE2
 podAnnotations: *annotations