-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3806 from johngmyers/doc-sources
Document the Ingress source
- Loading branch information
Showing
5 changed files
with
86 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Ingress source | ||
|
||
The ingress source creates DNS entries based on `Ingress.networking.k8s.io` resources. | ||
|
||
## Filtering the Ingresses considered | ||
|
||
The `--ingress-class` flag filters Ingress resources by a set of ingress classes. | ||
The flag may be specified multiple times in order to | ||
allow multiple ingress classes. | ||
|
||
This source supports the `--label-filter` flag, which filters Ingress resources | ||
by a set of labels. | ||
|
||
## Domain names | ||
|
||
The domain names of the DNS entries created from an Ingress are sourced from the following places: | ||
|
||
* Iterates over the Ingress's `spec.rules`, adding any non-empty `host`. | ||
|
||
This behavior is suppressed if the `--ignore-ingress-rules-spec` flag was specified | ||
or the Ingress had an | ||
`external-dns.alpha.kubernetes.io/ingress-hostname-source: annotation-only` annotation. | ||
|
||
* Iterates over the Ingress's `spec.tls`, adding each member of `hosts`. | ||
|
||
This behavior is suppressed if the `--ignore-ingress-tls-spec` flag was specified | ||
or the Ingress had an | ||
`external-dns.alpha.kubernetes.io/ingress-hostname-source: annotation-only` annotation, | ||
|
||
* Adds the hostnames from any `external-dns.alpha.kubernetes.io/hostname` annotation. | ||
|
||
This behavior is suppressed if the `--ignore-hostname-annotation` flag was specified | ||
or the Ingress had an | ||
`external-dns.alpha.kubernetes.io/ingress-hostname-source: defined-hosts-only` annotation. | ||
|
||
* If no endpoints were produced for an Ingress by the previous steps | ||
or the `--combine-fqdn-annotation` flag was specified, then adds hostnames | ||
generated from any`--fqdn-template` flag. | ||
|
||
## Targets | ||
|
||
The targets of the DNS entries created from an Ingress are sourced from the following places: | ||
|
||
* If the Ingress has an `external-dns.alpha.kubernetes.io/target` annotation, uses | ||
the values from that. | ||
|
||
* Otherwise, iterates over the Ingress's `status.loadBalancer.ingress`, | ||
adding each non-empty `ip` and `hostname`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Sources | ||
|
||
| Source | Resources | annotation-filter | label-filter | | ||
|-----------------------|-------------------------------------------------------------------------------|-------------------|--------------| | ||
| ambassador-host | Host.getambassador.io | | | | ||
| connector | | | | | ||
| contour-httpproxy | HttpProxy.projectcontour.io | Yes | | | ||
| cloudfoundry | | | | | ||
| crd | DNSEndpoint.externaldns.k8s.io | Yes | Yes | | ||
| f5-virtualserver | VirtualServer.cis.f5.com | Yes | | | ||
| gateway-grpcroute | GRPCRoute.gateway.networking.k8s.io | Yes | Yes | | ||
| gateway-httproute | HTTPRoute.gateway.networking.k8s.io | Yes | Yes | | ||
| gateway-tcproute | TCPRoute.gateway.networking.k8s.io | Yes | Yes | | ||
| gateway-tlsroute | TLSRoute.gateway.networking.k8s.io | Yes | Yes | | ||
| gateway-udproute | UDPRoute.gateway.networking.k8s.io | Yes | Yes | | ||
| gloo-proxy | Proxy.gloo.solo.io | | | | ||
| [ingress](ingress.md) | Ingress.networking.k8s.io | Yes | Yes | | ||
| istio-gateway | Gateway.networking.istio.io | Yes | | | ||
| istio-virtualservice | VirtualService.networking.istio.io | Yes | | | ||
| kong-tcpingress | TCPIngress.configuration.konghq.com | Yes | | | ||
| node | Node | Yes | | | ||
| openshift-route | Route.route.openshift.io | Yes | Yes | | ||
| pod | Pod | | | | ||
| service | Service | Yes | Yes | | ||
| skipper-routegroup | RouteGroup.zalando.org | Yes | | | ||
| traefik-proxy | IngressRoute.traefik.io IngressRouteTCP.traefik.io IngressRouteUDP.traefik.io | Yes | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters