Add support for nginx debug mode in CP/DP split

bjee19 · bjee19 · commit 986971e764b3 · 2025-02-19T10:43:14.000-08:00
diff --git a/apis/v1alpha2/nginxproxy_types.go b/apis/v1alpha2/nginxproxy_types.go
@@ -435,6 +435,12 @@ type PodSpec struct {
 
 // ContainerSpec defines container fields for the NGINX container.
 type ContainerSpec struct {
+	// Debug enables debugging for NGINX by using the nginx-debug binary.
+	//
+	// +optional
+	// +kubebuilder:default=false
+	Debug *bool `json:"debug,omitempty"`
+
 	// Image is the NGINX image to use.
 	//
 	// +optional
diff --git a/apis/v1alpha2/zz_generated.deepcopy.go b/apis/v1alpha2/zz_generated.deepcopy.go
diff --git a/charts/nginx-gateway-fabric/templates/nginxproxy.yaml b/charts/nginx-gateway-fabric/templates/nginxproxy.yaml
@@ -23,6 +23,7 @@ spec:
         {{- end }}
         image:
           {{- toYaml .Values.nginx.image | nindent 10 }}
+        debug: {{ .Values.nginx.debug }}
     {{- end }}
     {{- if .Values.nginx.service }}
     service:
diff --git a/config/crd/bases/gateway.nginx.org_nginxproxies.yaml b/config/crd/bases/gateway.nginx.org_nginxproxies.yaml
@@ -79,6 +79,11 @@ spec:
                         description: Container defines container fields for the NGINX
                           container.
                         properties:
+                          debug:
+                            default: false
+                            description: Debug enables debugging for NGINX by using
+                              the nginx-debug binary.
+                            type: boolean
                           image:
                             description: Image is the NGINX image to use.
                             properties:
diff --git a/deploy/aws-nlb/deploy.yaml b/deploy/aws-nlb/deploy.yaml
@@ -301,6 +301,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/deploy/azure/deploy.yaml b/deploy/azure/deploy.yaml
@@ -303,6 +303,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/deploy/crds.yaml b/deploy/crds.yaml
@@ -664,6 +664,11 @@ spec:
                         description: Container defines container fields for the NGINX
                           container.
                         properties:
+                          debug:
+                            default: false
+                            description: Debug enables debugging for NGINX by using
+                              the nginx-debug binary.
+                            type: boolean
                           image:
                             description: Image is the NGINX image to use.
                             properties:
diff --git a/deploy/default/deploy.yaml b/deploy/default/deploy.yaml
@@ -301,6 +301,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/deploy/experimental-nginx-plus/deploy.yaml b/deploy/experimental-nginx-plus/deploy.yaml
@@ -308,6 +308,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: private-registry.nginx.com/nginx-gateway-fabric/nginx-plus
diff --git a/deploy/experimental/deploy.yaml b/deploy/experimental/deploy.yaml
@@ -306,6 +306,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/deploy/nginx-plus/deploy.yaml b/deploy/nginx-plus/deploy.yaml
@@ -303,6 +303,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: private-registry.nginx.com/nginx-gateway-fabric/nginx-plus
diff --git a/deploy/nodeport/deploy.yaml b/deploy/nodeport/deploy.yaml
@@ -301,6 +301,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/deploy/openshift/deploy.yaml b/deploy/openshift/deploy.yaml
@@ -311,6 +311,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/deploy/snippets-filters-nginx-plus/deploy.yaml b/deploy/snippets-filters-nginx-plus/deploy.yaml
@@ -306,6 +306,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: private-registry.nginx.com/nginx-gateway-fabric/nginx-plus
diff --git a/deploy/snippets-filters/deploy.yaml b/deploy/snippets-filters/deploy.yaml
@@ -304,6 +304,7 @@ spec:
   kubernetes:
     deployment:
       container:
+        debug: false
         image:
           pullPolicy: Always
           repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
diff --git a/internal/mode/static/provisioner/objects.go b/internal/mode/static/provisioner/objects.go
@@ -447,6 +447,12 @@ func (p *NginxProvisioner) buildNginxPodTemplateSpec(
 			}
 			container.Lifecycle = containerSpec.Lifecycle
 			container.VolumeMounts = append(container.VolumeMounts, containerSpec.VolumeMounts...)
+
+			// ensure that this "effectiveNginxProxy" works
+			if containerSpec.Debug != nil && *containerSpec.Debug {
+				container.Command = append(container.Command, "/bin/sh")
+				container.Args = append(container.Args, "-c", "rm -rf /var/run/nginx/*sock && nginx-debug -g 'daemon off;'")
+			}
 			spec.Spec.Containers[0] = container
 		}
 	}
diff --git a/internal/mode/static/state/graph/nginxproxy_test.go b/internal/mode/static/state/graph/nginxproxy_test.go
@@ -55,6 +55,7 @@ func TestBuildEffectiveNginxProxy(t *testing.T) {
 		logLevel ngfAPIv1alpha2.NginxErrorLogLevel,
 		setIP bool,
 		disableHTTP bool,
+		nginxDebug bool,
 	) *ngfAPIv1alpha2.NginxProxy {
 		return &ngfAPIv1alpha2.NginxProxy{
 			Spec: ngfAPIv1alpha2.NginxProxySpec{
@@ -79,6 +80,13 @@ func TestBuildEffectiveNginxProxy(t *testing.T) {
 					ErrorLevel: &logLevel,
 				},
 				DisableHTTP2: &disableHTTP,
+				Kubernetes: &ngfAPIv1alpha2.KubernetesSpec{
+					Deployment: &ngfAPIv1alpha2.DeploymentSpec{
+						Container: ngfAPIv1alpha2.ContainerSpec{
+							Debug: &nginxDebug,
+						},
+					},
+				},
 			},
 		}
 	}
@@ -100,6 +108,7 @@ func TestBuildEffectiveNginxProxy(t *testing.T) {
 			ngfAPIv1alpha2.NginxLogLevelAlert,
 			true,
 			false,
+			false,
 		)
 	}
 
@@ -120,6 +129,7 @@ func TestBuildEffectiveNginxProxy(t *testing.T) {
 			ngfAPIv1alpha2.NginxLogLevelError,
 			false,
 			true,
+			true,
 		)
 	}
 
