Add Support for Gateway API Route Sources #2292

abursavich · 2021-09-14T21:52:02Z

Description

This adds support for Gateway API (v1alpha2 at v0.4.0-rc1) HTTPRoute, TLSRoute, TCPRoute, and UDPRoute kinds as sources.

Since the upstream API is still in alpha, no backwards compatibility guarantees are made for its support in ExternalDNS.

Fixes #2045

Checklist

Unit tests updated
End user documentation updated

abursavich · 2021-09-15T02:13:40Z

Pushed changes to fix some doc formatting and make some names more consistent.

abursavich · 2021-09-15T15:59:01Z

Rebased after dependabot merges.

abursavich · 2021-10-15T16:40:08Z

Updated to sigs.k8s.io/gateway-api@v0.4.0.

abursavich · 2021-10-25T03:20:56Z

Rebased changes from #2371.

abursavich · 2021-12-18T01:07:37Z

youngnick · 2022-03-31T01:05:42Z

From a Gateway API point of view, this LGTM. I'd love to see it in, it will really help Gateway API users. (Gateway API maintainer here :) ) The tricky part is in the Gateway and Route checking logic, and that's all correct.

@Raffo, over to you.

abursavich · 2022-04-05T14:16:23Z

/unassign @Raffo
/assign @njuettner

abursavich · 2022-04-05T14:26:14Z

I noticed that @Raffo's status is "💤 Taking a break from open source."

So... reassigned.

seanmalloy · 2022-04-22T19:29:14Z

/kind feature

seanmalloy · 2022-04-22T20:26:54Z

/lgtm

seanmalloy · 2022-04-22T20:28:41Z

@njuettner would you have time to take a look at this one?

seanmalloy · 2022-04-26T02:20:22Z

/assign @Raffo

Raffo

@abursavich I started to take a look at this PR, added two comments and I appreciate the abundant use of TODOs to signal points in which we might need to offer guidance. My problem reviewing this is that it's really huge and it's hard for me to make a sense of it. I will do the following:

ask in Slack is someone is willing to help with the review of this.
if we get no answer, give it another pass and eventually merge as it's an optional source anyway and the common parts modified seem fine.

Raffo · 2022-05-04T08:35:19Z

source/gateway.go

+}
+
+func newGatewayRouteSource(clients ClientGenerator, config *Config, kind string, newInformerFn newGatewayRouteInformerFunc) (Source, error) {
+	ctx := context.TODO()


Is context.TODO the right context to use here?

I think so.

https://pkg.go.dev/context#TODO

TODO returns a non-nil, empty Context. Code should use context.TODO when it's unclear which Context to use or it is not yet available (because the surrounding function has not yet been extended to accept a Context parameter).

Raffo · 2022-05-04T08:36:55Z

source/gateway.go

+	}
+
+	informerFactory := newGatewayInformerFactory(client, config.GatewayNamespace, gwLabels)
+	gwInformer := informerFactory.Gateway().V1alpha2().Gateways() // TODO: Gateway informer should be shared across gateway sources.


Are we fine with keeping the non shared across resources informers? Could it cause problems?

It shouldn't cause problems. The issue is that each informer instance creates another watch on the apiserver. Sharing wherever possible will reduce network traffic and load on the apiserver.

Informers are not shared across existing sources. The node, service, and pod sources are good examples of this duplication.

Raffo · 2022-05-04T08:38:54Z

source/gateway.go

