Add applyToNginx for extraFileMappings (#337)

* Add applyToNginx for extraFileMappings * Add applyToNginx to welcome page * Update README for extraFileMappings * Add spaces to extraFileMappings
galaxyproject · Oct 8, 2021 · ba1f2fc · ba1f2fc
1 parent 5812c74
commit ba1f2fc
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -263,20 +263,25 @@ jobHandlers:
 
 ## Extra File Mappings
 
-The `extraFileMappings` field can be used to inject files to arbitrary paths in the `job`, `web`, or `workflow` handlers.  The contents of the file can be specified directly in the `values.yml` file with the `content` attribute, or by specifying the path to the file to be injected with the `path` attribute.
+The `extraFileMappings` field can be used to inject files to arbitrary paths in the `nginx` deployment, as well as any of the `job`, `web`, or `workflow` handlers.
+
+The contents of the file can be specified directly in the `values.yml` file with the `content` attribute.
+
+The `tpl` flag will determine whether these contents are run through the helm templating engine.
+
+Note: when running with `tpl: true`, brackets (`{{ }}`) not meant for Helm should be escaped. One way of escaping is: `{{ '{{ mynon-helm-content}}' }}`
 
 ```yaml
 extraFileMappings:
   /galaxy/server/static/welcome.html:
     applyToWeb: true
     applyToJob: false
     applyToWorkflow: false
+    applyToNginx: true
+    tpl: false
     content: |
       <!DOCTYPE html>
       <html>...</html>
-  /galaxy/server/config/object_store_conf.xml:
-    applyToWeb: true
-    path: files/config/object_store_conf.xml
 ```
 
 **NOTE** for security reasons Helm will not load files from outside the chart so the `path` must be a relative path to location inside the chart directory.  This will change when [helm#3276](https://github.com/helm/helm/issues/3276) is resolved.  In the interim files can be loaded from external locations by:

diff --git a/galaxy/templates/deployment-nginx.yaml b/galaxy/templates/deployment-nginx.yaml
@@ -37,6 +37,13 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           volumeMounts:
+            {{- range $key, $entry := .Values.extraFileMappings -}}
+            {{- if $entry.applyToNginx }}
+            - name: {{ include "galaxy.getExtraFilesUniqueName" $key }}
+              mountPath: {{ $key }}
+              subPath: {{ include "galaxy.getFilenameFromPath" $key }}
+            {{- end }}
+            {{- end }}
             - name: static-dir
               mountPath: /tmp/galaxy
           command: ['/bin/sh', '-c', 'cp -r /galaxy/server/static /tmp/galaxy/static;']
@@ -49,6 +56,13 @@ spec:
               containerPort: 80
               protocol: TCP
           volumeMounts:
+            {{- range $key, $entry := .Values.extraFileMappings -}}
+            {{- if $entry.applyToNginx }}
+            - name: {{ include "galaxy.getExtraFilesUniqueName" $key }}
+              mountPath: {{ $key }}
+              subPath: {{ include "galaxy.getFilenameFromPath" $key }}
+            {{- end }}
+            {{- end }}
             - name: nginx-conf
               mountPath: /etc/nginx/nginx.conf
               subPath: nginx.conf
@@ -81,6 +95,18 @@ spec:
               exec:
                 command: ["/usr/sbin/nginx","-s","quit"]
       volumes:
+        {{- range $key, $entry := .Values.extraFileMappings -}}
+        {{- if $entry.applyToNginx }}
+        - name: {{ include "galaxy.getExtraFilesUniqueName" $key }}
+          {{- if $entry.useSecret }}
+          secret:
+            secretName: {{ printf "%s-%s" (include "galaxy.fullname" $) (include "galaxy.getExtraFilesUniqueName" $key) }}
+          {{- else }}
+          configMap:
+            name: {{ printf "%s-%s" (include "galaxy.fullname" $) (include "galaxy.getExtraFilesUniqueName" $key) }}
+          {{- end }}
+        {{- end }}
+        {{- end }}
         - name: nginx-conf
           configMap:
             name: {{ template "galaxy.fullname" $ }}-nginx-conf

diff --git a/galaxy/values.yaml b/galaxy/values.yaml
@@ -593,6 +593,7 @@ extraFileMappings:
     applyToJob: false
     applyToWeb: true
     applyToWorkflow: false
+    applyToNginx: true
     tpl: true
     content: |
       <!DOCTYPE html>