diff --git a/README.md b/README.md index bcd0a84a8..4f7d887ea 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ The [FAQ](docs/faq.md) contains additional information and addresses several que ## Getting started -ExternalDNS' current release is `v0.3`. This version allows you to keep selected zones (via `--domain`) in Google's [CloudDNS](https://cloud.google.com/dns/docs/) or [AWS' Route 53](https://aws.amazon.com/route53/) synchronized with Ingresses and Services of `type=LoadBalancer` in your cluster. +ExternalDNS' current release is `v0.3`. This version allows you to keep selected zones (via `--domain-filter`) in Google's [CloudDNS](https://cloud.google.com/dns/docs/) or [AWS' Route 53](https://aws.amazon.com/route53/) synchronized with Ingresses and Services of `type=LoadBalancer` in your cluster. From this release, ExternalDNS can become aware of the records it is managing (enabled via `--registry=txt`), therefore ExternalDNS can safely manage non-empty hosted zones. We strongly encourage you to use `v0.3` with `--registry=txt` enabled and `--txt-owner-id` set to a unique value that doesn't change for the lifetime of your cluster. You might also want to run ExternalDNS in a dry run mode (`--dry-run` flag) to see the changes to be submitted to your DNS Provider API. diff --git a/docs/tutorials/aws.md b/docs/tutorials/aws.md index 19c242919..56023eb3f 100644 --- a/docs/tutorials/aws.md +++ b/docs/tutorials/aws.md @@ -1,6 +1,6 @@ # Setting up ExternalDNS for Services on AWS -This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster on AWS. Make sure to use **>=0.3** version of ExternalDNS for this tutorial +This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster on AWS. Make sure to use **>=0.3** version of ExternalDNS for this tutorial ## Set up a hosted zone @@ -55,11 +55,11 @@ spec: args: - --source=service - --source=ingress + - --domain-filter=external-dns-test.my-org.com. # will make ExternalDNS see only the hosted zones matching provided domain, omit to process all available hosted zones - --provider=aws - --policy=upsert-only # would prevent ExternalDNS from deleting any records, omit to enable full synchronization - --registry=txt - --txt-owner-id=my-identifier - - --domain=external-dns-test.my-org.com. # will make ExternalDNS see only the hosted zones matching provided domain, omit to process all available hosted zones ``` ## Verify ExternalDNS works diff --git a/docs/tutorials/gke.md b/docs/tutorials/gke.md index d6bdcea4b..c380b55ca 100644 --- a/docs/tutorials/gke.md +++ b/docs/tutorials/gke.md @@ -1,6 +1,6 @@ # Setting up ExternalDNS on Google Container Engine -This tutorial describes how to setup ExternalDNS for usage within a GKE cluster. Make sure to use **>=0.3** version of ExternalDNS for this tutorial +This tutorial describes how to setup ExternalDNS for usage within a GKE cluster. Make sure to use **>=0.3** version of ExternalDNS for this tutorial ## Set up your environment @@ -81,15 +81,15 @@ spec: args: - --source=service - --source=ingress + - --domain-filter=external-dns-test.gcp.zalan.do. #will make ExternalDNS see only the hosted zones matching provided domain, omit to process all available hosted zones - --provider=google + - --google-project=zalando-external-dns-test - --policy=upsert-only # would prevent ExternalDNS from deleting any records, omit to enable full synchronization - --registry=txt - --txt-owner-id=my-identifier - - --domain=external-dns-test.gcp.zalan.do. #will make ExternalDNS see only the hosted zones matching provided domain, omit to process all available hosted zones - - --google-project=zalando-external-dns-test ``` -Use `dry-run=true` if you want to be extra careful on the first run. Note, that you will not see any records created when you are running in dry-run mode. You can, however, inspect the logs and watch what would have been done. +Use `--dry-run` if you want to be extra careful on the first run. Note, that you will not see any records created when you are running in dry-run mode. You can, however, inspect the logs and watch what would have been done. ## Verify ExternalDNS works diff --git a/docs/tutorials/nginx-ingress.md b/docs/tutorials/nginx-ingress.md index 4c74a5e32..2093b3eea 100644 --- a/docs/tutorials/nginx-ingress.md +++ b/docs/tutorials/nginx-ingress.md @@ -219,14 +219,12 @@ spec: - name: external-dns image: registry.opensource.zalan.do/teapot/external-dns:v0.3.0 args: - - --in-cluster - --source=ingress + - --domain-filter=external-dns-test.gcp.zalan.do. - --provider=google - --google-project=zalando-external-dns-test - - --dry-run=false - --registry=txt - --txt-owner-id=my-identifier - - --domain=external-dns-test.gcp.zalan.do. ``` Use `dry-run=true` if you want to be extra careful on the first run. Note, that you will not see any records created when you are running in dry-run mode. You can, however, inspect the logs and watch what would have been done.