feat(source): gateway api hostname source annotation by bogdankrasko · Pull Request #5959 · kubernetes-sigs/external-dns

bogdankrasko · 2025-11-14T13:06:55Z

What does it do ?

Adds external-dns.alpha.kubernetes.io/gateway-hostname-source annotation to the GatewayAPI source.

Motivation

Fixes #5391

More

Yes, this PR title follows Conventional Commits
Yes, I added unit tests
Yes, I updated end user documentation accordingly

linux-foundation-easycla · 2025-11-14T13:07:03Z

The committers listed above are authorized under a signed CLA.

✅ login: bogdankrasko / name: bkrasko (477f480, 73df5d0, 7825cf1, ebeb384)
✅ login: bogdankrasko / name: bogdankrasko (0379521)

k8s-ci-robot · 2025-11-14T13:07:04Z

Welcome @bogdankrasko!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2025-11-14T13:07:05Z

Hi @bogdankrasko. Thanks for your PR.

I'm waiting for a github.com 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.

Details

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.

bogdankrasko · 2025-11-14T13:14:06Z

Smoke tests

Setup

args:
--log-level=info \
--log-format=text \
--interval=1m \
--source=service \
--source=ingress \
--source=gateway-httproute \
--source=gateway-grpcroute \
--source=gateway-tlsroute \
--source=gateway-tcproute \
--source=gateway-udproute \
--policy=upsert-only \
--registry=txt \
--txt-owner-id=check-external-dns \
--provider=aws \
--zone-id-filter=/hostedzone/Z00103822***** \
--domain-filter=external-dns-check.engineering

manifest:

apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
  name: check-external-dns
  namespace: check
  annotations:
    external-dns.alpha.kubernetes.io/gateway-hostname-source: annotation-only
    external-dns.alpha.kubernetes.io/hostname:  >-
      api.us-west-2.external-dns-check.engineering
spec:
  hostnames:
    - api.external-dns-check.engineering
    - api.us-west-2.external-dns-check.engineering
  parentRefs:
    - group: gateway.networking.k8s.io
      kind: Gateway
      name: external-dns-check
      namespace: kube-system
  rules:
    - backendRefs:
        - group: ''
          kind: Service
          name: check-service
          port: 8080

Master

INFO[0000] Instantiating new Kubernetes client          
INFO[0000] Using kubeConfig                             
INFO[0000] Created Kubernetes client https://*****.gr7.us-west-2.eks.amazonaws.com 
INFO[0002] Using kubeConfig                             
INFO[0002] Created GatewayAPI client https://*****.gr7.us-west-2.eks.amazonaws.com 
INFO[0006] Applying provider record filter for domains: [external-dns-check.engineering. .external-dns-check.engineering.] 
INFO[0006] All records are already up to date           
INFO[0066] Applying provider record filter for domains: [external-dns-check.engineering. .external-dns-check.engineering.] 
INFO[0067] Desired change: CREATE aaaa-api.us-west-2.external-dns-check.engineering TXT  profile=default zoneID=/hostedzone/Z00103822***** zoneName=external-dns-check.engineering.
INFO[0067] Desired change: CREATE api.us-west-2.external-dns-check.engineering A  profile=default zoneID=/hostedzone/Z00103822***** zoneName=external-dns-check.engineering.
INFO[0067] Desired change: CREATE api.us-west-2.external-dns-check.engineering AAAA  profile=default zoneID=/hostedzone/Z00103822***** zoneName=external-dns-check.engineering.
INFO[0067] Desired change: CREATE cname-api.us-west-2.external-dns-check.engineering TXT  profile=default zoneID=/hostedzone/Z00103822***** zoneName=external-dns-check.engineering.
INFO[0067] 4 record(s) were successfully updated         profile=default zoneID=/hostedzone/Z00103822***** zoneName=external-dns-check.engineering.
INFO[0126] Applying provider record filter for domains: [external-dns-check.engineering. .external-dns-check.engineering.] 
INFO[0126] All records are already up to date

