Skip to content

feat(gateway-api): add ability to override target on *Route resources #5319

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat(gateway-api): add ability to override target on *Route resources #5319

wants to merge 4 commits into from

Conversation

davidspek
Copy link
Contributor

Description

This PR adds the ability to use the external-dns.alpha.kubernetes.io/target annotation on *Route (like HTTPRoute) resources to override the target coming from the Gateway. A special case is included where if the gateway also includes the external-dns.alpha.kubernetes.io/target annotation and the *Route has the external-dns.alpha.kubernetes.io/target set to "" the target annotation from the Gateway isn't used and the normal flow gathering the listener address from the gateway is used.

Fixes #4779

Checklist

  • Unit tests updated
  • End user documentation updated

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign raffo for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 23, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @davidspek. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 23, 2025
mloiseleur
mloiseleur reviewed Apr 23, 2025
View reviewed changes
docs/sources/gateway.md Outdated
Comment on lines 109 to 114
1. If a matching parent Gateway has the `external-dns.alpha.kubernetes.io/target` annotation, uses
the values from that unless the route has the `external-dns.alpha.kubernetes.io/target: ""` annotation in which case it iterates over that parent Gateway's `status.addresses` adding each address's `value`.

2. Otherwise, iterates over that parent Gateway's `status.addresses`,
2. If the route has the route has the `external-dns.alpha.kubernetes.io/target` annotation with a non-empty value, uses the value from that.

3. Otherwise, iterates over that parent Gateway's `status.addresses`,
Copy link
Collaborator

Choose a reason for hiding this comment

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

If target annotation apply first, would you please re-order it ?
It should simplify the wording

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion. I've updated the docs.

@mloiseleur
Copy link
Collaborator

/ok-to-test
/assign @abursavich for a first review

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 23, 2025
mloiseleur
mloiseleur reviewed Apr 23, 2025
View reviewed changes
mloiseleur
mloiseleur reviewed Apr 23, 2025
View reviewed changes
davidspek and others added 2 commits April 23, 2025 18:03
@davidspek @mloiseleur
docs: correct regactor error
fd8ee5d 
Co-authored-by: Michel Loiseleur <[email protected]>
@davidspek @mloiseleur
docs: correct regactor error
81aaf28 
Co-authored-by: Michel Loiseleur <[email protected]>
@davidspek
Copy link
Contributor Author

/retest

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

@mloiseleur mloiseleur mloiseleur left review comments

@szuecs szuecs Awaiting requested review from szuecs

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

external-dns.alpha.kubernetes.io/target in HTTPRoute to override Gateway target
3 participants
@davidspek @k8s-ci-robot @mloiseleur