[nginx] add predefined configmaps (CloudPirates-io#154)

* add external configmaps

* fix linting

* Update CHANGELOG.md

Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

---------

Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: mms-gianni

charts/nginx/CHANGELOG.md

@@ -1,23 +1,5 @@
 # Changelog
 
-## 0.1.6 (2025-09-11)
+## 0.1.7 (2025-09-24)
 
-* [nginx]: Implement fix ([#79](https://github.com/CloudPirates-io/helm-charts/pull/79))
-
-## <small>0.1.3 (2025-09-08)</small>
-
-* add artifacthub-repo id ([ee4f192](https://github.com/CloudPirates-io/helm-charts/commit/ee4f192))
-* bump version to 0.1.2 ([f75a781](https://github.com/CloudPirates-io/helm-charts/commit/f75a781))
-* fix containerport and change ingress host-pathtype ([60e3223](https://github.com/CloudPirates-io/helm-charts/commit/60e3223))
-* Update appVersion ([933ba01](https://github.com/CloudPirates-io/helm-charts/commit/933ba01))
-* update chart-icon ([7ed7c8e](https://github.com/CloudPirates-io/helm-charts/commit/7ed7c8e))
-* add hpa feature ([e5eab56](https://github.com/CloudPirates-io/helm-charts/commit/e5eab56))
-* Bump nginx to latest version + alpine ([8b0fc57](https://github.com/CloudPirates-io/helm-charts/commit/8b0fc57))
-* fix linting ([11d72e9](https://github.com/CloudPirates-io/helm-charts/commit/11d72e9))
-* Initial commit to add Nginx ([1579cc4](https://github.com/CloudPirates-io/helm-charts/commit/1579cc4))
-* make nginx work ([097d204](https://github.com/CloudPirates-io/helm-charts/commit/097d204))
-* Update CHANGELOG.md ([d0f0153](https://github.com/CloudPirates-io/helm-charts/commit/d0f0153))
-* Update CHANGELOG.md ([4ff2bbc](https://github.com/CloudPirates-io/helm-charts/commit/4ff2bbc))
-* Update CHANGELOG.md ([a13f40d](https://github.com/CloudPirates-io/helm-charts/commit/a13f40d))
-* Update CHANGELOG.md ([19e5317](https://github.com/CloudPirates-io/helm-charts/commit/19e5317))
-* Update readme ([e09a5a3](https://github.com/CloudPirates-io/helm-charts/commit/e09a5a3))
+* [nginx] add external configmaps ([#5](https://github.com/mmz-srf/cloudpirates-helm-charts/pull/5))

charts/nginx/Chart.yaml

@@ -2,30 +2,23 @@ apiVersion: v2
 name: nginx
 description: Nginx is a high-performance HTTP server and reverse proxy.
 type: application
-
-version: 0.1.6
+version: 0.1.7
 appVersion: "1.29.1"
-
 keywords:
   - nginx
   - web server
   - http
   - reverse proxy
   - load balancer
   - proxy
-
 home: https://www.cloudpirates.io
-
 sources:
   - https://github.com/CloudPirates-io/helm-charts/tree/main/charts/nginx
-
 maintainers:
   - name: CloudPirates GmbH & Co. KG
     url: https://www.cloudpirates.io
-
 dependencies:
   - name: common
     version: "1.x.x"
     repository: oci://registry-1.docker.io/cloudpirates
-
 icon: https://a.storyblok.com/f/143071/512x512/9fcd98c061/nginx-logo.svg

charts/nginx/README.md

@@ -139,12 +139,45 @@ The following table lists the configurable parameters of the Nginx chart and the
 
 ### Nginx Configuration Parameters
 
-| Parameter             | Description                                               | Default |
-| --------------------- | --------------------------------------------------------- | ------- |
-| `config`              | Custom NGINX configuration file (nginx.conf)              | `""`    |
-| `serverConfig`        | Custom server block to be added to NGINX configuration    | `""`    |
-| `streamServerConfig`  | Custom stream server block to be added to NGINX config    | `""`    |
-
+Existing Configmaps are prioritized over inline configuration. Inline configuration will trigger a pod restart if changed.
+
+| Parameter                             | Description                                                 | Default |
+| ------------------------------------- | ----------------------------------------------------------- | ------- |
+| `config`                              | Custom NGINX configuration file (nginx.conf)                | `""`    |
+| `existingConfigConfigmap`             | Name of an existing ConfigMap containing nginx.conf         | `""`    |
+| `serverConfig`                        | Custom server block to be added to NGINX configuration      | `""`    |
+| `existingServerConfigConfigmap`       | Name of an existing ConfigMap containing server-config.conf | `""`    |
+| `streamServerConfig`                  | Custom stream server block to be added to NGINX config      | `""`    |
+| `existingStreamServerConfigConfigmap` | Name of an existing ConfigMap containing stream-server-config.conf | `""`    |
+
+Example of an existing external `config`:
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: example-nginx-config
+data:
+  nginx.conf: |-
+    user  nginx;
+    worker_processes  1;
+    error_log  /var/log/nginx/error.log warn;
+    pid        /run/nginx.pid;
+
+    events {
+        worker_connections  1024;
+    }
+    http {
+        include       /etc/nginx/mime.types;
+        default_type  application/octet-stream;
+        log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                          '$status $body_bytes_sent "$http_referer" '
+                          '"$http_user_agent" "$http_x_forwarded_for"';
+        access_log  /var/log/nginx/access.log  main;
+        sendfile        on;
+        keepalive_timeout  65;
+        include /etc/nginx/conf.d/*.conf;
+    }
+```
 
 ### Container Port Parameters
 

charts/nginx/templates/_helpers.tpl

@@ -63,4 +63,38 @@ Create the name of the service account to use
 {{- else }}
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
-{{- end }}
+{{- end }}
+
+
+{{/*
+Return the custom NGINX config configmap.
+*/}}
+{{- define "nginx.configConfigmapName" -}}
+{{- if .Values.existingConfigConfigmap -}}
+    {{- printf "%s" (tpl .Values.existingConfigConfigmap $) -}}
+{{- else -}}
+    {{- include "common.fullname" . -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Return the custom NGINX server config configmap.
+*/}}
+{{- define "nginx.serverConfigConfigmapName" -}}
+{{- if .Values.existingServerConfigConfigmap -}}
+    {{- printf "%s" (tpl .Values.existingServerConfigConfigmap $) -}}
+{{- else -}}
+    {{- include "common.fullname" . -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Return the custom NGINX stream server config configmap.
+*/}}
+{{- define "nginx.streamServerConfigConfigmapName" -}}
+{{- if .Values.existingStreamServerConfigConfigmap -}}
+    {{- printf "%s" (tpl .Values.existingStreamServerConfigConfigmap $) -}}
+{{- else -}}
+    {{- include "common.fullname" . -}}
+{{- end -}}
+{{- end -}}

charts/nginx/templates/configmap.yaml

@@ -1,4 +1,4 @@
-{{- if or .Values.serverConfig .Values.streamServerConfig }}
+{{- if or .Values.config .Values.serverConfig .Values.streamServerConfig }}
 apiVersion: v1
 kind: ConfigMap
 metadata:

charts/nginx/templates/deployment.yaml

@@ -148,14 +148,19 @@ spec:
             - name: static-site
               mountPath: /usr/share/nginx/html
           {{- end }}
-          {{- if .Values.config }}
+          {{- if or .Values.config .Values.existingConfigConfigmap }}
             - name: nginx-config
-              mountPath: /etc/nginx/conf.d
+              mountPath: /etc/nginx/nginx.conf
+              subPath: nginx.conf
           {{- end }}
-          {{- if or .Values.serverConfig .Values.streamServerConfig }}
+          {{- if or .Values.serverConfig .Values.existingServerConfigConfigmap }}
             - name: nginx-server-config
               mountPath: /etc/nginx/conf.d
           {{- end }}
+          {{- if or .Values.streamServerConfig .Values.existingStreamServerConfigConfigmap }}
+            - name: stream-server-config
+              mountPath: /etc/nginx/conf.d
+          {{- end }}
           {{- if .Values.extraVolumeMounts }}
             {{- toYaml .Values.extraVolumeMounts | nindent 12 }}
           {{- end }}
@@ -220,15 +225,29 @@ spec:
                 path: stream-server-config.conf
             {{- end }}
       {{- end }}
-      {{- if or .Values.serverConfig .Values.streamServerConfig }}
+      {{- if or .Values.config .Values.existingConfigConfigmap }}
         - name: nginx-config
           configMap:
-            name: {{ include "nginx.fullname" . }}
-            {{- if .Values.serverConfig }}
+            name: {{ include "nginx.configConfigmapName" . }}
             items:
               - key: nginx.conf
                 path: nginx.conf
-            {{- end }}
+      {{- end }}
+      {{- if or .Values.serverConfig .Values.existingServerConfigConfigmap }}
+        - name: server-config
+          configMap:
+            name: {{ include "nginx.serverConfigConfigmapName" . }}
+            items:
+              - key: server-config.conf
+                path: server-config.conf
+      {{- end }}
+      {{- if or .Values.streamServerConfig .Values.existingStreamServerConfigConfigmap }}
+        - name: stream-server-config
+          configMap:
+            name: {{ include "nginx.streamServerConfigConfigmapName" . }}
+            items:
+              - key: stream-server-config.conf
+                path: stream-server-config.conf
       {{- end }}
       {{- if .Values.extraVolumes }}
       {{- toYaml .Values.extraVolumes | nindent 8 }}

charts/nginx/values.schema.json

@@ -184,7 +184,10 @@
     "extraVolumeMounts": { "type": "array", "items": { "type": "object" } },
     "extraObjects": { "type": "array", "items": { "type": "object" } },
     "config": { "type": "string" },
+    "existingConfigConfigmap": { "type": "string" },
     "serverConfig": { "type": "string" },
-    "streamServerConfig": { "type": "string" }
+    "existingServerConfigConfigmap": { "type": "string" },
+    "streamServerConfig": { "type": "string" },
+    "existingStreamServerConfigmap": { "type": "string" }
   }
 }

charts/nginx/values.yaml

@@ -258,6 +258,9 @@ extraObjects: []
 ##
 config: ""
 
+## @param existingConfigConfigmap Name of an existing ConfigMap containing nginx.conf
+existingConfigConfigmap: ""
+
 ## @param serverConfig Custom server block to be added to NGINX configuration
 ## PHP-FPM example server block:
 ## serverConfig: |-
@@ -275,6 +278,10 @@ config: ""
 ##   }
 ##
 serverConfig: ""
+
+## @param existingServerConfigConfigmap Name of an existing ConfigMap containing server-config.conf
+existingServerConfigConfigmap: ""
+
 ## @param streamServerConfig Custom stream server block to be added to NGINX configuration
 ## streamServerConfig: |-
 ##   server {
@@ -283,3 +290,6 @@ serverConfig: ""
 ##   }
 ##
 streamServerConfig: ""
+
+## @param existingStreamServerConfigmap Name of an existing ConfigMap containing stream-server-config.conf
+existingStreamServerConfigConfigmap: ""