CP/DP split: Support nginx debug mode when provisioning Data Plane (#3147)

Support nginx debug mode when provisioning the Data Plane.

Problem: We want to have the option to provision nginx instances in debug mode.

Solution: Add debug field to NginxProxy CRD. Also user can set debug field when installing through Helm by setting the nginx.debug flag.

Author: bjee19

apis/v1alpha2/nginxproxy_types.go

@@ -435,6 +435,11 @@ 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
+	Debug *bool `json:"debug,omitempty"`
+
 	// Image is the NGINX image to use.
 	//
 	// +optional

apis/v1alpha2/zz_generated.deepcopy.go

@@ -16,7 +16,13 @@ rm -rf /var/run/nginx/*.sock
 
 # Launch nginx
 echo "starting nginx ..."
-/usr/sbin/nginx -g "daemon off;" &
+
+# if we want to use the nginx-debug binary, we will call this script with an argument "debug"
+if [ "${1:-false}" = "debug" ]; then
+    /usr/sbin/nginx-debug -g "daemon off;" &
+else
+    /usr/sbin/nginx -g "daemon off;" &
+fi
 
 nginx_pid=$!
 
@@ -31,7 +37,7 @@ done
 
 # start nginx-agent, pass args
 echo "starting nginx-agent ..."
-nginx-agent "$@" &
+nginx-agent &
 
 agent_pid=$!
 

build/entrypoint.sh

@@ -23,6 +23,9 @@ spec:
         {{- end }}
         image:
           {{- toYaml .Values.nginx.image | nindent 10 }}
+        {{- if .Values.nginx.debug }}
+        debug: {{ .Values.nginx.debug }}
+        {{- end }}
     {{- end }}
     {{- if .Values.nginx.service }}
     service:

charts/nginx-gateway-fabric/templates/nginxproxy.yaml

@@ -79,6 +79,10 @@ spec:
                         description: Container defines container fields for the NGINX
                           container.
                         properties:
+                          debug:
+                            description: Debug enables debugging for NGINX by using
+                              the nginx-debug binary.
+                            type: boolean
                           image:
                             description: Image is the NGINX image to use.
                             properties:

config/crd/bases/gateway.nginx.org_nginxproxies.yaml

@@ -664,6 +664,10 @@ spec:
                         description: Container defines container fields for the NGINX
                           container.
                         properties:
+                          debug:
+                            description: Debug enables debugging for NGINX by using
+                              the nginx-debug binary.
+                            type: boolean
                           image:
                             description: Image is the NGINX image to use.
                             properties:

deploy/crds.yaml

@@ -447,6 +447,11 @@ func (p *NginxProvisioner) buildNginxPodTemplateSpec(
 			}
 			container.Lifecycle = containerSpec.Lifecycle
 			container.VolumeMounts = append(container.VolumeMounts, containerSpec.VolumeMounts...)
+
+			if containerSpec.Debug != nil && *containerSpec.Debug {
+				container.Command = append(container.Command, "/agent/entrypoint.sh")
+				container.Args = append(container.Args, "debug")
+			}
 			spec.Spec.Containers[0] = container
 		}
 	}

internal/mode/static/provisioner/objects.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,
 		)
 	}