+		resourceKey := fmt.Sprintf("%s/%s/%s", kind, meta.Namespace, meta.Name)
+		providerSpecific, setIdentifier := getProviderSpecificAnnotations(annots)
+		ttl, err := getTTLFromAnnotations(annots)
+		if err != nil {


If we ignore the error here, we'll be passing nil to endpointsForHostname. Would this even be correct? Isn't it better to return the error?

A few sources return the error, but the most common behavior seems to be log a warning and continue. When there's an error, the ttl value is 0 which ends up being replaced with whatever the default ttl is configured as.

e.g.: https://github.com/kubernetes-sigs/external-dns/blob/v0.11.1/source/ingress.go#L229-L234

abursavich · 2022-05-11T01:35:18Z

ask in Slack is someone is willing to help with the review of this.

Btw, it's already gotten LGTMs from @youngnick and @seanmalloy.

seanmalloy · 2022-05-20T16:19:44Z

@abursavich I started to take a look at this PR, added two comments and I appreciate the abundant use of TODOs to signal points in which we might need to offer guidance. My problem reviewing this is that it's really huge and it's hard for me to make a sense of it. I will do the following:

ask in Slack is someone is willing to help with the review of this.

if we get no answer, give it another pass and eventually merge as it's an optional source anyway and the common parts modified seem fine.

@Raffo any thoughts on merging this?

Raffo · 2022-05-25T08:20:12Z

We can merge this 👍

Raffo · 2022-05-25T08:20:19Z

/lgtm
/approve

k8s-ci-robot · 2022-05-25T08:20:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abursavich, Raffo

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [Raffo]

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 added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 14, 2021

k8s-ci-robot requested review from njuettner and Raffo September 14, 2021 21:52

abursavich force-pushed the gateway-redo branch 2 times, most recently from 2245893 to 4b6a8ee Compare September 15, 2021 02:10

abursavich force-pushed the gateway-redo branch from 4b6a8ee to 7ebfe73 Compare September 15, 2021 04:39

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 15, 2021

abursavich force-pushed the gateway-redo branch from 7ebfe73 to c30a3f6 Compare September 15, 2021 15:58

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 15, 2021

abursavich force-pushed the gateway-redo branch 4 times, most recently from 04d78ec to 603baca Compare September 22, 2021 00:17

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 29, 2021

abursavich force-pushed the gateway-redo branch from 603baca to 0f08392 Compare October 5, 2021 16:59

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 5, 2021

abursavich force-pushed the gateway-redo branch from 0f08392 to 6e26f94 Compare October 15, 2021 16:34

abursavich force-pushed the gateway-redo branch from 6e26f94 to 6e905b9 Compare October 25, 2021 03:19

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 20, 2021

abursavich force-pushed the gateway-redo branch from 6e905b9 to 0d77082 Compare November 21, 2021 23:17

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 21, 2021

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 17, 2021

abursavich force-pushed the gateway-redo branch from 0d77082 to 32d2e20 Compare December 18, 2021 01:22

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 18, 2021

abursavich added 6 commits February 24, 2022 21:30

gateway-httproute: add source

3a1d86b

gateway-tlsroute: add source

32ca4e6

gateway-tcproute: add source

52e3fd6

gateway-udproute: add source

71e45ce

gateway: enforce listener matching

4371589

gateway: add docs tutorial

db8435d

abursavich force-pushed the gateway-redo branch from 11e9028 to db8435d Compare February 25, 2022 06:08

k8s-ci-robot assigned njuettner and unassigned Raffo Apr 5, 2022

k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 22, 2022

k8s-ci-robot assigned seanmalloy Apr 22, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 22, 2022

k8s-ci-robot assigned Raffo Apr 26, 2022

Raffo reviewed May 4, 2022

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 25, 2022

k8s-ci-robot merged commit 66e0d8c into kubernetes-sigs:master May 25, 2022

abursavich deleted the gateway-redo branch July 13, 2022 17:56

mn0o7 mentioned this pull request Sep 12, 2022

Support Gateway Api v1beta1 #3020

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for Gateway API Route Sources #2292

Add Support for Gateway API Route Sources #2292

abursavich commented Sep 14, 2021

abursavich commented Sep 15, 2021

abursavich commented Sep 15, 2021

abursavich commented Oct 15, 2021

abursavich commented Oct 25, 2021

abursavich commented Dec 18, 2021

youngnick commented Mar 31, 2022

abursavich commented Apr 5, 2022

abursavich commented Apr 5, 2022

seanmalloy commented Apr 22, 2022

seanmalloy commented Apr 22, 2022

seanmalloy commented Apr 22, 2022

seanmalloy commented Apr 26, 2022

Raffo left a comment

Raffo May 4, 2022

abursavich May 4, 2022

Raffo May 4, 2022

abursavich May 4, 2022

Raffo May 4, 2022

abursavich May 4, 2022 •

edited

abursavich commented May 11, 2022

seanmalloy commented May 20, 2022

Raffo commented May 25, 2022

Raffo commented May 25, 2022

k8s-ci-robot commented May 25, 2022

Add Support for Gateway API Route Sources #2292

Add Support for Gateway API Route Sources #2292

Conversation

abursavich commented Sep 14, 2021

abursavich commented Sep 15, 2021

abursavich commented Sep 15, 2021

abursavich commented Oct 15, 2021

abursavich commented Oct 25, 2021

abursavich commented Dec 18, 2021

youngnick commented Mar 31, 2022

abursavich commented Apr 5, 2022

abursavich commented Apr 5, 2022

seanmalloy commented Apr 22, 2022

seanmalloy commented Apr 22, 2022

seanmalloy commented Apr 22, 2022

seanmalloy commented Apr 26, 2022

Raffo left a comment

Choose a reason for hiding this comment

Raffo May 4, 2022

Choose a reason for hiding this comment

abursavich May 4, 2022

Choose a reason for hiding this comment

Raffo May 4, 2022

Choose a reason for hiding this comment

abursavich May 4, 2022

Choose a reason for hiding this comment

Raffo May 4, 2022

Choose a reason for hiding this comment

abursavich May 4, 2022 • edited

Choose a reason for hiding this comment

abursavich commented May 11, 2022

seanmalloy commented May 20, 2022

Raffo commented May 25, 2022

Raffo commented May 25, 2022

k8s-ci-robot commented May 25, 2022

abursavich May 4, 2022 •

edited