external-dns

README

ExternalDNS

ExternalDNS synchronizes exposed Kubernetes Services and Ingresses with DNS providers.

What It Does

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.

Getting started

ExternalDNS' current release is v0.1. This version allows you to keep a managed zone in Google's CloudDNS service synchronized with Services of type=LoadBalancer in your cluster.

In this release, ExternalDNS is limited to—and takes full ownership of—a single managed zone. In other words, if you have any existing records in that zone, they will be removed. We encourage you to try out ExternalDNS in its own zone first to see if that model works for you. However, ExternalDNS runs in dryRun mode by default, and won't make any changes to your infrastructure. So as long as you don't change that flag, you're safe.

Technical Requirements

Make sure you have the following prerequisites:

• A local Go 1.7+ development environment.
• Access to a Google project with the DNS API enabled.
• Access to a Kubernetes cluster that supports exposing Services, e.g. GKE.
• A properly set up, unused, and empty hosted zone in Google CloudDNS.

Setup Steps

First, get ExternalDNS:

$ go get -u github.com/kubernetes-incubator/external-dns

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

Locally run a single sync loop of ExternalDNS. Make sure to change the Google project to one you control, and the zone identifier to an unused and empty hosted zone in that project's Google CloudDNS:

$ external-dns --zone example-org --provider google --google-project example-project --source service --once

This should output the DNS records it will modify to match the managed zone with the DNS records you desire.

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 dryRun mode:

$ external-dns --zone example-org --provider google --google-project example-project --source service --dry-run=false

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

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:

• Change the desired hostname by modifying the Service's annotation.
• Recreate the Service and see that the DNS record will be updated to point to the new load balancer IP.
• Add another Service to create more DNS records.
• Remove Services to clean up your managed zone.

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.

Roadmap

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.

We're working on an ownership system that allows ExternalDNS to never modify records over which it lacks control.

Here's a rough outline on what is to come:

v0.1

• Support for Google CloudDNS
• Support for Kubernetes Services

v0.2

• Support for AWS Route 53
• Support for Kubernetes Ingresses

v0.3

• Support for AWS Route 53 via ALIAS
• Support for multiple zones
• Ownership System

v1.0

• Ability to replace Kops' DNS Controller
• Ability to replace Zalando's Mate
• Ability to replace Molecule Software's route53-kubernetes

Yet to be defined

• Support for CoreDNS and Azure DNS
• Support for record weights
• Support for different behavioral policies
• Support for Services with type=NodePort
• Support for TPRs
• Support for more advanced DNS record configurations

Have a look at the milestones to get an idea of where we currently stand.

Contributing

We encourage you to get involved with ExternalDNS, as users as well as contributors. Read the contributing guidelines and have a look at the contributing docs to learn about building the project, the project structure, and the purpose of each package.

Feel free to reach out to us on the Kubernetes slack in the #sig-network channel.

Heritage

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:

• Kops' DNS Controller
• Zalando's Mate
• Molecule Software's route53-kubernetes

Kubernetes Incubator

This is a Kubernetes Incubator project. The project was established 2017-Feb-9 (initial announcement here). The incubator team for the project is:

• Sponsor: sig-network
• Champion: Tim Hockin (@thockin)
• SIG: sig-network

For more information about sig-network, such as meeting times and agenda, check out the community site.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.