From 6e26f9454499223fbc88322ef41d251a0a90779a Mon Sep 17 00:00:00 2001
From: Andy Bursavich <abursavich@gmail.com>
Date: Tue, 14 Sep 2021 14:21:37 -0700
Subject: [PATCH] gateway: add docs tutorial

---
 docs/tutorials/gateway-api.md | 90 +++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)
 create mode 100644 docs/tutorials/gateway-api.md

diff --git a/docs/tutorials/gateway-api.md b/docs/tutorials/gateway-api.md
new file mode 100644
index 0000000000..2d9b7fa343
--- /dev/null
+++ b/docs/tutorials/gateway-api.md
@@ -0,0 +1,90 @@
+# 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
+
+The HTTPRoute and TLSRoute specs contain hostnames that are used by ExternalDNS, but there are
+no such hostnames available in TCPRoute and UDPRoute specs. For all types of routes, the
+`external-dns.alpha.kubernetes.io/hostname` annotation may be used to provide hostnames.
+
+## 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
+```