Skip to content

Commit 7cedaa7

Browse files
betatimbetatim
authored
Merge pull request #1174 from consideRatio/pr/modernize-template-formatting
2 parents 025ce54 + e64ccf0 commit 7cedaa7

File tree

8 files changed

+62
-58
lines changed

8 files changed

+62
-58
lines changed

‎helm-chart/binderhub/templates/configmap.yaml‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,24 @@ apiVersion: v1
33
metadata:
44
name: binder-config
55
data:
6-
{{- /* Important: only pick relevant subset of values. Including too much here can trigger unnecessary binderhub pod restarts */}}
7-
{{- $values := pick .Values "config" "cors" "dind" "extraConfig" }}
8-
{{- /* make a copy to avoid modifying the original */ -}}
9-
{{- $_ := set $values "config" (merge dict .Values.config) }}
10-
{{- $_ := set $values.config "BinderHub" (merge dict .Values.config.BinderHub) }}
11-
{{- /* trim secret values. Update here if new secrets are added! */ -}}
12-
{{- /* every 'omit' here should be matched with a corresponding 'pick' in secret.yaml */ -}}
13-
{{- if $values.config.GitHubRepoProvider }}
14-
{{- $_ := set $values.config "GitHubRepoProvider" (omit .Values.config.GitHubRepoProvider "client_id" "client_secret" "access_token") }}
15-
{{- end }}
16-
{{- if $values.config.GitLabRepoProvider }}
17-
{{- $_ := set $values.config "GitLabRepoProvider" (omit .Values.config.GitLabRepoProvider "private_token" "access_token") }}
18-
{{- end }}
6+
{{- /*
7+
FIXME: Stop splitting up parts into configmap/secret as it adds complexity,
8+
instead only use a secret. For the equivalent PR in z2jh, see:
9+
https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/1682
10+
*/}}
11+
{{- /* Important: only pick relevant subset of values. Including too much here can trigger unnecessary binderhub pod restarts */}}
12+
{{- $values := pick .Values "config" "cors" "dind" "extraConfig" }}
13+
{{- /* make a copy to avoid modifying the original */ -}}
14+
{{- $_ := set $values "config" (merge dict .Values.config) }}
15+
{{- $_ := set $values.config "BinderHub" (merge dict .Values.config.BinderHub) }}
16+
{{- /* trim secret values. Update here if new secrets are added! */ -}}
17+
{{- /* every 'omit' here should be matched with a corresponding 'pick' in secret.yaml */ -}}
18+
{{- if $values.config.GitHubRepoProvider }}
19+
{{- $_ := set $values.config "GitHubRepoProvider" (omit .Values.config.GitHubRepoProvider "client_id" "client_secret" "access_token") }}
20+
{{- end }}
21+
{{- if $values.config.GitLabRepoProvider }}
22+
{{- $_ := set $values.config "GitLabRepoProvider" (omit .Values.config.GitLabRepoProvider "private_token" "access_token") }}
23+
{{- end }}
1924
values.yaml: |
2025
{{- $values | toYaml | nindent 4 }}
2126

