Go Other
Clone or download
Latest commit 6d8a078 Aug 14, 2018
Permalink
Failed to load latest commit information.
.github Update the pr template (#1862) Jun 7, 2018
.presubmit Make presubmit actually fail the build (#2013) Jul 30, 2018
core Test cases for address normalization with specified protocols (#1993) Jul 21, 2018
coremain Typo fixes (#2031) Aug 14, 2018
man fixed typo in kubernetes plugin man page and README. (#2014) Jul 30, 2018
pb Watch feature (#1527) Jun 27, 2018
plugin Typo fixes (#2031) Aug 14, 2018
request Typo fixes (#2031) Aug 14, 2018
test Typo fixes (#2031) Aug 14, 2018
vendor Update k8s client-go to v8.0.0 (#1922) Jul 1, 2018
.codecov.yml Increase codecov target requirement to 50% (from 40%) (#1344) Jan 3, 2018
.dockerignore dockerignore: ignore .git (#1723) Apr 24, 2018
.gitignore Add debug.Hexdump (#1902) Jul 4, 2018
.stickler.yml Add stickler config (#2009) Jul 27, 2018
.travis.yml plugin/etcdv3: Add etcd v3 plugin (#1702) Jun 30, 2018
ADOPTERS.md - surver for "CoreDNS Adoption" is out since one week. on 3 of 15 rep… Aug 7, 2018
CODE-OF-CONDUCT.md Add CNCF Code of Conduct (#565) Mar 3, 2017
CONTRIBUTING.md Fix saying (#1225) Nov 13, 2017
Dockerfile Docker: drop alpine (#1843) Jun 4, 2018
Gopkg.lock Update k8s client-go to v8.0.0 (#1922) Jul 1, 2018
Gopkg.toml Update k8s client-go to v8.0.0 (#1922) Jul 1, 2018
LICENSE Cleanups, removing Caddy name a bit more Mar 19, 2016
Makefile Make presubmit actually fail the build (#2013) Jul 30, 2018
Makefile.doc Run make -f Makefile.doc (#1875) Jun 13, 2018
Makefile.fuzz fuzz: put fuzzing stuff in own build tag (#1215) Nov 10, 2017
Makefile.release Add exe extension to Windows release binary (#2022) Aug 3, 2018
OWNERS release: automate the release (#1935) Jul 10, 2018
README.md Typo fixes (#2031) Aug 14, 2018
coredns.1.md Run make -f Makefile.doc (#1875) Jun 13, 2018
coredns.go Enhancement of external plugin enabling (#1392) Jan 15, 2018
corefile.5.md Typo fixes (#2031) Aug 14, 2018
directives_generate.go Enhancement of external plugin enabling (#1392) Jan 15, 2018
plugin.cfg New plugin: loop (#1989) Jul 20, 2018
plugin.md Use logging (#1718) Apr 22, 2018

README.md

CoreDNS

Documentation Build Status Code Coverage Docker Pulls Go Report Card CII Best Practices

Feedback wanted ...

CoreDNS is now part of Kubernetes, delivering the DNS and Discovery Service for the cluster. If you are currently using CoreDNS inside a Kubernetes cluster, please, take 5 minutes to provide us some feedback by filling this survey

Thank you, we appreciate your collaboration here.

CoreDNS

CoreDNS (written in Go) chains plugins. Each plugin performs a DNS function.

CoreDNS is a Cloud Native Computing Foundation incubating level project.

CoreDNS is 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 by utilizing plugins. If some functionality is not provided out of the box you can add it by writing a plugin.

CoreDNS can listen for DNS request coming in over UDP/TCP (go'old DNS), TLS (RFC 7858) and gRPC (not a standard).

Currently CoreDNS is able to:

  • Serve zone data from a file; both DNSSEC (NSEC only) and DNS are supported (file).
  • Retrieve zone data from primaries, i.e., act as a secondary server (AXFR only) (secondary).
  • Sign zone data on-the-fly (dnssec).
  • Load balancing of responses (loadbalance).
  • Allow for zone transfers, i.e., act as a primary server (file).
  • Automatically load zone files from disk (auto).
  • Caching (cache).
  • Use etcd as a backend (replace SkyDNS) (etcd).
  • Use k8s (kubernetes) as a backend (kubernetes).
  • Serve as a proxy to forward queries to some other (recursive) nameserver (proxy, and forward).
  • Provide metrics (by using Prometheus) (metrics).
  • Provide query (log) and error (errors) logging.
  • Support the CH class: version.bind and friends (chaos).
  • Support the RFC 5001 DNS name server identifier (NSID) option (nsid).
  • Profiling support (pprof).
  • Rewrite queries (qtype, qclass and qname) (rewrite and template).

And more. Each of the plugins is documented. See coredns.io/plugins for all in-tree plugins, and coredns.io/explugins for all out-of-tree plugins.

Compilation from Source

Check out the project and do dependency resolution with:

% go get github.com/coredns/coredns

Some of the dependencies require Go version 1.9 or later.

We vendor most (not all!) packages. Building from scratch is easiest, by just using make:

% make

This should yield a coredns binary.

Compilation with Docker

CoreDNS requires Go to compile. However, if you already have docker installed and prefer not to setup a Go environment, you could build CoreDNS easily:

$ docker run --rm -i -t -v $PWD:/go/src/github.com/coredns/coredns \
      -w /go/src/github.com/coredns/coredns golang:1.10 make

The above command alone will have coredns binary generated.

Examples

When starting CoreDNS without any configuration, it loads the whoami plugin and starts listening on port 53 (override with -dns.port), it should show the following:

.:53
2016/09/18 09:20:50 [INFO] CoreDNS-001
CoreDNS-001

Any query send to port 53 should return some information; your sending address, port and protocol used.

If you have a Corefile without a port number specified it will, by default, use port 53, but you can override the port with the -dns.port flag:

./coredns -dns.port 1053, runs the server on port 1053.

Start a simple proxy, you'll need to be root to start listening on port 53.

Corefile contains:

.:53 {
    forward . 8.8.8.8:53
    log
}

Just start CoreDNS: ./coredns. Then just query on that port (53). The query should be forwarded to 8.8.8.8 and the response will be returned. Each query should also show up in the log which is printed on standard output.

Serve the (NSEC) DNSSEC-signed example.org on port 1053, with errors and logging sent to standard output. Allow zone transfers to everybody, but specifically mention 1 IP address so that CoreDNS can send notifies to it.

example.org:1053 {
    file /var/lib/coredns/example.org.signed {
        transfer to *
        transfer to 2001:500:8f::53
    }
    errors
    log
}

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

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

    file /var/lib/coredns/example.org.signed example.org {
        transfer to *
        transfer to 2001:500:8f::53
    }
    errors
    log
}

IP addresses are also allowed. They are automatically converted to reverse zones:

10.0.0.0/24 {
    whoami
}

Means you are authoritative for 0.0.10.in-addr.arpa..

This also works for IPv6 addresses. If for some reason you want to serve a zone named 10.0.0.0/24 add the closing dot: 10.0.0.0/24. as this also stops the conversion.

This even works for CIDR (See RFC 1518 and 1519) addressing, i.e. 10.0.0.0/25, CoreDNS will then check if the in-addr request falls in the correct range.

Listening on TLS and for gRPC? Use:

tls://example.org grpc://example.org {
    whoami
}

Specifying ports works in the same way:

grpc://example.org:1443 {
    # ...
}

When no transport protocol is specified the default dns:// is assumed.

Community

We're most active on Slack (and Github):

More resources can be found:

Deployment

Examples for deployment via systemd and other use cases can be found in the deployment repository.

Security

If you find a security vulnerability or any security related issues, please DO NOT file a public issue, instead send your report privately to security@coredns.io. Security reports are greatly appreciated and we will publicly thank you for it.