Adding basic authentication values in K8s helm chart (#744)

* adding basic authentication options to helm chart * updating README for basic auth * extra line break in notes * fixing typo
zalando · Oct 13, 2018 · cbf6536 · cbf6536
1 parent c69467a
commit cbf6536
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 3 deletions.
diff --git a/docs/k8s/helm/README.md b/docs/k8s/helm/README.md
@@ -81,8 +81,11 @@ See Zalenium's [usage examples](https://github.com/zalando/zalenium/blob/master/
 | `hub.sauceAccessKey` | Access key to log into saucelabs | blank |
 | `hub.browserStackUser` | Credentials for browserstack | blank |
 | `hub.browserStackKey` | Credentials for browserstack | blank |
-| `hub.testingBotKey` | Credentials for testingbot | blank | 
-| `hub.testingBotSecret` | Credentials for testingbot | blank | 
+| `hub.testingBotKey` | Credentials for testingbot | blank |
+| `hub.testingBotSecret` | Credentials for testingbot | blank |
+| `hub.basicAuth.enabled` | Enables basic authentication | false |
+| `hub.basicAuth.username` | Username for basic authentication | zalenium |
+| `hub.basicAuth.password` | Password for basic authentication | password |
 
 Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
 

diff --git a/docs/k8s/helm/local/zalenium/templates/NOTES.txt b/docs/k8s/helm/local/zalenium/templates/NOTES.txt
@@ -1 +1,17 @@
-Hi.
+###################################################
+#                     Zalenium                    #
+###################################################
+
+Your release is named "{{ .Release.Name }}".
+
+{{- if eq true .Values.hub.basicAuth.enabled }}
+Basic Authentication:
+    Username: {{ .Values.hub.basicAuth.username }}
+    Password: {{ .Values.hub.basicAuth.password }}
+{{- end }}
+
+To learn more about the release, try:
+
+  $ helm status {{ .Release.Name }}
+  $ helm get {{ .Release.Name }}
+
diff --git a/docs/k8s/helm/local/zalenium/templates/_helpers.tpl b/docs/k8s/helm/local/zalenium/templates/_helpers.tpl
@@ -32,4 +32,11 @@ Create the name of the service account
 {{- else -}}
     {{ default "default" .Values.serviceAccount.name }}
 {{- end -}}
+{{- end -}}
+
+{{/*
+Create base64 encoded basic authentication for readiness/liveness probe
+*/}}
+{{- define "basicAuth.b64" -}}
+{{- printf "%s:%s" .Values.hub.basicAuth.username .Values.hub.basicAuth.password | b64enc -}}
 {{- end -}}
diff --git a/docs/k8s/helm/local/zalenium/templates/deployment.yaml b/docs/k8s/helm/local/zalenium/templates/deployment.yaml
@@ -63,12 +63,22 @@ spec:
             httpGet:
               path: /grid/console
               port: {{ .Values.hub.port }}
+              {{- if eq true .Values.hub.basicAuth.enabled }}
+              httpHeaders:
+              - name: Authorization
+                value: Basic {{ template "basicAuth.b64" . }}
+              {{- end}}
             initialDelaySeconds: 90
             periodSeconds: 5
           readinessProbe:
             httpGet:
               path: /grid/console
               port: {{ .Values.hub.port }}
+              {{- if eq true .Values.hub.basicAuth.enabled }}
+              httpHeaders:
+              - name: Authorization
+                value: Basic {{ template "basicAuth.b64" . }}
+              {{- end}}
             timeoutSeconds: {{ .Values.hub.readinessTimeout }}
           env:
             - name: ZALENIUM_KUBERNETES_CPU_REQUEST
@@ -127,6 +137,12 @@ spec:
             - '{{ .Values.hub.keepOnlyFailedTests }}'
             - '--retentionPeriod'
             - '{{ .Values.hub.retentionPeriod }}'
+            {{- if eq true .Values.hub.basicAuth.enabled }}
+            - '--gridUser'
+            - '{{ .Values.hub.basicAuth.username }}'
+            - '--gridPassword'
+            - '{{ .Values.hub.basicAuth.password }}'
+            {{- end }}
           resources:
 {{ toYaml .Values.hub.resources | indent 12 }}
           volumeMounts:

diff --git a/docs/k8s/helm/local/zalenium/values.yaml b/docs/k8s/helm/local/zalenium/values.yaml
@@ -76,6 +76,10 @@ hub:
   keepOnlyFailedTests: false
   retentionPeriod: 3
   sendAnonymousUsageInfo: true
+  basicAuth:
+    enabled: false
+    username: "zalenium"
+    password: "password"
 
   # Environment variables passed to Zalenium hub.
   sauceUserName: blank