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: rateLimitDeployment ignoring pod labels and annotation merge #4228

Merged
merged 19 commits into from
Oct 1, 2024

Conversation

oscarboher
Copy link
Contributor

What type of PR is this?
fix
What this PR does / why we need it:
rateLimitDeployment.pod.labels where not applying to rate limit pods.
prometheus annotations where ignored if rateLimitDeployment.pod.annotations was defined

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

@oscarboher oscarboher closed this Sep 12, 2024
Signed-off-by: Oscar Boher <[email protected]>
@oscarboher oscarboher reopened this Sep 12, 2024
@oscarboher oscarboher marked this pull request as ready for review September 18, 2024 09:41
@oscarboher oscarboher requested a review from a team as a code owner September 18, 2024 09:41
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 85.71429% with 2 lines in your changes missing coverage. Please review.

Project coverage is 65.69%. Comparing base (4b8c2f5) to head (1eb1c07).
Report is 56 commits behind head on main.

Files with missing lines Patch % Lines
...tructure/kubernetes/ratelimit/resource_provider.go 85.71% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4228   +/-   ##
=======================================
  Coverage   65.69%   65.69%           
=======================================
  Files         200      200           
  Lines       24095    24101    +6     
=======================================
+ Hits        15829    15833    +4     
- Misses       7134     7135    +1     
- Partials     1132     1133    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

