feat: add PriorityClassName to pod kube_types #12949

peninoule · 2025-11-21T15:27:07Z

Description

This PR adds support for the PriorityClassName attribute for the gateway proxy pods.

Right now pods are created with the default PriotityClass. It can be an issue in environments with very volatile workloads (like AWS spots instances) where teams rely on the PriorityClassName to ensure critical pieces of the cluster remain active.
With the default PriorityClass, gateway proxy pods are under threat of preemption.

Change Type

/kind feature

Changelog

Adds `priorityClassName` to the Pod struct used in GatewayParameters in order to set the corresponding [priorityClassName](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass) field in the gateway-proxy pod.

Additional Notes

closes: #11917

Copilot

Pull request overview

This PR adds support for the PriorityClassName field to gateway proxy pods to prevent pod preemption in environments with volatile workloads. The implementation follows the established pattern for adding Pod template configuration fields.

Key changes:

Added PriorityClassName *string field to the Pod struct with getter method
Updated merge logic, deployer values, and Helm templates to propagate the field
Added CRD schema definition and test coverage

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
api/v1alpha1/kube_types.go	Adds PriorityClassName field and GetPriorityClassName() method to Pod struct
pkg/deployer/values.go	Adds PriorityClassName field to HelmGateway struct
pkg/deployer/merge.go	Adds merge logic for PriorityClassName using MergePointers helper
internal/kgateway/deployer/gateway_parameters.go	Propagates PriorityClassName value from PodTemplate to gateway configuration
internal/kgateway/helm/envoy/templates/deployment.yaml	Adds conditional rendering of priorityClassName in deployment spec
install/helm/kgateway-crds/templates/gateway.kgateway.dev_gatewayparameters.yaml	Adds priorityClassName to CRD schema
pkg/deployer/deployer_test.go	Adds test data and assertion for PriorityClassName field

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

api/v1alpha1/kube_types.go

pkg/deployer/deployer_test.go

chandler-solo · 2025-11-25T14:53:05Z

internal/kgateway/helm/envoy/templates/deployment.yaml

        {{- toYaml . | nindent 8 }}
      {{- end }}
+      {{- if $gateway.priorityClassName }}
+      priorityClassName: {{ $gateway.priorityClassName }}


Let's protect against a user who names a PriorityClass a YAML reserved word with priorityClassName: {{ $gateway.priorityClassName | quote }}

Added in : 9d38407

chandler-solo · 2025-11-25T14:56:36Z