mloiseleur · 2025-11-15T16:46:12Z

/ok-to-test

coveralls · 2025-11-15T16:51:26Z

Pull Request Test Coverage Report for Build 19441565668

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
101 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.04%) to 78.665%

Files with Coverage Reduction	New Missed Lines	%
gloo_proxy.go	47	74.18%
gateway.go	54	85.93%

Totals
Change from base Build 19361247212:	-0.04%
Covered Lines:	15973
Relevant Lines:	20305

💛 - Coveralls

docs/annotations/annotations.md

vflaux · 2025-11-16T03:47:39Z

source/gateway.go

+	if strings.ToLower(hostNameAnnotation) == gatewayHostnameSourceAnnotationOnlyValue {
+		return annotationHostnames, nil
+	}
+
 	return hostnames, nil


You're not checking for gatewayHostnameSourceDefinedHostsOnlyValue, so any invalid value will return only the defined hostnames.
In this case, the ingress implementation returns an empty list.
It might be worth logging a warning too.

You also build hostnames from both sources and eventually discard them.
Wouldn’t it be better to only add hostnames when they’re actually needed?

Updated logic

vflaux · 2025-11-16T03:49:03Z

source/gateway_httproute_test.go

+			endpoints: []*endpoint.Endpoint{
+				newTestEndpoint("test.org.internal", "A", "1.2.3.4"),
+			},
+		},


Could you add a test case with an invalid annotation value?

Added a test case with an invalid annotation value

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

ivankatliarchuk · 2025-12-02T08:18:25Z

/lgtm

mloiseleur · 2025-12-07T13:21:39Z

@vflaux Anything left on your side ?

szuecs · 2025-12-09T15:34:13Z

/hold likely we will not integrate HTTPRoute in the future , but ListenerSet as told by gateway-api. We should wait until they finalized the API and what external-dns should do to integrate.

mloiseleur · 2025-12-09T16:23:37Z

Even if we will follow GatewayAPI and move to ListenerSet, it does not mean we should not consider some use cases with current resources.

=> as discussed on slack with other maintainers
/unhold

bogdankrasko · 2025-12-11T07:54:36Z

As external-dns supports HTTPRoute, GRPCRoute, ... I would expect that the functionality related to hostname annotation is supported as well.

bogdankrasko · 2025-12-22T08:49:52Z

@szuecs @mloiseleur @ivankatliarchuk Can we proceed on merging the following changes?

mloiseleur · 2025-12-27T16:06:02Z

@szuecs @ivankatliarchuk Anything left on your side?

ivankatliarchuk · 2025-12-27T16:35:27Z

LGTM

ivankatliarchuk · 2026-01-11T17:54:39Z

If anything, we could always rollback.

/approve

k8s-ci-robot · 2026-01-11T17:54:46Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [ivankatliarchuk]

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

