✨(helm) allow to load custom theme file in a configMap

In order to load a custom theme file with our helm chart, we allow to
load the content of a file into a config map and then use this configmap
as a volume in the backend deployment

Author: lunika

Dockerfile

@@ -87,10 +87,6 @@ RUN wget https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
 # Copy entrypoint
 COPY ./docker/files/usr/local/bin/entrypoint /usr/local/bin/entrypoint
 
-# Copy configuration
-VOLUME [ "/configuration" ]
-COPY ./configuration /configuration
-
 # Give the "root" group the same permissions as the "root" user on /etc/passwd
 # to allow a user belonging to the root group to add new users; typically the
 # docker user (see entrypoint).

configuration/theme/default.json renamed to src/helm/env.d/dev/configuration/theme/demo.json

@@ -87,6 +87,10 @@ backend:
         python manage.py createsuperuser --email [email protected] --password admin
     restartPolicy: Never
 
+  themeCustomization:
+    enabled: true
+    file_content: {{ readFile "./configuration/theme/demo.json" }}
+
   # Extra volume mounts to manage our local custom CA and avoid to set ssl_verify: false
   extraVolumeMounts:
     - name: certs
@@ -101,7 +105,6 @@ backend:
         items:
         - key: cacert.pem
           path: cacert.pem
-
 frontend:
   envVars:
     PORT: 8080

src/helm/env.d/dev/values.impress.yaml.gotmpl

@@ -90,6 +90,11 @@ spec:
               subPath: {{ .subPath | default "" }}
               readOnly: {{ .readOnly }}
             {{- end }}
+            {{- if .Values.backend.themeCustomization.enabled }}
+            - name: theme-customization
+              mountPath: {{ .Values.backend.themeCustomization.mount_path }}
+              readOnly: true
+            {{- end }}
       {{- with .Values.backend.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}
@@ -117,6 +122,11 @@ spec:
             claimName: "{{ $fullName }}-{{ $name }}"
           {{- end }}
         {{- end }}
+        {{- if .Values.backend.themeCustomization.enabled }}
+        - name: theme-customization
+          configMap:
+            name: docs-theme-customization
+        {{- end }}
         {{- range .Values.backend.extraVolumes }}
         - name: {{ .name }}
           {{- if .existingClaim }}

src/helm/impress/README.md

@@ -0,0 +1,10 @@
+{{- if .Values.backend.themeCustomization.enabled }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: docs-theme-customization
+  namespace: {{ .Release.Namespace }}
+data:
+  default.json: |
+    {{ .Values.backend.themeCustomization.file_content | toJson | indent 4 }}
+{{- end }}

src/helm/impress/templates/backend_deployment.yaml

@@ -162,6 +162,7 @@ ingressMedia:
   ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-url
   ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/auth-response-headers
   ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/upstream-vhost
+  ## @param ingressMedia.annotations.nginx.ingress.kubernetes.io/configuration-snippet
   annotations:
     nginx.ingress.kubernetes.io/auth-url: https://impress.example.com/api/v1.0/documents/media-auth/
     nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Amz-Date, X-Amz-Content-SHA256"
@@ -310,6 +311,16 @@ backend:
   pdb:
     enabled: true
 
+  ## @param backend.themeCustomization.enabled Enable theme customization
+  ## @param backend.themeCustomization.file_content Content of the theme customization file. Must be a json object.
+  ## @param backend.themeCustomization.mount_path Path where the customization file will be mounted in the backend deployment.
+  themeCustomization:
+    enabled: false
+    file_content: ""
+    mount_path: /app/configuration/theme/
+
+
+
 ## @section frontend
 
 frontend: