Topology Spread Constraints Bugfix #1131
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PCI review checklist
I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.
This PR aims to fix a broken loop in the topology spread constraints helper
vso.topologySpreadConstraintsin the Helm chart templates.Summary
While defining one constraint worked just fine (with or without labels—those were correctly added when missing), defining more than one was causing invalid YAML to be rendered and the following error to be displayed:
For reference, the offending values were:
Root Cause
Digging into it, I noticed that because of the aggressive whitespace trimming (
{{- ... -}}) combined with emitting each item separately, the rendered list items were concatenated without a newline between them. With two constraints, I was seeing something like this:This happens because the
vso.topologySpreadConstraintshelper emits each constraint as a single‑element YAML list and uses whitespace‑trimming ({{- ... -}}). The consecutivetoYamloutputs get concatenated without a newline, so the next-starts immediately after the previous line’s text (e.g.,maxSkew: 1- labelSelector:), producing invalid YAML.This refactor avoids the above problem and fixes the whitespace trap.
Testing
I have tested this in my own cluster (Kubernetes v1.32) and confirmed that all of the following values configs are successfully rendered: