imagePullSecrets: add switch for imagePullSecret.automaticReferenceIn…

…jection
jupyterhub · Oct 9, 2020 · 3115053 · 3115053
1 parent 8bdd2c9
commit 3115053
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 2 deletions.
diff --git a/jupyterhub/files/hub/jupyterhub_config.py b/jupyterhub/files/hub/jupyterhub_config.py
@@ -166,7 +166,9 @@ def camelCaseify(s):
 # Combine imagePullSecret.create (single), imagePullSecrets (list), and
 # singleuser.image.pullSecrets (list).
 image_pull_secrets = []
-if get_config('imagePullSecret.create') or get_config('imagePullSecret.enabled'):
+if get_config("imagePullSecret.automaticReferenceInjection") and (
+    get_config("imagePullSecret.create") or get_config("imagePullSecret.enabled")
+):
     image_pull_secrets.append('image-registry-credentials')
 if get_config('imagePullSecrets'):
     image_pull_secrets.extend(get_config('imagePullSecrets'))

diff --git a/jupyterhub/schema.yaml b/jupyterhub/schema.yaml
@@ -39,6 +39,11 @@ properties:
         description: |
           Toggle the creation of the k8s Secret with provided credentials to
           access a private image registry.
+      automaticReferenceInjection:
+        type: boolean
+        description: |
+          Toggle the automatic reference injection of the created Secret to all
+          pods' `spec.imagePullSecrets` configuration.
       registry:
         type: string
         description: |

diff --git a/jupyterhub/templates/_helpers.tpl b/jupyterhub/templates/_helpers.tpl
@@ -200,7 +200,7 @@ component: {{ include "jupyterhub.componentLabel" . }}
 {{- define "jupyterhub.imagePullSecrets" -}}
 {{- /* Populate $_.list with all relevant entries */}}
 {{- $_ := dict "list" (concat .image.pullSecrets .root.Values.imagePullSecrets | uniq) }}
-{{- if .root.Values.imagePullSecret.create }}
+{{- if and .root.Values.imagePullSecret.automaticReferenceInjection .root.Values.imagePullSecret.create }}
 {{- $__ := set $_ "list" (append $_.list "image-registry-credentials" | uniq) }}
 {{- end }}
 

diff --git a/jupyterhub/values.yaml b/jupyterhub/values.yaml
@@ -4,6 +4,7 @@ custom: {}
 # can get credentials from to pull their images.
 imagePullSecret:
   create: false
+  automaticReferenceInjection: true
   registry: ''
   username: ''
   email: ''

diff --git a/tools/templates/lint-and-validate-values.yaml b/tools/templates/lint-and-validate-values.yaml
@@ -1,5 +1,6 @@
 imagePullSecret:
   create: true
+  automaticReferenceInjection: true
   registry: R
   username: U
   email: e@domain.com