mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2025-08-07 10:06:57 +02:00
gateway: add docs tutorial
This commit is contained in:
parent
4371589a14
commit
db8435d7ca
94
docs/tutorials/gateway-api.md
Normal file
94
docs/tutorials/gateway-api.md
Normal file
@ -0,0 +1,94 @@
|
|||||||
|
# Configuring ExternalDNS to use Gateway API Route Sources
|
||||||
|
|
||||||
|
This describes how to configure ExternalDNS to use Gateway API Route sources.
|
||||||
|
It is meant to supplement the other provider-specific setup tutorials.
|
||||||
|
|
||||||
|
## Supported API Versions
|
||||||
|
|
||||||
|
The currently supported version of Gateway API is v1alpha2. However, the maintainers of ExternalDNS
|
||||||
|
make no backwards compatibility guarantees with alpha versions of the API. Future releases may only
|
||||||
|
support beta or stable API versions.
|
||||||
|
|
||||||
|
## Hostnames
|
||||||
|
|
||||||
|
HTTPRoute and TLSRoute specs, along with their associated Gateway Listeners, contain hostnames that
|
||||||
|
will be used by ExternalDNS. However, no such hostnames may be specified in TCPRoute or UDPRoute
|
||||||
|
specs. For TCPRoutes and UDPRoutes, the `external-dns.alpha.kubernetes.io/hostname` annotation
|
||||||
|
is the recommended way to provide their hostnames to ExternalDNS. This annotation is also supported
|
||||||
|
for HTTPRoutes and TLSRoutes by ExternalDNS, but it's _strongly_ recommended that they use their
|
||||||
|
specs to provide all intended hostnames, since the Gateway that ultimately routes their
|
||||||
|
requests/connections won't recognize additional hostnames from the annotation.
|
||||||
|
|
||||||
|
## Manifest with RBAC
|
||||||
|
```yaml
|
||||||
|
apiVersion: v1
|
||||||
|
kind: ServiceAccount
|
||||||
|
metadata:
|
||||||
|
name: external-dns
|
||||||
|
namespace: default
|
||||||
|
---
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
kind: ClusterRole
|
||||||
|
metadata:
|
||||||
|
name: external-dns
|
||||||
|
rules:
|
||||||
|
- apiGroups: [""]
|
||||||
|
resources: ["namespaces"]
|
||||||
|
verbs: ["get","watch","list"]
|
||||||
|
- apiGroups: ["gateway.networking.k8s.io"]
|
||||||
|
resources: ["gateways","httproutes","tlsroutes","tcproutes","udproutes"]
|
||||||
|
verbs: ["get","watch","list"]
|
||||||
|
---
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
kind: ClusterRoleBinding
|
||||||
|
metadata:
|
||||||
|
name: external-dns
|
||||||
|
roleRef:
|
||||||
|
apiGroup: rbac.authorization.k8s.io
|
||||||
|
kind: ClusterRole
|
||||||
|
name: external-dns
|
||||||
|
subjects:
|
||||||
|
- kind: ServiceAccount
|
||||||
|
name: external-dns
|
||||||
|
namespace: default
|
||||||
|
---
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: external-dns
|
||||||
|
namespace: default
|
||||||
|
spec:
|
||||||
|
strategy:
|
||||||
|
type: Recreate
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app: external-dns
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app: external-dns
|
||||||
|
spec:
|
||||||
|
serviceAccountName: external-dns
|
||||||
|
containers:
|
||||||
|
- name: external-dns
|
||||||
|
image: k8s.gcr.io/external-dns/external-dns:v0.10.0
|
||||||
|
args:
|
||||||
|
# Add desired Gateway API Route sources.
|
||||||
|
- --source=gateway-httproute
|
||||||
|
- --source=gateway-tlsroute
|
||||||
|
- --source=gateway-tcproute
|
||||||
|
- --source=gateway-udproute
|
||||||
|
# Optionally, limit Routes to those in the given namespace.
|
||||||
|
- --namespace=my-route-namespace
|
||||||
|
# Optionally, limit Routes to those matching the given label selector.
|
||||||
|
- --label-filter=my-route-label==my-route-value
|
||||||
|
# Optionally, limit Route endpoints to those Gateways in the given namespace.
|
||||||
|
- --gateway-namespace=my-gateway-namespace
|
||||||
|
# Optionally, limit Route endpoints to those Gateways matching the given label selector.
|
||||||
|
- --gateway-label-filter=my-gateway-label==my-gateway-value
|
||||||
|
# Add provider-specific flags...
|
||||||
|
- --domain-filter=external-dns-test.my-org.com
|
||||||
|
- --provider=google
|
||||||
|
- --registry=txt
|
||||||
|
- --txt-owner-id=my-identifier
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user