mirrors/external-dns
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/external-dns.git synced 2025-11-28 16:31:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix: align more docs with the current release (#202)

Browse Source
This commit is contained in:
Martin Linkhorst 2017-05-08 18:45:59 +02:00 committed by Henning Jacobs
parent 55d709c38c
commit a2c893f2bb
4 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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.

4
docs/tutorials/aws.md
View File

@ -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

8
docs/tutorials/gke.md
View File

@ -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

4
docs/tutorials/nginx-ingress.md
View File

@ -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.