pkg/deployer/deployer_test.go

 							},
 						},
 						PodTemplate: &gw2_v1alpha1.Pod{
+							PriorityClassName: ptr.To("default"),


The only default PCs are system-cluster-critical and system-node-critical. The default PC is really to omit the PC, so why add this? (If someone uses globalDefault in a PC, then presumably they would not use the setting you're adding in this PR.)

Instead, chandler-solo@112764e tests this as end-to-end as is necessary. Please cherry pick it.

Cherry-picked 👍 Thank you for that 🙇‍♂️

chandler-solo · 2025-11-25T15:02:58Z

pkg/deployer/merge.go

 	dst.LivenessProbe = deepMergeProbe(dst.GetLivenessProbe(), src.GetLivenessProbe())
 	dst.TopologySpreadConstraints = DeepMergeSlices(dst.GetTopologySpreadConstraints(), src.GetTopologySpreadConstraints())
 	dst.ExtraVolumes = DeepMergeSlices(dst.GetExtraVolumes(), src.GetExtraVolumes())
+	dst.PriorityClassName = MergePointers(dst.PriorityClassName, src.PriorityClassName)


Elsewhere we use MergeComparable for some (all?) *string, but that's semantically nonsensical and MergePointers is correct. (I put up #12978 to clean this up.)

I leave it as it is then 👍

chandler-solo

We'll need a maintainer to get CI checks running and approve.

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

Signed-off-by: David L. Chandler <[email protected]>

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

peninoule · 2025-12-01T13:58:34Z

We'll need a maintainer to get CI checks running and approve.

Sorry I disappeared. Tests should succeed now

moi34500 · 2025-12-01T22:16:17Z

Let’s goooooo

peninoule · 2025-12-02T08:08:14Z

Thanks for the help, the review and the merge ! Cheers.

Signed-off-by: Pierre-Jean CROUZET <[email protected]> Signed-off-by: David L. Chandler <[email protected]> Co-authored-by: David L. Chandler <[email protected]>

gateway-bot added do-not-merge/description-invalid do-not-merge/kind-invalid Indicates a PR lacks a `kind/foo` label and requires one. do-not-merge/release-note-invalid Indicates that a PR should not merge because it's missing one of the release note labels. labels Nov 21, 2025

peninoule force-pushed the feat/add-priority-class-name branch from 6301746 to 7dc3005 Compare November 21, 2025 15:28

puertomontt requested a review from chandler-solo November 24, 2025 02:26

peninoule force-pushed the feat/add-priority-class-name branch from 7dc3005 to 89b5dcf Compare November 24, 2025 08:54

peninoule marked this pull request as ready for review November 24, 2025 08:55

Copilot AI review requested due to automatic review settings November 24, 2025 08:55

Copilot started reviewing on behalf of peninoule November 24, 2025 08:55 View session

Copilot finished reviewing on behalf of peninoule November 24, 2025 08:58

peninoule mentioned this pull request Nov 24, 2025

Add PriorityClassName to the gateway parameters #12961

Closed

Copilot AI reviewed Nov 24, 2025

View reviewed changes

api/v1alpha1/kube_types.go Outdated Show resolved Hide resolved

pkg/deployer/deployer_test.go Outdated Show resolved Hide resolved

peninoule marked this pull request as draft November 24, 2025 09:51

peninoule marked this pull request as ready for review November 24, 2025 10:27

peninoule force-pushed the feat/add-priority-class-name branch from 3378092 to 8ad63fc Compare November 24, 2025 15:52

chandler-solo requested changes Nov 25, 2025

View reviewed changes

peninoule force-pushed the feat/add-priority-class-name branch 2 times, most recently from 9d38407 to 1592b47 Compare November 26, 2025 09:29

chandler-solo approved these changes Nov 26, 2025

View reviewed changes

timflannagan approved these changes Nov 26, 2025

View reviewed changes

peninoule and others added 5 commits December 1, 2025 14:03

feat: add PriorityClassName to pod kube_types

ff3e642

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

fix: fix typo

21c9aad

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

fix: fix deployer tests

1907236

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

chore: add generated code

239b9eb

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

test case proving that priorityClassName goes through to the pod

8f3741c

Signed-off-by: David L. Chandler <[email protected]>

peninoule added 3 commits December 1, 2025 14:03

remove uneeded

f0a5a28

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

fix(helm): quote PC value

87b940b

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

tests: fix golden file

8b9d561

Signed-off-by: Pierre-Jean CROUZET <[email protected]>

peninoule force-pushed the feat/add-priority-class-name branch from 1592b47 to 8b9d561 Compare December 1, 2025 13:53

chandler-solo approved these changes Dec 1, 2025

View reviewed changes

timflannagan approved these changes Dec 1, 2025

View reviewed changes

lgadban added this pull request to the merge queue Dec 1, 2025

Merged via the queue into kgateway-dev:main with commit 2034334 Dec 1, 2025
30 checks passed

peninoule deleted the feat/add-priority-class-name branch December 2, 2025 08:08

feat: add PriorityClassName to pod kube_types #12949

feat: add PriorityClassName to pod kube_types #12949

Uh oh!

Conversation

peninoule commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Change Type

Changelog

Additional Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

chandler-solo Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

peninoule Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

chandler-solo Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

peninoule Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

chandler-solo Nov 25, 2025

Choose a reason for hiding this comment

Uh oh!

peninoule Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

chandler-solo left a comment

Choose a reason for hiding this comment

Uh oh!

peninoule commented Dec 1, 2025

Uh oh!

Uh oh!

moi34500 commented Dec 1, 2025

Uh oh!

peninoule commented Dec 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

peninoule commented Nov 21, 2025 •

edited

Loading