‎helm-chart/binderhub/templates/deployment.yaml‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ spec:
2323
component: binder
2424
release: {{ .Release.Name }}
2525
heritage: {{ .Release.Service }}
26-
{{ if .Values.deployment.labels -}}
26+
{{- with .Values.deployment.labels }}
2727
# Because toYaml + indent is super flaky
28-
{{ range $key, $value := .Values.deployment.labels -}}
28+
{{- range $key, $value := .Values.deployment.labels }}
2929
{{ $key }}: {{ $value | quote }}
3030
{{- end }}
3131
{{- end }}
@@ -34,11 +34,11 @@ spec:
3434
checksum/config-map: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
3535
checksum/secret: {{ include (print $.Template.BasePath "/secret.yaml") . | sha256sum }}
3636
spec:
37-
{{ if .Values.initContainers -}}
37+
{{- with .Values.initContainers }}
3838
initContainers:
39-
{{ toYaml .Values.initContainers | indent 6 }}
39+
{{- . | toYaml | nindent 8 }}
4040
{{- end }}
41-
nodeSelector: {{ toJson .Values.nodeSelector }}
41+
nodeSelector: {{ .Values.nodeSelector | toJson }}
4242
{{- if .Values.rbac.enabled }}
4343
serviceAccountName: binderhub
4444
{{- end }}
@@ -49,18 +49,18 @@ spec:
4949
- name: secret-config
5050
secret:
5151
secretName: binder-secret
52-
{{ if .Values.config.BinderHub.use_registry -}}
52+
{{- if .Values.config.BinderHub.use_registry }}
5353
- name: docker-secret
5454
secret:
5555
secretName: binder-push-secret
56-
{{ else -}}
56+
{{- else }}
5757
- name: docker-socket
5858
hostPath:
5959
path: /var/run/docker.sock
6060
{{- end }}
61-
{{ if .Values.extraVolumes }}
62-
{{ toYaml .Values.extraVolumes | indent 6 }}
63-
{{ end }}
61+
{{- with .Values.extraVolumes }}
62+
{{- . | toYaml | nindent 6 }}
63+
{{- end }}
6464
containers:
6565
- name: binder
6666
image: {{ .Values.image.name }}:{{ .Values.image.tag }}
@@ -72,19 +72,19 @@ spec:
7272
name: config
7373
- mountPath: /etc/binderhub/secret/
7474
name: secret-config
75-
{{ if .Values.config.BinderHub.use_registry -}}
75+
{{- if .Values.config.BinderHub.use_registry }}
7676
- mountPath: /root/.docker
7777
name: docker-secret
7878
readOnly: true
79-
{{ else -}}
79+
{{- else }}
8080
- mountPath: /var/run/docker.sock
8181
name: docker-socket
8282
{{- end }}
83-
{{ if .Values.extraVolumeMounts }}
84-
{{ toYaml .Values.extraVolumeMounts | indent 10 }}
85-
{{ end }}
83+
{{- with .Values.extraVolumeMounts }}
84+
{{- . | toYaml | nindent 10 }}
85+
{{- end }}
8686
resources:
87-
{{ toYaml .Values.resources | indent 12}}
87+
{{- .Values.resources | toYaml | nindent 10 }}
8888
imagePullPolicy: IfNotPresent
8989
env:
9090
- name: BUILD_NAMESPACE
@@ -102,25 +102,25 @@ spec:
102102
- name: JUPYTERHUB_BASE_URL
103103
value: {{ .Values.jupyterhub.hub.baseUrl | quote }}
104104
- name: JUPYTERHUB_CLIENT_ID
105-
value: {{ .Values.jupyterhub.hub.services.binder.oauth_client_id | quote}}
105+
value: {{ .Values.jupyterhub.hub.services.binder.oauth_client_id | quote }}
106106
- name: JUPYTERHUB_OAUTH_CALLBACK_URL
107-
value: {{ .Values.jupyterhub.hub.services.binder.oauth_redirect_uri | quote}}
107+
value: {{ .Values.jupyterhub.hub.services.binder.oauth_redirect_uri | quote }}
108108
{{- if .Values.jupyterhub.hub.allowNamedServers }}
109109
- name: JUPYTERHUB_ALLOW_NAMED_SERVERS
110110
value: "true"
111111
- name: JUPYTERHUB_NAMED_SERVER_LIMIT_PER_USER
112-
value: {{ .Values.jupyterhub.hub.namedServerLimitPerUser | quote }}
112+
value: {{ .Values.jupyterhub.hub.namedServerLimitPerUser | quote }}
113+
{{- end }}
113114
{{- end }}
115+
{{- with .Values.extraEnv }}
116+
{{- . | toYaml | indent 8 }}
114117
{{- end }}
115-
{{ if .Values.extraEnv }}
116-
{{ toYaml .Values.extraEnv | indent 8 }}
117-
{{ end }}
118118
ports:
119119
- containerPort: 8585
120120
name: binder
121121
livenessProbe:
122122
httpGet:
123-
path: {{ default "/" .Values.config.BinderHub.base_url }}versions
123+
path: {{ .Values.config.BinderHub.base_url | default "/" }}versions
124124
port: binder
125125
initialDelaySeconds: 10
126126
periodSeconds: 5

‎helm-chart/binderhub/templates/dind/daemonset.yaml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{ if .Values.dind.enabled -}}
1+
{{- if .Values.dind.enabled -}}
22
apiVersion: apps/v1
33
kind: DaemonSet
44
metadata:
@@ -27,22 +27,22 @@ spec:
2727
key: hub.jupyter.org_dedicated
2828
operator: Equal
2929
value: user
30-
nodeSelector: {{ (default (dict) .Values.config.BinderHub.build_node_selector) | toJson }}
31-
{{ if .Values.dind.initContainers -}}
30+
nodeSelector: {{ .Values.config.BinderHub.build_node_selector | default dict | toJson }}
31+
{{- with .Values.dind.initContainers }}
3232
initContainers:
33-
{{ toYaml .Values.dind.initContainers | indent 10 }}
33+
{{- . | toYaml | nindent 8 }}
3434
{{- end }}
3535
containers:
3636
- name: dind
3737
image: {{ .Values.dind.daemonset.image.name }}:{{ .Values.dind.daemonset.image.tag }}
3838
resources:
39-
{{ toYaml .Values.dind.resources | indent 10}}
39+
{{- .Values.dind.resources | toYaml | nindent 10 }}
4040
args:
4141
- dockerd
4242
- --storage-driver={{ .Values.dind.storageDriver }}
4343
- -H unix://{{ .Values.dind.hostSocketDir }}/docker.sock
44-
{{- if .Values.dind.daemonset.extraArgs }}
45-
{{ toYaml .Values.dind.daemonset.extraArgs | indent 10 }}
44+
{{- with .Values.dind.daemonset.extraArgs }}
45+
{{- . | toYaml | nindent 10 }}
4646
{{- end }}
4747
securityContext:
4848
privileged: true

