Fix main includes (#2666)

Problem: The main includes were defined twice, causing some issues in reloading nginx.

Solution: Deduplicate the code.

Author: sjberman

charts/nginx-gateway-fabric/values.schema.json

@@ -519,6 +519,20 @@
           "required": [],
           "title": "securityContext",
           "type": "object"
+        },
+        "snippetsFilters": {
+          "properties": {
+            "enable": {
+              "default": false,
+              "description": "Enable SnippetsFilters feature. SnippetsFilters allow inserting NGINX configuration into the generated NGINX\nconfig for HTTPRoute and GRPCRoute resources.",
+              "required": [],
+              "title": "enable",
+              "type": "boolean"
+            }
+          },
+          "required": [],
+          "title": "snippetsFilters",
+          "type": "object"
         }
       },
       "required": [

deploy/snippets-filters-nginx-plus/deploy.yaml

@@ -153,6 +153,19 @@ subjects:
   namespace: nginx-gateway
 ---
 apiVersion: v1
+data:
+  main.conf: |
+    error_log stderr info;
+kind: ConfigMap
+metadata:
+  labels:
+    app.kubernetes.io/instance: nginx-gateway
+    app.kubernetes.io/name: nginx-gateway
+    app.kubernetes.io/version: edge
+  name: nginx-includes
+  namespace: nginx-gateway
+---
+apiVersion: v1
 kind: Service
 metadata:
   labels:
@@ -299,6 +312,33 @@ spec:
           name: nginx-cache
         - mountPath: /etc/nginx/includes
           name: nginx-includes
+      initContainers:
+      - command:
+        - /usr/bin/gateway
+        - copy
+        - --source
+        - /includes/main.conf
+        - --destination
+        - /etc/nginx/main-includes/main.conf
+        image: ghcr.io/nginxinc/nginx-gateway-fabric:edge
+        imagePullPolicy: Always
+        name: copy-nginx-config
+        securityContext:
+          capabilities:
+            add:
+            - KILL
+            drop:
+            - ALL
+          readOnlyRootFilesystem: true
+          runAsGroup: 1001
+          runAsUser: 102
+          seccompProfile:
+            type: RuntimeDefault
+        volumeMounts:
+        - mountPath: /includes
+          name: nginx-includes-configmap
+        - mountPath: /etc/nginx/main-includes
+          name: nginx-main-includes
       securityContext:
         fsGroup: 1001
         runAsNonRoot: true
@@ -320,6 +360,9 @@ spec:
         name: nginx-cache
       - emptyDir: {}
         name: nginx-includes
+      - configMap:
+          name: nginx-includes
+        name: nginx-includes-configmap
 ---
 apiVersion: gateway.networking.k8s.io/v1
 kind: GatewayClass

deploy/snippets-filters/deploy.yaml

@@ -145,6 +145,19 @@ subjects:
   namespace: nginx-gateway
 ---
 apiVersion: v1
+data:
+  main.conf: |
+    error_log stderr info;
+kind: ConfigMap
+metadata:
+  labels:
+    app.kubernetes.io/instance: nginx-gateway
+    app.kubernetes.io/name: nginx-gateway
+    app.kubernetes.io/version: edge
+  name: nginx-includes
+  namespace: nginx-gateway
+---
+apiVersion: v1
 kind: Service
 metadata:
   labels:
@@ -290,6 +303,33 @@ spec:
           name: nginx-cache
         - mountPath: /etc/nginx/includes
           name: nginx-includes
+      initContainers:
+      - command:
+        - /usr/bin/gateway
+        - copy
+        - --source
+        - /includes/main.conf
+        - --destination
+        - /etc/nginx/main-includes/main.conf
+        image: ghcr.io/nginxinc/nginx-gateway-fabric:edge
+        imagePullPolicy: Always
+        name: copy-nginx-config
+        securityContext:
+          capabilities:
+            add:
+            - KILL
+            drop:
+            - ALL
+          readOnlyRootFilesystem: true
+          runAsGroup: 1001
+          runAsUser: 102
+          seccompProfile:
+            type: RuntimeDefault
+        volumeMounts:
+        - mountPath: /includes
+          name: nginx-includes-configmap
+        - mountPath: /etc/nginx/main-includes
+          name: nginx-main-includes
       securityContext:
         fsGroup: 1001
         runAsNonRoot: true
@@ -311,6 +351,9 @@ spec:
         name: nginx-cache
       - emptyDir: {}
         name: nginx-includes
+      - configMap:
+          name: nginx-includes
+        name: nginx-includes-configmap
 ---
 apiVersion: gateway.networking.k8s.io/v1
 kind: GatewayClass

internal/mode/static/nginx/config/generator.go

@@ -146,7 +146,6 @@ func (g GeneratorImpl) getExecuteFuncs(generator policies.Generator) []executeFu
 		g.executeStreamUpstreams,
 		executeStreamMaps,
 		executeVersion,
-		executeMainIncludesConfig,
 	}
 }
 

internal/mode/static/nginx/config/main_config.go

@@ -11,16 +11,16 @@ import (
 var mainConfigTemplate = gotemplate.Must(gotemplate.New("main").Parse(mainConfigTemplateText))
 
 type mainConfig struct {
-	Includes         []shared.Include
-	TelemetryEnabled bool
+	Includes []shared.Include
+	Conf     dataplane.Configuration
 }
 
 func executeMainConfig(conf dataplane.Configuration) []executeResult {
 	includes := createIncludesFromSnippets(conf.MainSnippets)
 
 	mc := mainConfig{
-		TelemetryEnabled: conf.Telemetry.Endpoint != "",
-		Includes:         includes,
+		Conf:     conf,
+		Includes: includes,
 	}
 
 	results := make([]executeResult, 0, len(includes)+1)

internal/mode/static/nginx/config/main_config_template.go

@@ -1,10 +1,12 @@
 package config
 
 const mainConfigTemplateText = `
-{{ if .TelemetryEnabled -}}
+{{ if .Conf.Telemetry.Endpoint -}}
 load_module modules/ngx_otel_module.so;
 {{ end -}}
 
+error_log stderr {{ .Conf.Logging.ErrorLevel }};
+
 {{ range $i := .Includes -}}
 include {{ $i.Name }};
 {{ end -}}

internal/mode/static/nginx/config/main_config_test.go

@@ -56,6 +56,24 @@ func TestExecuteMainConfig_Telemetry(t *testing.T) {
 	}
 }
 
+func TestExecuteMainConfig_Logging(t *testing.T) {
+	t.Parallel()
+
+	conf := dataplane.Configuration{
+		Logging: dataplane.Logging{
+			ErrorLevel: "info",
+		},
+	}
+
+	g := NewWithT(t)
+
+	res := executeMainConfig(conf)
+	g.Expect(res).To(HaveLen(1))
+	g.Expect(res[0].dest).To(Equal(mainIncludesConfigFile))
+
+	g.Expect(string(res[0].data)).To(ContainSubstring("error_log stderr info"))
+}
+
 func TestExecuteMainConfig_Snippets(t *testing.T) {
 	t.Parallel()