podLabels := rateLimitLabels()
if r.rateLimitDeployment.Pod.Labels != nil {
maps.Copy(podLabels, r.rateLimitDeployment.Pod.Labels)
maps.Copy(podLabels, rateLimitLabels())
Copy link
Contributor

Choose a reason for hiding this comment

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

can L195 be removed ? since L192 is already setting it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So maps.Copy(dest, src) overwrites keys existing in both maps with the src value. I want to make sure noone can override one of the selector labels from the rateLimitLabels, so I'm doing the last maps.Copy to overwrite with the selector labels in case someone added one of those labels in their values.

Also the destination map must not be nil so I cannot do something like:

podLabels := r.rateLimitDeployment.Pod.Labels
maps.Copy(podLabels, rateLimitLabels())

as it will fail if no pod labels are provided.
It looks a bit funny, I just didn't want to implement a function that merges two maps, but maybe it's worth it for clarity's sake. Let me know if you think so.

Copy link
Contributor

Choose a reason for hiding this comment

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

ah thats a good way to ensure the labels can't be overridden
nit: this as a code comment would be helpful so the next dev gets the "why"

arkodg
arkodg previously approved these changes Sep 25, 2024
Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM thanks !

@arkodg arkodg requested review from a team September 25, 2024 20:57
Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM thanks !

@arkodg arkodg requested review from a team October 1, 2024 00:08
@zirain zirain changed the title fix: fix rateLimitDeployment ignoring pod labels and annotation merge fix: rateLimitDeployment ignoring pod labels and annotation merge Oct 1, 2024
@zirain zirain merged commit cf84927 into envoyproxy:main Oct 1, 2024
23 of 24 checks passed
guydc pushed a commit to guydc/gateway that referenced this pull request Oct 30, 2024
…voyproxy#4228)

* fix labels and annotation merges for rate limit deployment

Signed-off-by: Oscar Boher <[email protected]>

* fix tests and label merge

Signed-off-by: Oscar Boher <[email protected]>

* fix annotation merge if prometheus was disabled and annotations were defined

Signed-off-by: Oscar Boher <[email protected]>

* renamed labels and annotations to specify they apply to pods only

Signed-off-by: Oscar Boher <[email protected]>

* linter

Signed-off-by: Oscar Boher <[email protected]>

* fix resource provider tests to new annotation behavior

Signed-off-by: Oscar Boher <[email protected]>

* go linter

Signed-off-by: Oscar Boher <[email protected]>

* fix gen-check

Signed-off-by: Oscar Boher <[email protected]>

* pod labels selector comment

Signed-off-by: Oscar Boher <[email protected]>

---------

Signed-off-by: Oscar Boher <[email protected]>
Co-authored-by: zirain <[email protected]>
Co-authored-by: Arko Dasgupta <[email protected]>
(cherry picked from commit cf84927)
Signed-off-by: Guy Daich <[email protected]>
guydc added a commit that referenced this pull request Oct 31, 2024
* build(deps): bump github.com/docker/docker from 27.2.0+incompatible to 27.3.1+incompatible (#4303)

build(deps): bump github.com/docker/docker

Bumps [github.com/docker/docker](https://github.com/docker/docker) from 27.2.0+incompatible to 27.3.1+incompatible.
- [Release notes](https://github.com/docker/docker/releases)
- [Commits](moby/moby@v27.2.0...v27.3.1)

---
updated-dependencies:
- dependency-name: github.com/docker/docker
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Huabing Zhao <[email protected]>
(cherry picked from commit cd4e9b1)
Signed-off-by: Guy Daich <[email protected]>

* bugfix: EG loglevel error for admin and metrics module (#4340)

* bugfix: EG loglevel error for admin and metrics module

Signed-off-by: qicz <[email protected]>

* fix ut

Signed-off-by: qicz <[email protected]>

* polish

Signed-off-by: qicz <[email protected]>

---------

Signed-off-by: qicz <[email protected]>
(cherry picked from commit 9b161ee)
Signed-off-by: Guy Daich <[email protected]>

* fix: some status updates are discarded by the status updater (#4337)

Signed-off-by: Huabing Zhao <[email protected]>
(cherry picked from commit 14830c7)
Signed-off-by: Guy Daich <[email protected]>

* fix: Unsupported listener protocol type error for nil supportKinds assign gateway status. (#4345)

(cherry picked from commit 7babca9)
Signed-off-by: Guy Daich <[email protected]>

* set invalid Listener.SupportedKinds to empty list (#4352)

* set invalid Listener.SupportedKinds to empty list

Fixes: #4216

Relates to https://kubernetes.slack.com/archives/CR0H13KGA/p1727457195236889

Signed-off-by: Arko Dasgupta <[email protected]>

* lint

Signed-off-by: Arko Dasgupta <[email protected]>

---------

Signed-off-by: Arko Dasgupta <[email protected]>
(cherry picked from commit 2fdf069)
Signed-off-by: Guy Daich <[email protected]>

* bugfix: ignore some unnecessary requests to apiserver. (#4362)

Signed-off-by: qicz <[email protected]>
Co-authored-by: zirain <[email protected]>
(cherry picked from commit fe1e8bd)
Signed-off-by: Guy Daich <[email protected]>

* fix: rateLimitDeployment ignoring pod labels and annotation merge (#4228)

* fix labels and annotation merges for rate limit deployment

Signed-off-by: Oscar Boher <[email protected]>

* fix tests and label merge

Signed-off-by: Oscar Boher <[email protected]>

* fix annotation merge if prometheus was disabled and annotations were defined

Signed-off-by: Oscar Boher <[email protected]>

* renamed labels and annotations to specify they apply to pods only

Signed-off-by: Oscar Boher <[email protected]>

* linter

Signed-off-by: Oscar Boher <[email protected]>

* fix resource provider tests to new annotation behavior

Signed-off-by: Oscar Boher <[email protected]>

* go linter

Signed-off-by: Oscar Boher <[email protected]>

* fix gen-check

Signed-off-by: Oscar Boher <[email protected]>

* pod labels selector comment

Signed-off-by: Oscar Boher <[email protected]>

---------

Signed-off-by: Oscar Boher <[email protected]>
Co-authored-by: zirain <[email protected]>
Co-authored-by: Arko Dasgupta <[email protected]>
(cherry picked from commit cf84927)
Signed-off-by: Guy Daich <[email protected]>

* fix dashboard typos (#4422)

Signed-off-by: haorenfsa <[email protected]>
Signed-off-by: Guy Daich <[email protected]>

* fix: ratelimit not working with both headers and cidr matches  (#4377)

* fix ratelimit descriptors do not respect both headers and cidr match for one rule

Signed-off-by: shawnh2 <[email protected]>

* fix gen-check and lint

Signed-off-by: shawnh2 <[email protected]>

* fix ratelimit e2e test

Signed-off-by: shawnh2 <[email protected]>

* add more comment and update test case

Signed-off-by: shawnh2 <[email protected]>

---------

Signed-off-by: shawnh2 <[email protected]>
Co-authored-by: Huabing Zhao <[email protected]>
(cherry picked from commit 66c0b51)
Signed-off-by: Guy Daich <[email protected]>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Guy Daich <[email protected]>
Signed-off-by: qicz <[email protected]>
Signed-off-by: Huabing Zhao <[email protected]>
Signed-off-by: Arko Dasgupta <[email protected]>
Signed-off-by: Oscar Boher <[email protected]>
Signed-off-by: haorenfsa <[email protected]>
Signed-off-by: shawnh2 <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Huabing Zhao <[email protected]>
Co-authored-by: qi <[email protected]>
Co-authored-by: Arko Dasgupta <[email protected]>
Co-authored-by: zirain <[email protected]>
Co-authored-by: Oscar Boher <[email protected]>
Co-authored-by: shaoyue <[email protected]>
Co-authored-by: sh2 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EnvoyGateway rateLimitDeployment ignores pod labels
4 participants