Add topologySpreadConstraints configuration to pod spec.#2530

Open

laiminhtrung1997 wants to merge 15 commits intozalando:masterfrom

laiminhtrung1997:add-topologySpreadConstraints

Contributor

laiminhtrung1997 commented Feb 4, 2024 •

edited

Loading

Dear all,

I think we should configure topologySpreadConstraints to pod spec so these pods can spread zones for high availability.

Could someone review it, please? Thank you very much.

Best regards.

laiminhtrung1997 requested review from FxKu, Jan-M, hughcapet, idanovinda, jopadi, macedigital and sdudoladov as code owners

February 4, 2024 15:34

laiminhtrung1997 force-pushed the add-topologySpreadConstraints branch 2 times, most recently from b948c94 to 44fcb1f Compare

February 4, 2024 16:16

laiminhtrung1997 mentioned this pull request

Add topologySpreadConstraints configuration. #2474

Closed

FxKu added this to the 2.0 milestone

monotek commented May 16, 2024

We need that feature too.

FxKu modified the milestones: 2.0, 1.13.0

FxKu reviewed

View reviewed changes

pkg/cluster/cluster.go

               	}
+              	if !reflect.DeepEqual(c.Statefulset.Spec.Template.Spec.TopologySpreadConstraints, statefulSet.Spec.Template.Spec.TopologySpreadConstraints) {
+              		needsReplace = true
+              		needsRollUpdate = true

Member

FxKu Jun 26, 2024

does this really need to trigger a rolling update of pods executed by operator? Will not K8s take care of it then once the statefulset is replaced?

Contributor Author

laiminhtrung1997 Jul 5, 2024

I see, but is this wrong too?
https://github.com/zalando/postgres-operator/blob/master/pkg/cluster/cluster.go#L472

Member

FxKu Aug 27, 2024

hm good point. Maybe we can leave as is for now. With rolling update we make sure pods immediately adhere the new constraints.

FxKu reviewed

View reviewed changes

pkg/apis/acid.zalan.do/v1/postgresql_type.go Outdated

               	InitContainersOld       []v1.Container `json:"init_containers,omitempty"`
               	PodPriorityClassNameOld string         `json:"pod_priority_class_name,omitempty"`
+              	TopologySpreadConstraints []v1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`

Member

FxKu Jun 26, 2024

when introducing new fields to the api you have to update the CRDs, too. Unfortunately, we don't use a modern framework where this can be generated and you have to the manifests and in go code.

Plus, you need to run code generation -> ./hack/update-codegen.sh

Contributor Author

laiminhtrung1997 Jul 7, 2024

I updated.

FxKu reviewed

View reviewed changes

pkg/cluster/k8sres.go Outdated

               		false,
               		"",
               		false,
+              		[]v1.TopologySpreadConstraint{},

Member

FxKu Jun 26, 2024

atm we reuse configured tolerations also for logical backup so I guess we can do the same with constraints

Contributor Author

laiminhtrung1997 Jul 7, 2024

Ok I got it.

FxKu reviewed

View reviewed changes

pkg/cluster/k8sres.go Outdated

               	return podAntiAffinity
               }
+              func generateTopologySpreadConstraints(labels labels.Set, topologySpreadConstraintObjs []v1.TopologySpreadConstraint) []v1.TopologySpreadConstraint {

Member

FxKu Jun 26, 2024

would like to see a unit test for this function :)

Contributor Author

laiminhtrung1997 Jul 7, 2024

I added a unit test for this function.

Member

FxKu commented Jun 26, 2024

Can you also write an e2e test that tests that the constraints work as expected, please?

FxKu modified the milestones: 1.13.0, 1.14.0

Contributor Author

laiminhtrung1997 commented Jun 27, 2024

Can you also write an e2e test that tests that the constraints work as expected, please?

Dear @FxKu
Thanks so much for your comments, I haven't written the UT or e2e test many, but I'll try my best. I'll mark it ready and let you know when I fixed the comments.
Best regards.

laiminhtrung1997 force-pushed the add-topologySpreadConstraints branch 8 times, most recently from 530f847 to 18023cb Compare

July 7, 2024 06:56

laiminhtrung1997 requested a review from FxKu

October 19, 2025 08:02

Contributor Author

laiminhtrung1997 commented Oct 19, 2025

Can you please provide

an example in the complete manifest (somewhere here)

support in helm chart

add documentation behind this paragraph

Dear @FxKu
I completed the requests above. Please review it.

laiminhtrung1997 force-pushed the add-topologySpreadConstraints branch from fa6dadd to fb8fb84 Compare

December 16, 2025 09:06

laiminhtrung1997 requested a review from mikkeloscar as a code owner

December 16, 2025 09:06

zalando-robot commented Dec 16, 2025

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

laiminhtrung1997 force-pushed the add-topologySpreadConstraints branch from fb8fb84 to c6f58ef Compare

January 9, 2026 05:40

zalando-robot commented Jan 9, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

1 similar comment

zalando-robot commented Jan 18, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

laiminhtrung1997 force-pushed the add-topologySpreadConstraints branch from ebcd892 to 1312388 Compare

January 26, 2026 13:42

zalando-robot commented Jan 26, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

2 similar comments

zalando-robot commented Jan 26, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

zalando-robot commented Jan 30, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

laiminhtrung1997 added 14 commits

January 30, 2026 21:49


          Add topologySpreadConstraints configuration to pod spec.

6c261b5


          Modify the UT.

f80192f


          Correct the assert with the list of constraints.

b027edf


          Fix UT

3d4b776


          Run update-codegen.sh to add deepcopy for new field to the api.

c328ee6


          Reuse configured TopologySpreadConstraints for logical backup.


          Remove x-kubernetes-preserve-unknown-fields and XPreserveUnknownFields.

25c3609


          Remove unnecessary len check.

61cb7e0


          Add topologySpreadConstraint example in the complete manifest.

75d082a


          Add support for helm chart.

43ab112


          Add documentation for topologySpreadConstraint.


          Update e2e test to patch topologySpreadConstraints into the postgresq…

73fb174

…ls manifest.


          Revert unnecessary change.

01b4b5e


          Updated the PVC retention policy to remove redundant PVCs.

b824a6f

laiminhtrung1997 force-pushed the add-topologySpreadConstraints branch from bb47325 to b824a6f Compare

January 30, 2026 14:49

zalando-robot commented Jan 30, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.


          Fix expected PVC count in end-to-end test after config changes.

f40c68b

zalando-robot commented Feb 1, 2026

Cannot start a pipeline due to:

No accountable user for this pipeline: no Zalando employee associated to this GitHub username

Click on pipeline status check Details link below for more information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

sdudoladov Awaiting requested review from sdudoladov sdudoladov is a code owner

Jan-M Awaiting requested review from Jan-M Jan-M is a code owner

jopadi Awaiting requested review from jopadi jopadi is a code owner

idanovinda Awaiting requested review from idanovinda idanovinda is a code owner

hughcapet Awaiting requested review from hughcapet hughcapet is a code owner

macedigital Awaiting requested review from macedigital

FxKu Awaiting requested review from FxKu FxKu is a code owner

mikkeloscar Awaiting requested review from mikkeloscar mikkeloscar is a code owner

Labels