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

[Gateway API 1.2.0] Add gateway name label #4333

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

zhaohuabing
Copy link
Member

@zhaohuabing zhaohuabing commented Sep 25, 2024

Implement the Gateway name label pfart of GEP-1762: In Cluster Gateway Deployments

MUST label all generated resources (Service, Deployment, etc) with gateway.networking.k8s.io/gateway-name: my-gateway (where my-gateway is the name of the Gateway resource).

This PR only covers the gateway name label requirement in the GEP-1762.

Caveat: GEP-1762 doesn't define how to handle the label for merged Gateways. Currently, all gateway names are concatenated and stored in a single label if mergeGateways is enabled. This is tracked in kubernetes-sigs/gateway-api#3365.

Implement: #4330

Signed-off-by: Huabing Zhao <[email protected]>
@zhaohuabing zhaohuabing requested a review from a team as a code owner September 25, 2024 13:45
Signed-off-by: Huabing Zhao <[email protected]>
@zhaohuabing zhaohuabing marked this pull request as draft September 25, 2024 13:48
Copy link

codecov bot commented Sep 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.98%. Comparing base (14830c7) to head (f9a6381).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4333      +/-   ##
==========================================
+ Coverage   65.96%   65.98%   +0.01%     
==========================================
  Files         197      197              
  Lines       23959    23971      +12     
==========================================
+ Hits        15805    15817      +12     
  Misses       7027     7027              
  Partials     1127     1127              

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

@@ -87,6 +87,7 @@ infraIR:
labels:
gateway.envoyproxy.io/owning-gateway-name: eg
gateway.envoyproxy.io/owning-gateway-namespace: envoy-gateway-system
gateway.networking.k8s.io/gateway-name: eg
Copy link
Contributor

Choose a reason for hiding this comment

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

EG differs from the GEP in two ways

  • label name gateway.envoyproxy.io/owning-gateway-name
  • generated resource is in the same ns as the Gateway

this warrants a bigger discussion, lets bring this up in the community meeting next week

Copy link
Member Author

@zhaohuabing zhaohuabing Sep 26, 2024

Choose a reason for hiding this comment

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

This PR only adds the required label gateway.envoyproxy.io/owning-gateway-name. It's compatible with the current EG implementation.

The existing gateway.envoyproxy.io/owning-gateway-name is reserved for compatibility reasons. This label has been used as a selector to filter out services and deployments related to a Gateway.

@@ -216,6 +216,7 @@ infraIR:
metadata:
labels:
gateway.envoyproxy.io/owning-gatewayclass: envoy-gateway-class
gateway.networking.k8s.io/gateway-name: gateway-1,gateway-2
Copy link
Member Author

@zhaohuabing zhaohuabing Sep 26, 2024

Choose a reason for hiding this comment

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

All gateway names are concatenated and stored in a single label if mergeGateways is enabled.
Probably not the best way to do this, should revisit this and come up with a better solution upstream.

This is tracked in kubernetes-sigs/gateway-api#3365

@zhaohuabing zhaohuabing marked this pull request as ready for review September 27, 2024 03:46
Signed-off-by: Huabing Zhao <[email protected]>
Signed-off-by: Huabing Zhao <[email protected]>
@arkodg
Copy link
Contributor

arkodg commented Sep 27, 2024

Apart from passing the conformance test, how does the end user benefit from this change ?

@zhaohuabing
Copy link
Member Author

Apart from passing the conformance test, how does the end user benefit from this change ?

No, but we could replace the existing gateway.envoyproxy.io/owning-gateway-name with this one in the next release.

@arkodg
Copy link
Contributor

arkodg commented Sep 27, 2024

I suggest waiting until kubernetes-sigs/gateway-api#3366 is resolved which in indirectly related to the name of the label

@zhaohuabing zhaohuabing marked this pull request as draft September 27, 2024 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants