Skip to content

feat(chart): add priorityClassName for control plane pod #4356

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −1
Open

feat(chart): add priorityClassName for control plane pod #4356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 1 deletion charts/nginx-gateway-fabric/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
| `nginx.usage.resolver` | The nameserver used to resolve the NGINX Plus usage reporting endpoint. Used with NGINX Instance Manager. | string | `""` |
| `nginx.usage.secretName` | The name of the Secret containing the JWT for NGINX Plus usage reporting. Must exist in the same namespace that the NGINX Gateway Fabric control plane is running in (default namespace: nginx-gateway). | string | `"nplus-license"` |
| `nginx.usage.skipVerify` | Disable client verification of the NGINX Plus usage reporting server certificate. | bool | `false` |
| `nginxGateway` | The nginxGateway section contains configuration for the NGINX Gateway Fabric control plane deployment. | object | `{"affinity":{},"autoscaling":{"enable":false},"config":{"logging":{"level":"info"}},"configAnnotations":{},"extraVolumeMounts":[],"extraVolumes":[],"gatewayClassAnnotations":{},"gatewayClassName":"nginx","gatewayControllerName":"gateway.nginx.org/nginx-gateway-controller","gwAPIExperimentalFeatures":{"enable":false},"gwAPIInferenceExtension":{"enable":false,"endpointPicker":{"disableTLS":false,"skipVerify":true}},"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric","tag":"edge"},"kind":"deployment","labels":{},"leaderElection":{"enable":true,"lockName":""},"lifecycle":{},"metrics":{"enable":true,"port":9113,"secure":false},"name":"","nodeSelector":{},"podAnnotations":{},"productTelemetry":{"enable":true},"readinessProbe":{"enable":true,"initialDelaySeconds":3,"port":8081},"replicas":1,"resources":{},"service":{"annotations":{},"labels":{}},"serviceAccount":{"annotations":{},"imagePullSecret":"","imagePullSecrets":[],"name":""},"snippetsFilters":{"enable":false},"terminationGracePeriodSeconds":30,"tolerations":[],"topologySpreadConstraints":[]}` |
| `nginxGateway` | The nginxGateway section contains configuration for the NGINX Gateway Fabric control plane deployment. | object | `{"affinity":{},"autoscaling":{"enable":false},"config":{"logging":{"level":"info"}},"configAnnotations":{},"extraVolumeMounts":[],"extraVolumes":[],"gatewayClassAnnotations":{},"gatewayClassName":"nginx","gatewayControllerName":"gateway.nginx.org/nginx-gateway-controller","gwAPIExperimentalFeatures":{"enable":false},"gwAPIInferenceExtension":{"enable":false,"endpointPicker":{"disableTLS":false,"skipVerify":true}},"image":{"pullPolicy":"Always","repository":"ghcr.io/nginx/nginx-gateway-fabric","tag":"edge"},"kind":"deployment","labels":{},"leaderElection":{"enable":true,"lockName":""},"lifecycle":{},"metrics":{"enable":true,"port":9113,"secure":false},"name":"","nodeSelector":{},"podAnnotations":{},"priorityClassName":"","productTelemetry":{"enable":true},"readinessProbe":{"enable":true,"initialDelaySeconds":3,"port":8081},"replicas":1,"resources":{},"service":{"annotations":{},"labels":{}},"serviceAccount":{"annotations":{},"imagePullSecret":"","imagePullSecrets":[],"name":""},"snippetsFilters":{"enable":false},"terminationGracePeriodSeconds":30,"tolerations":[],"topologySpreadConstraints":[]}` |
| `nginxGateway.affinity` | The affinity of the NGINX Gateway Fabric control plane pod. | object | `{}` |
| `nginxGateway.autoscaling` | Autoscaling configuration for the NGINX Gateway Fabric control plane. | object | `{"enable":false}` |
| `nginxGateway.autoscaling.enable` | Enable or disable Horizontal Pod Autoscaler for the control plane. | bool | `false` |
Expand Down Expand Up @@ -275,6 +275,7 @@ The following table lists the configurable parameters of the NGINX Gateway Fabri
| `nginxGateway.name` | The name of the NGINX Gateway Fabric deployment - if not present, then by default uses release name given during installation. | string | `""` |
| `nginxGateway.nodeSelector` | The nodeSelector of the NGINX Gateway Fabric control plane pod. | object | `{}` |
| `nginxGateway.podAnnotations` | Set of custom annotations for the NGINX Gateway Fabric pods. | object | `{}` |
| `nginxGateway.priorityClassName` | The priority class name for the NGINX Gateway Fabric control plane pod. | string | `""` |
| `nginxGateway.productTelemetry.enable` | Enable the collection of product telemetry. | bool | `true` |
| `nginxGateway.readinessProbe.enable` | Enable the /readyz endpoint on the control plane. | bool | `true` |
| `nginxGateway.readinessProbe.initialDelaySeconds` | The number of seconds after the Pod has started before the readiness probes are initiated. | int | `3` |
Expand Down
1 change: 1 addition & 0 deletions charts/nginx-gateway-fabric/templates/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ spec:
{{- with .Values.nginxGateway.extraVolumeMounts -}}
{{ toYaml . | nindent 8 }}
{{- end }}
priorityClassName: {{ .Values.nginxGateway.priorityClassName }}
{{- if .Values.nginxGateway.topologySpreadConstraints }}
topologySpreadConstraints:
{{- toYaml .Values.nginxGateway.topologySpreadConstraints | nindent 8 }}
Expand Down
7 changes: 7 additions & 0 deletions charts/nginx-gateway-fabric/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1019,6 +1019,13 @@
"title": "podAnnotations",
"type": "object"
},
"priorityClassName": {
"default": "",
"description": "The priority class name for the NGINX Gateway Fabric control plane pod.",
"required": [],
"title": "priorityClassName",
"type": "string"
},
"productTelemetry": {
"properties": {
"enable": {
Expand Down
3 changes: 3 additions & 0 deletions charts/nginx-gateway-fabric/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ nginxGateway:
# -- extraVolumeMounts are the additional volume mounts for the nginx-gateway container.
extraVolumeMounts: []

# -- The priority class name for the NGINX Gateway Fabric control plane pod.
priorityClassName: ""

# -- The termination grace period of the NGINX Gateway Fabric control plane pod.
terminationGracePeriodSeconds: 30

Expand Down
1 change: 1 addition & 0 deletions deploy/azure/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,7 @@ spec:
name: nginx-agent-tls
nodeSelector:
kubernetes.io/os: linux
priorityClassName: null
Copy link
Collaborator

@sjberman sjberman Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this deploy okay and be ignored by k8s?

Copy link
Author

@starlightromero starlightromero Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, this will not be okay. I can manually update it to an empty string (""). However, does the make command need to be updated as well?

Copy link
Collaborator

@sjberman sjberman Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could just make this field conditional in the template, so that it's only rendered if it's specified. That way by default it isn't rendered at all.

securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/default/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/experimental-nginx-plus/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/experimental/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/inference-nginx-plus/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/inference/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/nginx-plus/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/nodeport/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/openshift/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/snippets-filters-nginx-plus/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
1 change: 1 addition & 0 deletions deploy/snippets-filters/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ spec:
volumeMounts:
- mountPath: /var/run/secrets/ngf
name: nginx-agent-tls
priorityClassName: null
securityContext:
fsGroup: 1001
runAsNonRoot: true
Expand Down
Loading