Skip to content

feat(source/gateway-api): add Gateway resource source#6380

Open
danicaceres1998 wants to merge 1 commit intokubernetes-sigs:masterfrom
danicaceres1998:feat/gateway-resource-source
Open

feat(source/gateway-api): add Gateway resource source#6380
danicaceres1998 wants to merge 1 commit intokubernetes-sigs:masterfrom
danicaceres1998:feat/gateway-resource-source

Conversation

@danicaceres1998
Copy link
Copy Markdown

@danicaceres1998 danicaceres1998 commented Apr 21, 2026

What does it do ?

Unlike the route sources (gateway-httproute etc.) which resolve hostnames by traversing Route → parentRef → Gateway, this source targets the Gateway object itself — useful when DNS is managed at the infrastructure level rather than per-route.

  • Adds a new gateway source type (--source=gateway) that watches Gateway resources directly and publishes DNS records (A/AAAA/CNAME) from status.addresses
  • This source targets the Gateway object itself via the external-dns.alpha.kubernetes.io/hostname annotation
  • Adds 16 unit tests covering all filtering, record type selection, and annotation behaviors
  • Updates docs: flags.md, sources/index.md (regenerated), and sources/gateway-api.md

Supported features:

  • Hostname annotation (external-dns.alpha.kubernetes.io/hostname)
  • Target override annotation (external-dns.alpha.kubernetes.io/target)
  • TTL annotation, provider-specific annotations
  • GatewayName / GatewayNamespace / GatewayLabelFilter / AnnotationFilter
  • FQDN template (--fqdn-template flag)
  • Controller annotation mismatch filtering

Motivation

Users managing DNS at the infrastructure level (one Gateway = one external IP) should not need to annotate every individual Route. This source allows ExternalDNS to watch Gateways directly.

I'm working on a Gateway-as-a-Service (GaaS) architecture. The goal is to only manage headless Gateways and rely on the HTTPRoute resources to manage redirections within the cluster. When I was performing some tests and validations, I just found that the project does not support the native Gateway source, so decided to carry out the implementation.

More

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

@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Apr 21, 2026

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: danicaceres1998 / name: Juan Ojeda (8f7e69c)

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @danicaceres1998!

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 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 Apr 21, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @danicaceres1998. 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.

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.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 21, 2026
@k8s-ci-robot
Copy link
Copy Markdown
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 ivankatliarchuk for approval. For more information see the Code Review Process.

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

Details 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 size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 21, 2026
@k8s-ci-robot k8s-ci-robot requested a review from mloiseleur April 21, 2026 01:04
@danicaceres1998 danicaceres1998 force-pushed the feat/gateway-resource-source branch from 6ed47ab to 39d1f4f Compare April 21, 2026 01:08
@danicaceres1998
Copy link
Copy Markdown
Author

/easycla

@danicaceres1998 danicaceres1998 force-pushed the feat/gateway-resource-source branch from 39d1f4f to aeee16a Compare April 21, 2026 01:27
@danicaceres1998
Copy link
Copy Markdown
Author

/easycla

Add a new `gateway` source type that watches Gateway resources directly
and publishes DNS records (A/AAAA/CNAME) from status.addresses when
the gateway is annotated with external-dns.alpha.kubernetes.io/hostname.

Unlike the route sources (gateway-httproute etc.) which resolve hostnames
by traversing Route → parentRef → Gateway, this source targets the Gateway
object itself — useful when DNS is managed at the infrastructure level
rather than per-route.

Supported features:
- Hostname annotation (external-dns.alpha.kubernetes.io/hostname)
- Target override annotation (external-dns.alpha.kubernetes.io/target)
- TTL annotation, provider-specific annotations
- GatewayName / GatewayNamespace / GatewayLabelFilter / AnnotationFilter
- FQDN template (--fqdn-template flag)
- Controller annotation mismatch filtering
@danicaceres1998 danicaceres1998 force-pushed the feat/gateway-resource-source branch from aeee16a to 8f7e69c Compare April 21, 2026 02:03
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. docs 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. source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants