Allow to disable proxy pod and service creation

Author: dolfinus

jupyterhub/schema.yaml

@@ -1446,6 +1446,12 @@ properties:
     type: object
     additionalProperties: false
     properties:
+      enabled:
+        type: boolean
+        description: |
+          Default `true`.
+
+          If `false`, disables proxy pod and service creation. Can be used with some existing external proxy, or with kubespawner.proxy.KubeIngressProxy class
       chp:
         type: object
         additionalProperties: false

jupyterhub/templates/NOTES.txt

@@ -40,6 +40,7 @@
       kubectl --namespace={{ .Release.Namespace }} logs --previous <name of pod>
   {{- println }}
 
+  {{- if .Values.proxy.enabled }}
   {{- if eq .Values.proxy.service.type "LoadBalancer" }}
   - Verify an external IP is provided for the k8s Service {{ $proxy_service }}.
 
@@ -84,6 +85,11 @@
 
     Try insecure HTTP access: http://localhost:8080
     {{- end }}
+  {{- end }}
+    You disabled proxy pod and service creation. This means that your proxy should be set up manually.
+
+    Please follow documentation of
+    current proxy class (see c.Jupyterhub.proxy_class setting), e.g. KubeIngressProxy
   {{- end }}
   {{- println }}
 

jupyterhub/templates/proxy/deployment.yaml

@@ -1,3 +1,5 @@
+{{- $enabled := .Values.proxy.enabled -}}
+{{- if $enabled }}
 {{- $manualHTTPS := and .Values.proxy.https.enabled (eq .Values.proxy.https.type "manual") -}}
 {{- $manualHTTPSwithsecret := and .Values.proxy.https.enabled (eq .Values.proxy.https.type "secret") -}}
 apiVersion: apps/v1
@@ -176,3 +178,4 @@ spec:
       {{- with .Values.proxy.chp.extraPodSpec }}
       {{- . | toYaml | nindent 6 }}
       {{- end }}
+{{- end }}

jupyterhub/templates/proxy/service.yaml

@@ -1,10 +1,12 @@
-{{- $enabled := .Values.proxy.https.enabled -}}
-{{- $autoHTTPS := and $enabled (and (eq .Values.proxy.https.type "letsencrypt") .Values.proxy.https.hosts) -}}
-{{- $manualHTTPS := and $enabled (eq .Values.proxy.https.type "manual") -}}
-{{- $manualHTTPSwithsecret := and $enabled (eq .Values.proxy.https.type "secret") -}}
-{{- $offloadHTTPS := and $enabled (eq .Values.proxy.https.type "offload") -}}
+{{- $enabled := .Values.proxy.enabled -}}
+{{- if $enabled }}
+{{- $httpsEnabled := .Values.proxy.https.enabled -}}
+{{- $autoHTTPS := and $httpsEnabled (and (eq .Values.proxy.https.type "letsencrypt") .Values.proxy.https.hosts) -}}
+{{- $manualHTTPS := and $httpsEnabled (eq .Values.proxy.https.type "manual") -}}
+{{- $manualHTTPSwithsecret := and $httpsEnabled (eq .Values.proxy.https.type "secret") -}}
+{{- $offloadHTTPS := and $httpsEnabled (eq .Values.proxy.https.type "offload") -}}
 {{- $valid := or $autoHTTPS (or $manualHTTPS (or $manualHTTPSwithsecret $offloadHTTPS)) -}}
-{{- $HTTPS := and $enabled $valid -}}
+{{- $HTTPS := and $httpsEnabled $valid -}}
 apiVersion: v1
 kind: Service
 metadata:
@@ -78,3 +80,4 @@ spec:
     {{- . | toYaml | nindent 4 }}
   {{- end }}
   {{- end }}
+{{- end }}

jupyterhub/values.yaml

@@ -145,6 +145,7 @@ rbac:
 # proxy relates to the proxy pod, the proxy-public service, and the autohttps
 # pod and proxy-http service.
 proxy:
+  enabled: true
   secretToken:
   annotations: {}
   deploymentStrategy:

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

@@ -210,6 +210,7 @@ rbac:
   create: true
 
 proxy:
+  enabled: true
   service:
     extraPorts:
       - name: ssh