|Vladimir Smagin ca5bd7ca4f||4 months ago|
|.github||4 months ago|
|controller||6 months ago|
|docs||4 months ago|
|endpoint||8 months ago|
|img||3 years ago|
|internal||4 months ago|
|kustomize||4 months ago|
|pkg||4 months ago|
|plan||7 months ago|
|provider||4 months ago|
|registry||4 months ago|
|scripts||2 years ago|
|source||4 months ago|
|.gitignore||2 years ago|
|.golangci.yml||5 months ago|
|.zappr.yaml||3 years ago|
|CHANGELOG.md||4 months ago|
|CONTRIBUTING.md||4 months ago|
|Dockerfile||6 months ago|
|Dockerfile.mini||8 months ago|
|LICENSE||3 years ago|
|Makefile||4 months ago|
|OWNERS||4 months ago|
|README.md||4 months ago|
|SECURITY_CONTACTS||6 months ago|
|cloudbuild.yaml||1 year ago|
|code-of-conduct.md||3 years ago|
|go.mod||4 months ago|
|go.sum||5 months ago|
|main.go||4 months ago|
ExternalDNS synchronizes exposed Kubernetes Services and Ingresses with DNS providers.
Inspired by Kubernetes DNS, Kubernetes' cluster-internal DNS server, ExternalDNS makes Kubernetes resources discoverable via public DNS servers. Like KubeDNS, it retrieves a list of resources (Services, Ingresses, etc.) from the Kubernetes API to determine a desired list of DNS records. Unlike KubeDNS, however, it's not a DNS server itself, but merely configures other DNS providers accordingly—e.g. AWS Route 53 or Google Cloud DNS.
In a broader sense, ExternalDNS allows you to control DNS records dynamically via Kubernetes resources in a DNS provider-agnostic way.
The FAQ contains additional information and addresses several questions about key concepts of ExternalDNS.
ExternalDNS' current release is
v0.7. This version allows you to keep selected zones (via
--domain-filter) synchronized with Ingresses and Services of
type=LoadBalancer in various cloud providers:
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.5 (or greater) 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.
Note that all flags can be replaced with environment variables; for instance,
--dry-run could be replaced with
--registry txt could be replaced with
ExternalDNS supports multiple DNS providers which have been implemented by the ExternalDNS contributors. Maintaining all of those in a central repository is a challenge and we have limited resources to test changes. This means that it is very hard to test all providers for possible regressions and, as written in the Contributing section, we encourage contributors to step in as maintainers for the individual providers and help by testing the integrations.
We define the following stability levels for providers:
The following table clarifies the current status of the providers according to the aforementioned stability levels:
|Google Cloud DNS||Stable|
|AWS Route 53||Stable|
|AWS Cloud Map||Beta|
|Oracle Cloud Infrastructure DNS||Alpha|
The are two ways of running ExternalDNS:
The following tutorials are provided:
See the contributor guide for details on compiling from source.
Next, run an application and expose it via a Kubernetes Service:
$ kubectl run nginx --image=nginx --replicas=1 --port=80 $ kubectl expose deployment nginx --port=80 --target-port=80 --type=LoadBalancer
Annotate the Service with your desired external DNS name. Make sure to change
example.org to your domain.
$ kubectl annotate service nginx "external-dns.alpha.kubernetes.io/hostname=nginx.example.org."
Optionally, you can customize the TTL value of the resulting DNS record by using the
$ kubectl annotate service nginx "external-dns.alpha.kubernetes.io/ttl=10"
For more details on configuring TTL, see here.
Locally run a single sync loop of ExternalDNS.
$ external-dns --registry txt --txt-owner-id my-cluster-id --provider google --google-project example-project --source service --once --dry-run
This should output the DNS records it will modify to match the managed zone with the DNS records you desire. It also assumes you are running in the
default namespace. See the FAQ for more information regarding namespaces.
Note: TXT records will have
my-cluster-id value embedded. Those are used to ensure that ExternalDNS is aware of the records it manages.
Once you're satisfied with the result, you can run ExternalDNS like you would run it in your cluster: as a control loop, and not in dry-run mode:
$ external-dns --registry txt --txt-owner-id my-cluster-id --provider google --google-project example-project --source service
Check that ExternalDNS has created the desired DNS record for your Service and that it points to its load balancer's IP. Then try to resolve it:
$ dig +short nginx.example.org. 184.108.40.206
Now you can experiment and watch how ExternalDNS makes sure that your DNS records are configured as desired. Here are a couple of things you can try out:
The tutorials section contains examples, including Ingress resources, and shows you how to set up ExternalDNS in different environments such as other cloud providers and alternative Ingress controllers.
If using a txt registry and attempting to use a CNAME the
--txt-prefix must be set to avoid conflicts. Changing
--txt-prefix will result in lost ownership over previously created records.
ExternalDNS was built with extensibility in mind. Adding and experimenting with new DNS providers and sources of desired DNS records should be as easy as possible. It should also be possible to modify how ExternalDNS behaves—e.g. whether it should add records but never delete them.
Here's a rough outline on what is to come (subject to change):
Have a look at the milestones to get an idea of where we currently stand.
Are you interested in contributing to external-dns? We, the maintainers and community, would love your suggestions, contributions, and help! Also, the maintainers can be contacted at any time to learn more about how to get involved.
We also encourage ALL active community participants to act as if they are maintainers, even if you don't have "official" write permissions. This is a community effort, we are here to serve the Kubernetes community. If you have an active interest and you want to get involved, you have real power! Don't assume that the only people who can get things done around here are the "maintainers". We also would love to add more "official" maintainers, so show us what you can do!
The external-dns project is currently in need of maintainers for specific DNS providers. Ideally each provider would have at least two maintainers. It would be nice if the maintainers run the provider in production, but it is not strictly required. Provider listed here that do not have a maintainer listed are in need of assistance.
For an overview on how to write new Sources and Providers check out Sources and Providers.
ExternalDNS is an effort to unify the following similar projects in order to bring the Kubernetes community an easy and predictable way of managing DNS records across cloud providers based on their Kubernetes resources: