Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions charts/nginx-gateway-fabric/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,10 +258,9 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri

| Key | Description | Type | Default |
|-----|-------------|------|---------|
| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"config":{},"container":{},"debug":false,"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
| `nginx` | The nginx section contains the configuration for all NGINX data plane deployments installed by the NGINX Gateway Fabric control plane. | object | `{"config":{},"container":{},"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric/nginx","tag":"edge"},"imagePullSecret":"","imagePullSecrets":[],"kind":"deployment","plus":false,"pod":{},"replicas":1,"service":{"externalTrafficPolicy":"Local","type":"LoadBalancer"},"usage":{"caSecretName":"","clientSSLSecretName":"","endpoint":"","resolver":"","secretName":"nplus-license","skipVerify":false}}` |
| `nginx.config` | The configuration for the data plane that is contained in the NginxProxy resource. | object | `{}` |
| `nginx.container` | The container configuration for the NGINX container. | object | `{}` |
| `nginx.debug` | Enable debugging for NGINX. Uses the nginx-debug binary. The NGINX error log level should be set to debug in the NginxProxy resource. | bool | `false` |
| `nginx.image.repository` | The NGINX image to use. | string | `"ghcr.io/nginx/nginx-gateway-fabric/nginx"` |
| `nginx.imagePullSecret` | The name of the secret containing docker registry credentials. Secret must exist in the same namespace as the helm release. The control plane will copy this secret into any namespace where NGINX is deployed. | string | `""` |
| `nginx.imagePullSecrets` | A list of secret names containing docker registry credentials. Secrets must exist in the same namespace as the helm release. The control plane will copy these secrets into any namespace where NGINX is deployed. | list | `[]` |
Expand Down
2 changes: 2 additions & 0 deletions charts/nginx-gateway-fabric/templates/nginxproxy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +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:
Expand Down
7 changes: 0 additions & 7 deletions charts/nginx-gateway-fabric/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -229,13 +229,6 @@
"title": "container",
"type": "object"
},
"debug": {
"default": false,
"description": "Enable debugging for NGINX. Uses the nginx-debug binary. The NGINX error log level should be set to debug in the NginxProxy resource.",
"required": [],
"title": "debug",
"type": "boolean"
},
"image": {
"properties": {
"pullPolicy": {
Expand Down
2 changes: 1 addition & 1 deletion charts/nginx-gateway-fabric/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -425,4 +425,4 @@ nginx:
# loadBalancerSourceRanges: []

# -- Enable debugging for NGINX. Uses the nginx-debug binary. The NGINX error log level should be set to debug in the NginxProxy resource.
debug: false
# debug: false
1 change: 0 additions & 1 deletion deploy/aws-nlb/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
1 change: 0 additions & 1 deletion deploy/azure/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
1 change: 0 additions & 1 deletion deploy/default/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
1 change: 0 additions & 1 deletion deploy/experimental-nginx-plus/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: private-registry.nginx.com/nginx-gateway-fabric/nginx-plus
Expand Down
1 change: 0 additions & 1 deletion deploy/experimental/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
1 change: 0 additions & 1 deletion deploy/nginx-plus/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: private-registry.nginx.com/nginx-gateway-fabric/nginx-plus
Expand Down
1 change: 0 additions & 1 deletion deploy/nodeport/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
1 change: 0 additions & 1 deletion deploy/openshift/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
1 change: 0 additions & 1 deletion deploy/snippets-filters-nginx-plus/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: private-registry.nginx.com/nginx-gateway-fabric/nginx-plus
Expand Down
1 change: 0 additions & 1 deletion deploy/snippets-filters/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,6 @@ spec:
kubernetes:
deployment:
container:
debug: false
image:
pullPolicy: Always
repository: ghcr.io/nginx/nginx-gateway-fabric/nginx
Expand Down
Loading