CoreDNS is a DNS server that chains plugins
Find a file
Miek Gieben 416603383d Cleanup and fixes (#223)
* Set version to 001
* Remove k8stest, test fails is k8s is not there: touch luck
* Remove server directory: not used anymore
* Disable k8s test (for now)
* gometalinter changes
2016-08-20 23:03:36 +01:00
conf Adding label selector support to Corefile (#208) 2016-08-12 20:44:08 -07:00
contrib/kubernetes Moving k8s coredns yaml service definition file (#218) 2016-08-16 09:47:08 -07:00
core Cleanup and fixes (#223) 2016-08-20 23:03:36 +01:00
logo Adding logo files (#195) 2016-07-27 11:01:12 -07:00
middleware Cleanup and fixes (#223) 2016-08-20 23:03:36 +01:00
singleflight Move singleflight out of middleware/ (#217) 2016-08-16 09:24:37 -07:00
test Cleanup and fixes (#223) 2016-08-20 23:03:36 +01:00
.gitignore Adding test cases for Corefile parsing (#193) 2016-07-22 16:07:27 -07:00
.travis.yml Make CoreDNS a server type plugin for Caddy (#220) 2016-08-19 17:14:17 -07:00
CONTRIBUTING.md Clean up some references to Caddy 2016-04-11 07:59:30 +01:00
coredns.go Cleanup and fixes (#223) 2016-08-20 23:03:36 +01:00
Dockerfile Add Dockerfile (#116) 2016-04-13 20:14:13 +01:00
LICENSE Cleanups, removing Caddy name a bit more 2016-03-19 07:42:21 +00:00
Makefile Make CoreDNS a server type plugin for Caddy (#220) 2016-08-19 17:14:17 -07:00
middleware.md Clean up some references to Caddy 2016-04-11 07:59:30 +01:00
plugin_generate.go Make CoreDNS a server type plugin for Caddy (#220) 2016-08-19 17:14:17 -07:00
README.md Make CoreDNS a server type plugin for Caddy (#220) 2016-08-19 17:14:17 -07:00

CoreDNS

CoreDNS is DNS server that started as a fork of Caddy. It has the same model: it chains middleware. In fact to similar that CoreDNS is now a server type plugin for CAddy, i.e. you'll need Caddy to compile CoreDNS.

CoreDNS is the successor of SkyDNS. SkyDNS is a thin layer that exposes services in etcd in the DNS. CoreDNS builds on this idea and is a generic DNS server that can talk to multiple backends (etcd, consul, kubernetes, etc.).

CoreDNS aims to be a fast and flexible DNS server. The keyword here is flexible, with CoreDNS you are able to do what you want with your DNS data. And if not: write a middleware!

Currently CoreDNS is able to:

  • Serve zone data from a file, both DNSSEC (NSEC only) and DNS is supported (middleware/file).
  • Retrieve zone data from primaries, i.e. act as a secondary server (AXFR only) (middleware/secondary).
  • Sign zone data on-the-fly (middleware/dnssec).
  • Loadbalancing of responses (middleware/loadbalance).
  • Allow for zone transfers, i.e. act as a primary server (middleware/file).
  • Caching (middleware/cache).
  • Health checking (middleware/health).
  • Use etcd as a backend, i.e. a 101.5% replacement for SkyDNS (middleware/etcd).
  • Use k8s (kubernetes) as a backend (middleware/kubernetes).
  • Serve as a proxy to forward queries to some other (recursive) nameserver (middleware/proxy).
  • Rewrite queries (both qtype, qclass and qname) (middleware/rewrite).
  • Provide metrics (by using Prometheus) (middleware/metrics).
  • Provide Logging (middleware/log).
  • Has support for the CH class: version.bind and friends (middleware/chaos).
  • Profiling support (middleware/pprof).

Status

I'm using CoreDNS is my primary, authoritative, nameserver for my domains (miek.nl, atoom.net and a few others). CoreDNS should be stable enough to provide you with a good DNS(SEC) service.

There are still few issues, and work is ongoing on making things fast and reduce the memory usage.

All in all, CoreDNS should be able to provide you with enough functionality to replace parts of BIND9, Knot, NSD or PowerDNS and SkyDNS. Most documentation is in the source and some blog articles can be found here. If you do want to use CoreDNS in production, please let us know and how we can help.

https://caddyserver.com/ is also full of examples on how to structure a Corefile (renamed from Caddyfile when I forked it).

Compilation

CoreDNS (as a servertype plugin for Caddy) has a hard dependency on Caddy - this is almost like the normal Go dependencies, but with a small twist, caddy (the source) need to know that CoreDNS exists and for this we need to add 1 line _ "github.com/miekg/coredns/core" to file in caddy.

You have the source of CoreDNS, this should preferably be downloaded under your $GOPATH. Get all dependencies:

go get ./...

Then, execute go generate, this will patch Caddy to add CoreDNS, and then go build as you would normally do:

go generate
go build

Should yield a coredns binary.

Examples

Start a simple proxy:

Corefile contains:

.:1053 {
    proxy . 8.8.8.8:53
}

Just start CoreDNS: ./coredns. And then just query on that port (1053), the query should be forwarded to 8.8.8.8 and the response will be returned.

Serve the (NSEC) DNSSEC signed miek.nl on port 1053, errors and logging to stdout. Allow zone transfers to everybody.

miek.nl:1053 {
    file /var/lib/bind/miek.nl.signed {
        transfer to *
    }
    errors stdout
    log stdout
}

Serve miek.nl on port 1053, but forward everything that does not match miek.nl to a recursive nameserver and rewrite ANY queries to HINFO.

.:1053 {
    rewrite ANY HINFO
    proxy . 8.8.8.8:53

    file /var/lib/bind/miek.nl.signed miek.nl {
        transfer to *
    }
    errors stdout
    log stdout
}

All the above examples are possible with the current CoreDNS.

What remains to be done

  • Optimizations.
  • Load testing.
  • The issues.

Blog and Contact

Website: https://coredns.io Twitter: @coredns.io Docs: https://miek.nl/tags/coredns/ Github: https://github.com/miekg/coredns

Systemd service file

Use this as a systemd service file. It defaults to a coredns wich a homedir of /home/coredns and the binary lives in /opt/bin:

[Unit]
Description=CoreDNS DNS server
Documentation=https://miek.nl/tags/coredns
After=network.target

[Service]
PermissionsStartOnly=true
PIDFile=/home/coredns/coredns.pid
LimitNOFILE=8192
User=coredns
WorkingDirectory=/home/coredns
ExecStartPre=/sbin/setcap cap_net_bind_service=+ep /opt/bin/coredns
ExecStart=/opt/bin/coredns -pidfile /home/coredns/coredns.pid -conf=/etc/coredns/Corefile
ExecReload=/bin/kill -SIGUSR1 $MAINPID
Restart=on-failure

[Install]
WantedBy=multi-user.target