mirrors/external-dns
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/external-dns.git synced 2025-08-06 09:36:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document the Gateway sources

Browse Source
This commit is contained in:
John Gardiner Myers 2023-07-26 08:13:07 -07:00
parent 0eb1932cf5
commit 6b230c6c44
3 changed files with 107 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
docs/sources/gateway.md Normal file
View File

@ -0,0 +1,82 @@
# Gateway sources
The gateway-grcproute, gateway-httproute, gateway-tcproute, gateway-tlsroute, and gateway-udproute
sources create DNS entries based on their respective `gateway.networking.k8s.io` resources.
## Filtering the Routes considered
These sources support the `--label-filter` flag, which filters *Route resources
by a set of labels.
## Domain names
To calculate the Domain names created from a *Route, this source first collects a set
of [domain names from the *Route](#domain-names-from-route).
It then iterates over each of the `status.parents` with
a [matching Gateway](#matching-gateways) and at least one [matching listener](#matching-listeners).
For each matching listener, if the
listener has a `hostname`, it narrows the set of domain names from the *Route to the portion
that overlaps the `hostname`. If a matching listener does not have a `hostname`, it uses
the un-narrowed set of domain names.
### Domain names from Route
The set of domain names from a *Route is sourced from the following places:
* If the *Route is a GRPCRoute, HTTPRoute, or TLSRoute, adds each of the`spec.hostnames`.
* Adds the hostnames from any `external-dns.alpha.kubernetes.io/hostname` annotation on the *Route.
This behavior is suppressed if the `--ignore-hostname-annotation` flag was specified.
* If no endpoints were produced by the previous steps
or the `--combine-fqdn-annotation` flag was specified, then adds hostnames
generated from any`--fqdn-template` flag.
* If no endpoints were produced by the previous steps, each
attached Gateway listener will use its `hostname`, if present.
### Matching Gateways
Matching Gateways are discovered by iterating over the *Route's `status.parents`:
* Ignores parents with a `parentRef.group` other than
`gateway.networking.k8s.io` or a `parentRef.kind` other than `Gateway`.
* If the `--gateway-namespace` flag was specified, ignores parents with a `parentRef.namespace` other
than the specified value.
* If the `--gateway-label-filter` flag was specified, ignores parents whose Gateway does not match the
specified label filter.
* Ignores parents whose Gateway either does not exist or has not accepted the route.
### Matching listeners
Iterates over all listeners for the parent's `parentRef.sectionName`:
* Ignores listeners whose `protocol` field does not match the kind of the *Route per the following table:
| kind | protocols |
|------------|-------------|
| GRPCRoute | HTTP, HTTPS |
| HTTPRoute | HTTP, HTTPS |
| TCPRoute | TCP |
| TLSRoute | TLS |
| UDPRoute | UDP |
* If the parent's `parentRef.port` port is specified, ignores listeners without a matching `port`.
* Ignores listeners which specify an `allowedRoutes` which does not allow the route.
## Targets
The targets of the DNS entries created from a *Route are sourced from the following places:
1. If a matching parent Gateway has an `external-dns.alpha.kubernetes.io/target` annotation, uses
the values from that.
2. Otherwise, iterates over that parent Gateway's `status.addresses`,
adding each address's `value`.
The targets from each parent Gateway matching the *Route are then combined and de-duplicated.

48
docs/sources/sources.md
View File

@ -1,26 +1,26 @@
# Sources # Sources
| Source | Resources | annotation-filter | label-filter | | Source | Resources | annotation-filter | label-filter |
|-----------------------|-------------------------------------------------------------------------------|-------------------|--------------| |---------------------------------|-------------------------------------------------------------------------------|-------------------|--------------|
| ambassador-host | Host.getambassador.io | | | | ambassador-host | Host.getambassador.io | | |
| connector | | | | | connector | | | |
| contour-httpproxy | HttpProxy.projectcontour.io | Yes | | | contour-httpproxy | HttpProxy.projectcontour.io | Yes | |
| cloudfoundry | | | | | cloudfoundry | | | |
| crd | DNSEndpoint.externaldns.k8s.io | Yes | Yes | | crd | DNSEndpoint.externaldns.k8s.io | Yes | Yes |
| f5-virtualserver | VirtualServer.cis.f5.com | Yes | | | f5-virtualserver | VirtualServer.cis.f5.com | Yes | |
| gateway-grpcroute | GRPCRoute.gateway.networking.k8s.io | Yes | Yes | | [gateway-grpcroute](gateway.md) | GRPCRoute.gateway.networking.k8s.io | Yes | Yes |
| gateway-httproute | HTTPRoute.gateway.networking.k8s.io | Yes | Yes | | [gateway-httproute](gateway.md) | HTTPRoute.gateway.networking.k8s.io | Yes | Yes |
| gateway-tcproute | TCPRoute.gateway.networking.k8s.io | Yes | Yes | | [gateway-tcproute](gateway.md) | TCPRoute.gateway.networking.k8s.io | Yes | Yes |
| gateway-tlsroute | TLSRoute.gateway.networking.k8s.io | Yes | Yes | | [gateway-tlsroute](gateway.md) | TLSRoute.gateway.networking.k8s.io | Yes | Yes |
| gateway-udproute | UDPRoute.gateway.networking.k8s.io | Yes | Yes | | [gateway-udproute](gateway.md) | UDPRoute.gateway.networking.k8s.io | Yes | Yes |
| gloo-proxy | Proxy.gloo.solo.io | | | | gloo-proxy | Proxy.gloo.solo.io | | |
| [ingress](ingress.md) | Ingress.networking.k8s.io | Yes | Yes | | [ingress](ingress.md) | Ingress.networking.k8s.io | Yes | Yes |
| istio-gateway | Gateway.networking.istio.io | Yes | | | istio-gateway | Gateway.networking.istio.io | Yes | |
| istio-virtualservice | VirtualService.networking.istio.io | Yes | | | istio-virtualservice | VirtualService.networking.istio.io | Yes | |
| kong-tcpingress | TCPIngress.configuration.konghq.com | Yes | | | kong-tcpingress | TCPIngress.configuration.konghq.com | Yes | |
| node | Node | Yes | | | node | Node | Yes | |
| openshift-route | Route.route.openshift.io | Yes | Yes | | openshift-route | Route.route.openshift.io | Yes | Yes |
| pod | Pod | | | | pod | Pod | | |
| [service](service.md) | Service | Yes | Yes | | [service](service.md) | Service | Yes | Yes |
| skipper-routegroup | RouteGroup.zalando.org | Yes | | | skipper-routegroup | RouteGroup.zalando.org | Yes | |
| traefik-proxy | IngressRoute.traefik.io IngressRouteTCP.traefik.io IngressRouteUDP.traefik.io | Yes | | | traefik-proxy | IngressRoute.traefik.io IngressRouteTCP.traefik.io IngressRouteUDP.traefik.io | Yes | |

1
mkdocs.yml
View File

@ -16,6 +16,7 @@ nav:
- About: annotations/annotations.md - About: annotations/annotations.md
- Sources: - Sources:
- About: sources/sources.md - About: sources/sources.md
- Gateway: sources/gateway.md
- Ingress: sources/ingress.md - Ingress: sources/ingress.md
- Service: sources/service.md - Service: sources/service.md
- Registries: - Registries: