refactor: make notes helm template comments

Author: consideRatio

jupyterhub/templates/hub/deployment.yaml

@@ -23,7 +23,7 @@ spec:
         {{- . | toYaml | trimSuffix "\n" | nindent 8 }}
         {{- end }}
       annotations:
-        # This lets us autorestart when the secret changes!
+        {{- /* This lets us autorestart when the secret changes! */}}
         checksum/config-map: {{ include (print .Template.BasePath "/hub/configmap.yaml") . | sha256sum }}
         checksum/secret: {{ include (print .Template.BasePath "/hub/secret.yaml") . | sha256sum }}
         {{- with .Values.hub.annotations }}
@@ -111,13 +111,13 @@ spec:
             {{- if .Values.debug.enabled }}
             - --debug
             {{- end }}
-            {{- /*
-            We want to do automatic upgrades for sqlite-pvc by default, but
-            allow users to opt out of that if they want. Users using their own
-            db need to 'opt in' Go Templates treat nil and "" and false as
-            'false', making this code complex. We can probably make this a
-            one-liner, but doing combinations of boolean vars in go templates is
-            very inelegant & hard to reason about.
+            {{- /* NOTE:
+              We want to do automatic upgrades for sqlite-pvc by default, but
+              allow users to opt out of that if they want. Users using their own
+              db need to 'opt in' Go Templates treat nil and "" and false as
+              'false', making this code complex. We can probably make this a
+              one-liner, but doing combinations of boolean vars in go templates
+              is very inelegant & hard to reason about.
             */}}
             {{- $upgradeType := typeOf .Values.hub.db.upgrade }}
             {{- if eq $upgradeType "bool" }}
@@ -195,9 +195,12 @@ spec:
             - name: CONFIGPROXY_AUTH_TOKEN
               valueFrom:
                 secretKeyRef:
-                  # NOTE: References the chart managed k8s Secret even if
-                  #       hub.existingSecret is specified to avoid using the
-                  #       lookup function on the user managed k8s Secret.
+                  {{- /* NOTE:
+                    References the chart managed k8s Secret even if
+                    hub.existingSecret is specified to avoid using the lookup
+                    function on the user managed k8s Secret which is assumed to
+                    not be possible.
+                  */}}
                   name: {{ include "jupyterhub.hub.fullname" . }}
                   key: hub.config.ConfigurableHTTPProxy.auth_token
             {{- with .Values.hub.extraEnv }}
@@ -207,13 +210,13 @@ spec:
             - name: http
               containerPort: 8081
           {{- if .Values.hub.livenessProbe.enabled }}
-          # livenessProbe notes:
-          # We don't know how long hub database upgrades could take
-          # so having a liveness probe could be a bit risky unless we put
-          # a initialDelaySeconds value with long enough margin for that
-          # to not be an issue. If it is too short, we could end up aborting
-          # database upgrades midway or ending up in an infinite restart
-          # loop.
+          {{- /* NOTE:
+            We don't know how long hub database upgrades could take so having a
+            liveness probe could be a bit risky unless we put a
+            initialDelaySeconds value with long enough margin for that to not be
+            an issue. If it is too short, we could end up aborting database
+            upgrades midway or ending up in an infinite restart loop.
+          */}}
           livenessProbe:
             initialDelaySeconds: {{ .Values.hub.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.hub.livenessProbe.periodSeconds }}