* master: (25 commits) feat(event): standardize event messages and add resource kind lookup for events (kubernetes-sigs#6101) refactor(informers): unify cache sync functions using generics (kubernetes-sigs#6102) fix(fqdn): support kind and api version (kubernetes-sigs#6097) test(fqdn): cover sources without any fqdn tests (kubernetes-sigs#6094) chore(tools): CRD generation script moved and add validation workflow (kubernetes-sigs#6079) fix(metrics): add CNAME to known record types (kubernetes-sigs#6115) chore(cloudflare): migrate customhostname to v5 (kubernetes-sigs#5891) test(provider/exoscale): improved the test coverage for exoscale provider from 62.8% to 80.4% (kubernetes-sigs#6112) feat(source): gateway api hostname source annotation (kubernetes-sigs#5959) test: cover pkg/events/fake package (kubernetes-sigs#6096) refactor(controller): controller no longer responsible for SingletonClientGenerator creation (kubernetes-sigs#6077) refactor(source): standardize FQDN template accross sources (kubernetes-sigs#6093) feat(coredns): rename ownerId and ownedBy to owner (kubernetes-sigs#6032) docs: fix typo in README (The are → There are) (kubernetes-sigs#6095) refactor(aws): abstract provider-specific boolean parsing (kubernetes-sigs#6078) refactor(api): deduplicate addKnownTypes (kubernetes-sigs#6087) fix(api): rollback changes for omitempty (kubernetes-sigs#6086) chore(deps): bump renovatebot/github-action (kubernetes-sigs#6080) fix(aws): enable AWS API validation for routing policies without setIdentifier (kubernetes-sigs#6082) chore(aws): document and test behavior for ALB and NLB (kubernetes-sigs#6063) ...

feat: Add gateway api source annotation

73df5d0

k8s-ci-robot added the docs label Nov 14, 2025

k8s-ci-robot requested a review from mloiseleur November 14, 2025 13:07

k8s-ci-robot requested a review from szuecs November 14, 2025 13:07

k8s-ci-robot added the source label Nov 14, 2025

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 14, 2025

bogdankrasko mentioned this pull request Nov 14, 2025

feat(source): add gateway api hostname source annotation #5487

Closed

3 tasks

fix: Fix unit tests

477f480

mloiseleur changed the title ~~feat(source): Add gateway api hostname source annotation~~ feat(source): gateway api hostname source annotation Nov 15, 2025

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 Nov 15, 2025

vflaux suggested changes Nov 16, 2025

View reviewed changes

k8s-ci-robot assigned vflaux Nov 16, 2025

bogdankrasko and others added 3 commits November 17, 2025 12:40

Update docs/annotations/annotations.md

0379521

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

fix: validate gateway-hostname-source and warn on invalid

7825cf1

fix: Fix formating

ebeb384

bogdankrasko requested a review from vflaux November 19, 2025 07:56

k8s-ci-robot assigned ivankatliarchuk Dec 2, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 2, 2025

mloiseleur mentioned this pull request Dec 7, 2025

docs(proposal): Gateway API annotation placement clarity proposal #5919

Merged

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 9, 2025

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 9, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 11, 2026

k8s-ci-robot merged commit fd70df9 into kubernetes-sigs:master Jan 11, 2026
18 checks passed

ivankatliarchuk mentioned this pull request Jan 16, 2026

Support external-dns.alpha.kubernetes.io/hostname on Gateway API Gateway #5765

Open

Conversation

bogdankrasko commented Nov 14, 2025 • edited by mloiseleur Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does it do ?

Motivation

More

Uh oh!

linux-foundation-easycla bot commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Nov 14, 2025

Uh oh!

k8s-ci-robot commented Nov 14, 2025

Uh oh!

bogdankrasko commented Nov 14, 2025

Smoke tests

Setup

manifest:

Master

Uh oh!

mloiseleur commented Nov 15, 2025

Uh oh!

coveralls commented Nov 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 19441565668

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

Uh oh!

vflaux Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

bogdankrasko Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

vflaux Nov 16, 2025

Choose a reason for hiding this comment

Uh oh!

bogdankrasko Nov 17, 2025

Choose a reason for hiding this comment

Uh oh!

ivankatliarchuk commented Dec 2, 2025

Uh oh!

mloiseleur commented Dec 7, 2025

Uh oh!

szuecs commented Dec 9, 2025

Uh oh!

mloiseleur commented Dec 9, 2025

Uh oh!

bogdankrasko commented Dec 11, 2025

Uh oh!

bogdankrasko commented Dec 22, 2025

Uh oh!

mloiseleur commented Dec 27, 2025

Uh oh!

ivankatliarchuk commented Dec 27, 2025

Uh oh!

ivankatliarchuk commented Jan 11, 2026

Uh oh!

k8s-ci-robot commented Jan 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

bogdankrasko commented Nov 14, 2025 •

edited by mloiseleur

Loading

linux-foundation-easycla bot commented Nov 14, 2025 •

edited

Loading

coveralls commented Nov 15, 2025 •

edited

Loading