Skip to content
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

Fix example in values file for topologySpreadConstraint #4663

Merged
merged 1 commit into from
Feb 7, 2022
Merged

Fix example in values file for topologySpreadConstraint #4663

merged 1 commit into from
Feb 7, 2022

Conversation

dschunack
Copy link
Contributor

Which component this PR applies to?

This PR applies to the helm chart. It modifies the example how to use the topologySpreadConstraints in the helm chart.
Noticed today that the terraform helm provider doesn't accept the code for topologySpreadConstraint if it start with "- labelSelector"

topologySpreadConstraints:
  - labelSelector:
       matchLabels:
         app.kubernetes.io/name: aws-cluster-autoscaler
    maxSkew: 1
    topologyKey: topology.kubernetes.io/zone
    whenUnsatisfiable: DoNotSchedule

It end's with the following error.

Error: error validating "": error validating data: ValidationError(Deployment.spec.template.spec.topologySpreadConstraints[0]): unknown field "matchLabels" in io.k8s.api.core.v1.TopologySpreadConstraint

To prevent issues with that, I changed the example Code and It work with helm and also with the terraform helm provider.

topologySpreadConstraints:
  - maxSkew: 1
    topologyKey: topology.kubernetes.io/zone
    whenUnsatisfiable: DoNotSchedule
    labelSelector:
      matchLabels:
        app.kubernetes.io/instance: cluster-autoscaler

The funny things is, if you check the deployment in k8s the yaml code for the topologySpreadConstraints start with "- labelSelector:". Maybe this is a bug in helm , but it's better to change the example to prevent an issue as to ignore it.

I'm so sorry for the new PR after the release today. If you think, it's not necessary to correct it, feel free to close the PR without merging.

What type of PR is this?
/kind feature

What this PR does / why we need it:
The example in the values.yaml for topologySpreadConstraints is not accepted by helm and could cause errors.

Which issue(s) this PR fixes:
Fixes #4577

Special notes for your reviewer:
Does this PR introduce a user-facing change?
NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Example in the values.yaml changed.

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 3, 2022
@dschunack
Copy link
Contributor Author

/assign @gjtempleton

Copy link
Contributor

@mwielgus mwielgus left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 7, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dschunack, mwielgus

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 7, 2022
@k8s-ci-robot k8s-ci-robot merged commit 0ed41c5 into kubernetes:master Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add topology spread constraints to control how Pods are spread
4 participants