Merge pull request #2 from cloudogu/log-level

Logging and ServiceAccount fixes

Author: schnatterer

Chart.yaml

@@ -4,6 +4,6 @@ description: A Helm chart for GOP
 type: application
 icon: https://about.cloudogu.com/assets/cloudogu-logo-f1f26e5c32f240d0a161cebe71e91138ee5662c1f99fb314539a4763ef5959a946130f1a12e9bc39c83c127092a66b919d1fae86fadd5fe9639d06032787a03d.svg
 
-version: 0.2.0
+version: 0.3.0
 
 appVersion: "latest" # We couple app releases and chart releases later

README.md

@@ -178,15 +178,17 @@ spec:
 
 ## Releasing
 
+Make sure the `version` in Chart.yaml is set. Otherwise, the release job will fail.
+
 On `main` branch:
 
-````shell
+```shell
 TAG=0.2.0
 
 git checkout main
 [[ $? -eq 0 ]] && git pull
 [[ $? -eq 0 ]] && git tag -s $TAG -m $TAG
 [[ $? -eq 0 ]] && git push --follow-tags
 
-[[ $? -eq 0 ]] && xdg-open https://ecosystem.cloudogu.com/jenkins/job/cloudogu-github/job/gitops-playground/job/main/build?delay=0sec
-````
+[[ $? -eq 0 ]] && xdg-open https://ecosystem.cloudogu.com/jenkins/job/cloudogu-github/job/gop-helm/
+```

templates/_helpers.tpl

@@ -57,9 +57,13 @@ Create the name of the service account to use
 */}}
 {{- define "gop.serviceAccountName" -}}
 {{- if .Values.serviceAccount.create }}
-{{- default (include "gop.fullname" .) .Values.serviceAccount.name }}-{{ include "valuesHash" . | lower }}
+  {{- if .Values.serviceAccount.name }}
+    {{ printf "%s-%s" .Values.serviceAccount.name (include "valuesHash" . | lower) }}
+  {{- else }}
+    {{ include "gop.fullname" . }}
+  {{- end }}
 {{- else }}
-{{- default "default" .Values.serviceAccount.name }}-{{ include "valuesHash" . | lower }}
+  {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
 {{- end }}
 
@@ -69,4 +73,4 @@ Usage: {{ include "valuesHash" . }}
 */}}
 {{- define "valuesHash" -}}
 {{- toJson .Values | sha256sum | trunc 8 -}}
-{{- end }}
+{{- end }}

templates/gopJob.yaml

@@ -22,7 +22,7 @@ spec:
       imagePullSecrets:
         {{- toYaml . | nindent 8 }}
       {{- end }}
-      serviceAccountName: {{ include "gop.serviceAccountName" . }}
+      serviceAccountName: "{{ include "gop.serviceAccountName" . }}"
       securityContext:
         {{- toYaml .Values.podSecurityContext | nindent 8 }}
       containers:

templates/rbac.yaml

@@ -7,7 +7,7 @@ metadata:
     {{- include "gop.labels" . | nindent 4 }}
 subjects:
   - kind: ServiceAccount
-    name: {{ include "gop.serviceAccountName" . }}
+    name: "{{ include "gop.serviceAccountName" . }}"
     namespace: {{ .Release.Namespace }}
 roleRef:
   kind: ClusterRole
@@ -17,11 +17,11 @@ roleRef:
 apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: {{ include "gop.serviceAccountName" . }}
+  name: "{{ include "gop.serviceAccountName" . }}"
   labels:
     {{- include "gop.labels" . | nindent 4 }}
   {{- with .Values.serviceAccount.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}
   {{- end }}
-{{- end }}
+{{- end }}

tests/config_test.yaml

@@ -3,9 +3,9 @@ suite: test config
 templates:
   - config-map.yaml
 tests:
-  - it:  should set the config
+  - it: should set the config
     set:
-      config: 
+      config:
         ab: cd
     asserts:
       - equal:

tests/serviceAccount_test.yaml

@@ -0,0 +1,38 @@
+suite: Test Job serviceAccountName rendering
+templates:
+  - templates/gopJob.yaml
+
+tests:
+  - it: returns name from fullname (with hash inside) when create is true and name is not provided
+    set:
+      serviceAccount.create: true
+    asserts:
+      - matchRegex:
+          path: spec.template.spec.serviceAccountName
+          pattern: "RELEASE-NAME-gop-helm-[a-z0-9]{8}$"
+
+  - it: returns custom name with hash when create is true and name is provided
+    set:
+      serviceAccount.create: true
+      serviceAccount.name: my-custom-sa
+    asserts:
+      - matchRegex:
+          path: spec.template.spec.serviceAccountName
+          pattern: "my-custom-sa-[a-z0-9]{8}$"
+
+  - it: returns custom name without hash when create is false
+    set:
+      serviceAccount.create: false
+      serviceAccount.name: existing-sa
+    asserts:
+      - equal:
+          path: spec.template.spec.serviceAccountName
+          value: existing-sa
+
+  - it: returns 'default' when create is false and no name is provided
+    set:
+      serviceAccount.create: false
+    asserts:
+      - equal:
+          path: spec.template.spec.serviceAccountName
+          value: default

values.yaml

@@ -14,7 +14,7 @@ config: {}
 configSecret: ''
 # configSecret: gop-secret
 
-# logLevel: trace # debug also possible 
+logLevel: trace # debug also possible, all other values result in info logging
 
 # This sets the container image more information can be found here: https://kubernetes.io/docs/concepts/containers/images/
 image:
@@ -92,4 +92,4 @@ nodeSelector: {}
 
 tolerations: []
 
-affinity: {}
+affinity: {}