‎helm-chart/binderhub/templates/image-cleaner.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{ if .Values.imageCleaner.enabled -}}
1+
{{- if .Values.imageCleaner.enabled -}}
22
{{- $Values := .Values -}}
33
apiVersion: apps/v1
44
kind: DaemonSet
@@ -28,7 +28,7 @@ spec:
2828
key: hub.jupyter.org_dedicated
2929
operator: Equal
3030
value: user
31-
nodeSelector: {{ toJson .Values.config.BinderHub.build_node_selector }}
31+
nodeSelector: {{ .Values.config.BinderHub.build_node_selector | toJson }}
3232
{{- if .Values.rbac.enabled }}
3333
serviceAccountName: {{ .Release.Name }}-image-cleaner
3434
{{- end }}
@@ -55,7 +55,7 @@ spec:
5555
- name: IMAGE_GC_DELAY
5656
value: {{ $Values.imageCleaner.delay | quote }}
5757
- name: IMAGE_GC_THRESHOLD_TYPE
58-
value: {{ $Values.imageCleaner.imageGCThresholdType }}
58+
value: {{ $Values.imageCleaner.imageGCThresholdType | quote }}
5959
- name: IMAGE_GC_THRESHOLD_HIGH
6060
value: {{ $Values.imageCleaner.imageGCThresholdHigh | quote }}
6161
- name: IMAGE_GC_THRESHOLD_LOW
@@ -81,5 +81,4 @@ spec:
8181
path: {{ .Values.dind.hostSocketDir }}/docker.sock
8282
type: Socket
8383
{{- end }}
84-
8584
{{- end }}

‎helm-chart/binderhub/templates/ingress.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ spec:
4444
secretName: {{ .secretName }}
4545
{{- end }}
4646
{{- end }}
47-
{{- end -}}
47+
{{- end }}

‎helm-chart/binderhub/templates/rbac.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{ if .Values.rbac.enabled -}}
1+
{{- if .Values.rbac.enabled -}}
22
kind: Role
33
apiVersion: rbac.authorization.k8s.io/v1beta1
44
metadata:
@@ -42,7 +42,7 @@ metadata:
4242
heritage: {{ .Release.Service }}
4343
release: {{ .Release.Name }}
4444
name: binderhub
45-
{{ if .Values.imageCleaner.enabled -}}
45+
{{- if .Values.imageCleaner.enabled }}
4646
---
4747
# image-cleaner role
4848
# needs to cordon nodes during image cleaning

‎helm-chart/binderhub/templates/secret.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ data:
99
binder.hub-token: {{ .Values.jupyterhub.hub.services.binder.apiToken | b64enc | quote }}
1010
{{- /* every 'pick' here should be matched with a corresponding 'omit' in secret.yaml */ -}}
1111
{{- if $cfg.GitHubRepoProvider }}
12-
{{- $_ := set $values.config "GitHubRepoProvider" (pick $cfg.GitHubRepoProvider "client_id" "client_secret" "access_token")}}
12+
{{- $_ := set $values.config "GitHubRepoProvider" (pick $cfg.GitHubRepoProvider "client_id" "client_secret" "access_token") }}
1313
{{- end }}
1414
{{- if $cfg.GitLabRepoProvider }}
15-
{{- $_ := set $values.config "GitLabRepoProvider" (pick $cfg.GitLabRepoProvider "access_token" "private_token")}}
15+
{{- $_ := set $values.config "GitLabRepoProvider" (pick $cfg.GitLabRepoProvider "access_token" "private_token") }}
1616
{{- end }}
1717
values.yaml: {{ $values | toYaml | b64enc | quote }}
1818
---

‎helm-chart/binderhub/templates/service.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ apiVersion: v1
22
kind: Service
33
metadata:
44
name: binder
5-
annotations: {{ toJson .Values.service.annotations }}
6-
labels: {{ toJson .Values.service.labels }}
5+
annotations: {{ .Values.service.annotations | toJson }}
6+
labels: {{ .Values.service.labels | toJson }}
77
spec:
88
type: {{ .Values.service.type }}
9-
{{ if .Values.service.loadBalancerIP -}}
10-
loadBalancerIP: {{ .Values.service.loadBalancerIP | quote }}
9+
{{- with .Values.service.loadBalancerIP }}
10+
loadBalancerIP: {{ . | quote }}
1111
{{- end }}
1212
selector:
1313
app: binder
@@ -19,6 +19,6 @@ spec:
1919
- protocol: TCP
2020
port: 80
2121
targetPort: 8585
22-
{{ if .Values.service.nodePort -}}
23-
nodePort: {{ .Values.service.nodePort }}
22+
{{- with .Values.service.nodePort }}
23+
nodePort: {{ . }}
2424
{{- end }}

0 commit comments

Comments
 (0)