Merge branch 'master' into raffo/docs-v0.15.0

kubernetes-sigs · Sep 6, 2024 · 4117398 · 4117398
2 parents c2117b9 + 347c1b3
commit 4117398
Show file tree

Hide file tree

Showing 52 changed files with 133 additions and 93 deletions.
diff --git a/README.md b/README.md
@@ -160,7 +160,7 @@ The following tutorials are provided:
 * AWS
 	* [AWS Load Balancer Controller](docs/tutorials/aws-load-balancer-controller.md)
 	* [Route53](docs/tutorials/aws.md)
-		* [Same domain for public and private Route53 zones](docs/tutorials/public-private-route53.md)
+		* [Same domain for public and private Route53 zones](docs/tutorials/aws-public-private-route53.md)
 	* [Cloud Map](docs/tutorials/aws-sd.md)
 	* [Kube Ingress AWS Controller](docs/tutorials/kube-ingress-aws.md)
 * [Azure DNS](docs/tutorials/azure.md)
@@ -174,15 +174,13 @@ The following tutorials are provided:
 * [ExternalName Services](docs/tutorials/externalname.md)
 * Google Kubernetes Engine
 	* [Using Google's Default Ingress Controller](docs/tutorials/gke.md)
-	* [Using the Nginx Ingress Controller](docs/tutorials/nginx-ingress.md)
+	* [Using the Nginx Ingress Controller](docs/tutorials/gke-nginx.md)
 * [Headless Services](docs/tutorials/hostport.md)
-* [Istio Gateway Source](docs/tutorials/istio.md)
-* [Kubernetes Security Context](docs/tutorials/security-context.md)
+* [Istio Gateway Source](docs/sources/istio.md)
 * [Linode](docs/tutorials/linode.md)
-* [Nginx Ingress Controller](docs/tutorials/nginx-ingress.md)
 * [NS1](docs/tutorials/ns1.md)
-* [NS Record Creation with CRD Source](docs/tutorials/ns-record.md)
-* [MX Record Creation with CRD Source](docs/tutorials/mx-record.md)
+* [NS Record Creation with CRD Source](docs/sources/ns-record.md)
+* [MX Record Creation with CRD Source](docs/sources/mx-record.md)
 * [OpenStack Designate](docs/tutorials/designate.md)
 * [Oracle Cloud Infrastructure (OCI) DNS](docs/tutorials/oracle.md)
 * [PowerDNS](docs/tutorials/pdns.md)
@@ -195,7 +193,7 @@ The following tutorials are provided:
 * [GoDaddy](docs/tutorials/godaddy.md)
 * [Gandi](docs/tutorials/gandi.md)
 * [IBM Cloud](docs/tutorials/ibmcloud.md)
-* [Nodes as source](docs/tutorials/nodes.md)
+* [Nodes as source](docs/sources/nodes.md)
 * [TencentCloud](docs/tutorials/tencentcloud.md)
 * [Plural](docs/tutorials/plural.md)
 * [Pi-hole](docs/tutorials/pihole.md)

diff --git a/docs/sources/sources.md → docs/sources/about.md b/docs/sources/sources.md → docs/sources/about.md
@@ -1,4 +1,4 @@
-# Sources
+# About
 
 | Source                          | Resources                                                                     | annotation-filter | label-filter |
 |---------------------------------|-------------------------------------------------------------------------------|-------------------|--------------|

diff --git a/docs/tutorials/f5-virtualserver.md → docs/sources/f5-virtualserver.md b/docs/tutorials/f5-virtualserver.md → docs/sources/f5-virtualserver.md
@@ -1,4 +1,4 @@
-# Configuring ExternalDNS to use the F5 Networks VirtualServer Source
+# F5 Networks VirtualServer Source
 This tutorial describes how to configure ExternalDNS to use the F5 Networks VirtualServer Source. It is meant to supplement the other provider-specific setup tutorials.
 
 The F5 Networks VirtualServer CRD is part of [this](https://github.com/F5Networks/k8s-bigip-ctlr) project. See more in-depth info regarding the VirtualServer CRD [here](https://github.com/F5Networks/k8s-bigip-ctlr/blob/master/docs/config_examples/customResource/CustomResource.md#virtualserver).
@@ -30,4 +30,4 @@ Note that, in case you're not installing via Helm, you'll need the following in
   - get
   - list
   - watch
-```
+```
diff --git a/docs/tutorials/gateway-api.md → docs/sources/gateway-api.md b/docs/tutorials/gateway-api.md → docs/sources/gateway-api.md
@@ -1,4 +1,4 @@
-# Configuring ExternalDNS to use Gateway API Route Sources
+# 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.

diff --git a/docs/tutorials/gloo-proxy.md → docs/sources/gloo-proxy.md b/docs/tutorials/gloo-proxy.md → docs/sources/gloo-proxy.md
@@ -1,4 +1,4 @@
-# Configuring ExternalDNS to use the Gloo Proxy Source
+# Gloo Proxy Source
 This tutorial describes how to configure ExternalDNS to use the Gloo Proxy source.
 It is meant to supplement the other provider-specific setup tutorials.
 

diff --git a/docs/tutorials/istio.md → docs/sources/istio.md b/docs/tutorials/istio.md → docs/sources/istio.md
@@ -1,4 +1,5 @@
-# Configuring ExternalDNS to use the Istio Gateway and/or Istio Virtual Service Source
+# Istio Gateway / Virtual Service Source
+
 This tutorial describes how to configure ExternalDNS to use the Istio Gateway source.
 It is meant to supplement the other provider-specific setup tutorials.
 
@@ -43,6 +44,7 @@ spec:
 ```
 
 ### Manifest (for clusters with RBAC enabled)
+
 ```yaml
 apiVersion: v1
 kind: ServiceAccount
@@ -58,7 +60,7 @@ rules:
   resources: ["services","endpoints","pods"]
   verbs: ["get","watch","list"]
 - apiGroups: ["extensions","networking.k8s.io"]
-  resources: ["ingresses"] 
+  resources: ["ingresses"]
   verbs: ["get","watch","list"]
 - apiGroups: [""]
   resources: ["nodes"]
@@ -134,7 +136,7 @@ kubectl patch clusterrole external-dns --type='json' \
 
 ### Verify that Istio Gateway/VirtualService Source works
 
-Follow the [Istio ingress traffic tutorial](https://istio.io/docs/tasks/traffic-management/ingress/) 
+Follow the [Istio ingress traffic tutorial](https://istio.io/docs/tasks/traffic-management/ingress/)
 to deploy a sample service that will be exposed outside of the service mesh.
 The following are relevant snippets from that tutorial.
 
@@ -150,7 +152,9 @@ $ kubectl apply -f <(istioctl kube-inject -f https://raw.githubusercontent.com/i
 ```
 
 #### Using a Gateway as a source
+
 ##### Create an Istio Gateway:
+
 ```bash
 $ cat <<EOF | kubectl apply -f -
 apiVersion: networking.istio.io/v1alpha3
@@ -172,6 +176,7 @@ EOF
 ```
 
 ##### Configure routes for traffic entering via the Gateway:
+
 ```bash
 $ cat <<EOF | kubectl apply -f -
 apiVersion: networking.istio.io/v1alpha3
@@ -200,6 +205,7 @@ EOF
 #### Using a VirtualService as a source
 
 ##### Create an Istio Gateway:
+
 ```bash
 $ cat <<EOF | kubectl apply -f -
 apiVersion: networking.istio.io/v1alpha3
@@ -221,6 +227,7 @@ EOF
 ```
 
 ##### Configure routes for traffic entering via the Gateway:
+
 ```bash
 $ cat <<EOF | kubectl apply -f -
 apiVersion: networking.istio.io/v1alpha3

diff --git a/docs/tutorials/kong.md → docs/sources/kong.md b/docs/tutorials/kong.md → docs/sources/kong.md
@@ -1,8 +1,10 @@
-# Configuring ExternalDNS to use the Kong TCPIngress Source
+# Kong TCPIngress Source
+
 This tutorial describes how to configure ExternalDNS to use the Kong TCPIngress source.
 It is meant to supplement the other provider-specific setup tutorials.
 
 ### Manifest (for clusters without RBAC enabled)
+
 ```yaml
 apiVersion: apps/v1
 kind: Deployment

diff --git a/docs/tutorials/mx-record.md → docs/sources/mx-record.md b/docs/tutorials/mx-record.md → docs/sources/mx-record.md
@@ -1,4 +1,4 @@
-# Creating MX record with CRD source
+# MX record with CRD source
 
 You can create and manage MX records with the help of [CRD source](../contributing/crd-source.md)
 and `DNSEndpoint` CRD. Currently, this feature is only supported by `aws`, `azure`, and `google` providers.

diff --git a/docs/tutorials/nodes.md → docs/sources/nodes.md b/docs/tutorials/nodes.md → docs/sources/nodes.md
@@ -1,4 +1,4 @@
-# Configuring ExternalDNS to use Cluster Nodes as Source
+# Cluster Nodes as Source
 
 This tutorial describes how to configure ExternalDNS to use the cluster nodes as source.
 Using nodes (`--source=node`) as source is possible to synchronize a DNS zone with the nodes of a cluster.

diff --git a/docs/tutorials/ns-record.md → docs/sources/ns-record.md b/docs/tutorials/ns-record.md → docs/sources/ns-record.md
@@ -1,4 +1,4 @@
-# Creating NS record with CRD source
+# NS record with CRD source
 
 You can create NS records with the help of [CRD source](../contributing/crd-source.md)
 and `DNSEndpoint` CRD.

diff --git a/docs/tutorials/openshift.md → docs/sources/openshift.md b/docs/tutorials/openshift.md → docs/sources/openshift.md
@@ -1,4 +1,5 @@
-# Configuring ExternalDNS to use the OpenShift Route Source
+# OpenShift Route Source
+
 This tutorial describes how to configure ExternalDNS to use the OpenShift Route source.
 It is meant to supplement the other provider-specific setup tutorials.
 

diff --git a/docs/tutorials/traefik-proxy.md → docs/sources/traefik-proxy.md b/docs/tutorials/traefik-proxy.md → docs/sources/traefik-proxy.md
@@ -1,4 +1,4 @@
-# Configuring ExternalDNS to use the Traefik Proxy Source
+# Traefik Proxy Source
 
 This tutorial describes how to configure ExternalDNS to use the Traefik Proxy source.
 It is meant to supplement the other provider-specific setup tutorials.
@@ -96,7 +96,9 @@ spec:
 ```
 
 ## Deploying a Traefik IngressRoute
+
 Create a IngressRoute file called 'traefik-ingress.yaml' with the following contents:
+
 ```yaml
 apiVersion: traefik.io/v1alpha1
 kind: IngressRoute

diff --git a/docs/tutorials/akamai-edgedns.md b/docs/tutorials/akamai-edgedns.md
@@ -1,4 +1,4 @@
-# Setting up External-DNS for Services on Akamai Edge DNS
+# Akamai Edge DNS
 
 ## Prerequisites
 

diff --git a/docs/tutorials/alibabacloud.md b/docs/tutorials/alibabacloud.md
@@ -1,4 +1,4 @@
-# Setting up ExternalDNS for Services on Alibaba Cloud
+# Alibaba Cloud
 
 This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster on Alibaba Cloud. Make sure to use **>=0.5.6** version of ExternalDNS for this tutorial
 

diff --git a/docs/tutorials/aws-load-balancer-controller.md b/docs/tutorials/aws-load-balancer-controller.md
@@ -1,4 +1,4 @@
-# Using ExternalDNS with aws-load-balancer-controller
+# AWS Load Balancer Controller
 
 This tutorial describes how to use ExternalDNS with the [aws-load-balancer-controller][1].
 

diff --git a/docs/tutorials/public-private-route53.md → docs/tutorials/aws-public-private-route53.md b/docs/tutorials/public-private-route53.md → docs/tutorials/aws-public-private-route53.md
@@ -1,10 +1,10 @@
-# Setting up ExternalDNS using the same domain for public and private Route53 zones
+# AWS Route53 with same domain for public and private zones
 
 This tutorial describes how to setup ExternalDNS using the same domain for public and private Route53 zones and [nginx-ingress-controller](https://github.com/kubernetes/ingress-nginx). It also outlines how to use [cert-manager](https://github.com/jetstack/cert-manager) to automatically issue SSL certificates from [Let's Encrypt](https://letsencrypt.org/) for both public and private records.
 
 ## Deploy public nginx-ingress-controller
 
-Consult [External DNS nginx ingress docs](nginx-ingress.md) for installation guidelines.
+You may be interested with [GKE with nginx ingress](gke-nginx.md) for installation guidelines.
 
 Specify `ingress-class` in nginx-ingress-controller container args:
 
@@ -107,8 +107,6 @@ spec:
 
 ## Deploy private nginx-ingress-controller
 
-Consult [External DNS nginx ingress docs](nginx-ingress.md) for installation guidelines.
-
 Make sure to specify `ingress-class` in nginx-ingress-controller container args:
 
 ```yaml

diff --git a/docs/tutorials/aws-sd.md b/docs/tutorials/aws-sd.md
@@ -1,4 +1,4 @@
-# Setting up ExternalDNS using AWS Cloud Map API
+# AWS Cloud Map API
 
 This tutorial describes how to set up ExternalDNS for usage within a Kubernetes cluster with [AWS Cloud Map API](https://docs.aws.amazon.com/cloud-map/).
 

diff --git a/docs/tutorials/aws.md b/docs/tutorials/aws.md
@@ -1,4 +1,4 @@
-# Setting up ExternalDNS for Services on AWS
+# AWS
 
 This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster on AWS. Make sure to use **>=0.15.0** version of ExternalDNS for this tutorial
 
@@ -525,7 +525,7 @@ Annotations which are specific to AWS.
 
 ### alias
 
-`external-dns.alpha.kubernetes.io/alias` if set to `true` on an ingress, it will create an ALIAS record when the target is an ALIAS as well. To make the target an alias, the ingress needs to be configured correctly as described in [the docs](./nginx-ingress.md#with-a-separate-tcp-load-balancer). In particular, the argument `--publish-service=default/nginx-ingress-controller` has to be set on the `nginx-ingress-controller` container. If one uses the `nginx-ingress` Helm chart, this flag can be set with the `controller.publishService.enabled` configuration option.
+`external-dns.alpha.kubernetes.io/alias` if set to `true` on an ingress, it will create an ALIAS record when the target is an ALIAS as well. To make the target an alias, the ingress needs to be configured correctly as described in [the docs](./gke-nginx.md#with-a-separate-tcp-load-balancer). In particular, the argument `--publish-service=default/nginx-ingress-controller` has to be set on the `nginx-ingress-controller` container. If one uses the `nginx-ingress` Helm chart, this flag can be set with the `controller.publishService.enabled` configuration option.
 
 ### target-hosted-zone
 

diff --git a/docs/tutorials/azure-private-dns.md b/docs/tutorials/azure-private-dns.md
@@ -1,4 +1,4 @@
-# Set up ExternalDNS for Azure Private DNS
+# Azure Private DNS
 
 This tutorial describes how to set up ExternalDNS for managing records in Azure Private DNS.
 

diff --git a/docs/tutorials/azure.md b/docs/tutorials/azure.md
@@ -1,5 +1,4 @@
-
-# Setting up ExternalDNS for Services on Azure
+# Azure DNS
 
 This tutorial describes how to setup ExternalDNS for [Azure DNS](https://azure.microsoft.com/services/dns/) with [Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/).
 

diff --git a/docs/tutorials/civo.md b/docs/tutorials/civo.md
@@ -1,4 +1,4 @@
-# Setting up ExternalDNS for Services on Civo
+# Civo DNS
 
 This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster using Civo DNS Manager.
 
@@ -183,4 +183,4 @@ Now that we have verified that ExternalDNS will automatically manage Civo DNS re
 ```
 $ kubectl delete service -f nginx.yaml
 $ kubectl delete service -f externaldns.yaml
-```
+```
diff --git a/docs/tutorials/cloudflare.md b/docs/tutorials/cloudflare.md
@@ -1,4 +1,4 @@
-# Setting up ExternalDNS for Services on Cloudflare
+# Cloudflare DNS
 
 This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster using Cloudflare DNS.
 

diff --git a/docs/tutorials/contour.md b/docs/tutorials/contour.md
@@ -1,4 +1,4 @@
-# Setting up External DNS with Contour
+# Contour HTTPProxy
 
 This tutorial describes how to configure External DNS to use the Contour `HTTPProxy` source.
 Using the `HTTPProxy` resource with External DNS requires Contour version 1.5 or greater.