Synchronize your DNS to multiple providers from a simple DSL
Find a file
Phil Pennock 9b239f41a3
Add AUTODNSSEC, implement for DNSimple (#640)
* Add AUTODNSSEC, implement for DNSimple

There are two models for DNSSEC in DNS management: either dnscontrol
manages all the DNSSEC records and has to be invoked regularly for
re-signing, or the provider manages DNSSEC automatically and dnscontrol
is not involved beyond saying "yeah, do that".

This implements the latter, as a model, and for one provider.

Potentially we could tune/configure options for DNSSEC such as
algorithm, but DNSimple don't expose that API so I haven't implemented
it.

This minimal model should be something which maps into other providers
cleanly.

* Fix missing CanAutoDNSSEC on provider

* Validation fix for master broken

This is broken in master and causing Travis in my branch to fail.  The
validation tool runs with `gofmt -s` to require "simplify", and so
rejects an ignored second bound variable to range iteration.

* Correct wire in the AUTODNSSEC validation step
2020-02-22 07:09:31 -05:00
build Add AUTODNSSEC, implement for DNSimple (#640) 2020-02-22 07:09:31 -05:00
cmd/convertzone Add "get-zone" command (#613) 2020-02-18 08:59:18 -05:00
commands get-zones: new output format nameonly; remove tsvfqdn (#644) 2020-02-21 14:59:47 -05:00
docs Add AUTODNSSEC, implement for DNSimple (#640) 2020-02-22 07:09:31 -05:00
integrationTest Remove test for empty TXT strings. (#633) 2020-02-18 15:24:04 -05:00
models Add AUTODNSSEC, implement for DNSimple (#640) 2020-02-22 07:09:31 -05:00
pkg Add AUTODNSSEC, implement for DNSimple (#640) 2020-02-22 07:09:31 -05:00
providers Add AUTODNSSEC, implement for DNSimple (#640) 2020-02-22 07:09:31 -05:00
vendor DNSimple: Implement GetZones and ListZones (#637) 2020-02-20 14:52:19 -05:00
.gitignore ignore nupkgs 2020-01-09 11:44:53 -05:00
.prettierrc Format helpers.js (#205) 2017-09-15 13:12:09 -04:00
.travis.yml Internals: Switch to v2 go.mod, drop GOPATH, and fix Azure Pipelines (#595) 2020-01-28 10:42:31 -05:00
azure-pipelines.yml Internals: Switch to v2 go.mod, drop GOPATH, and fix Azure Pipelines (#595) 2020-01-28 10:42:31 -05:00
build.ps1 Internals: Switch to v2 go.mod, drop GOPATH, and fix Azure Pipelines (#595) 2020-01-28 10:42:31 -05:00
dnscontrol.nuspec add chocolatey spec 2020-01-09 11:36:52 -05:00
Dockerfile Internals: Switch to v2 go.mod, drop GOPATH, and fix Azure Pipelines (#595) 2020-01-28 10:42:31 -05:00
go.mod DNSimple: Implement GetZones and ListZones (#637) 2020-02-20 14:52:19 -05:00
go.sum DNSimple: Implement GetZones and ListZones (#637) 2020-02-20 14:52:19 -05:00
LICENSE migrate code for github 2016-08-22 18:31:50 -06:00
main.go Internals: Switch to v2 go.mod, drop GOPATH, and fix Azure Pipelines (#595) 2020-01-28 10:42:31 -05:00
OWNERS NEW PROVIDER: Internet.bs (#590) 2020-01-27 08:25:20 -05:00
README.md NEW PROVIDER: Internet.bs (#590) 2020-01-27 08:25:20 -05:00

DNSControl

Build Status Gitter chat Google Group chat

DNSControl is a system for maintaining DNS zones. It has two parts: a domain specific language (DSL) for describing DNS zones plus software that processes the DSL and pushes the resulting zones to DNS providers such as Route53, Cloudflare, and Gandi. It can talk to Microsoft Active Directory and it generates the most beautiful BIND zone files ever. It runs anywhere Go runs (Linux, macOS, Windows). The provider model is extensible, so more providers can be added.

Currently supported DNS providers:

  • Active Directory
  • Azure DNS
  • BIND
  • Cloudflare
  • ClouDNS
  • DigitalOcean
  • DNSimple
  • Exoscale
  • Gandi
  • Google
  • HEXONET
  • Internet.bs
  • Linode
  • Namecheap
  • Name.com
  • NS1
  • Route 53
  • SoftLayer
  • Vultr
  • OVH

At Stack Overflow, we use this system to manage hundreds of domains and subdomains across multiple registrars and DNS providers.

You can think of it as a DNS compiler. The configuration files are written in a DSL that looks a lot like JavaScript. It is compiled to an intermediate representation (IR). Compiler back-ends use the IR to update your DNS zones on services such as Route53, Cloudflare, and Gandi, or systems such as BIND and Active Directory.

An Example

dnsconfig.js:

// define our registrar and providers
var namecom = NewRegistrar("name.com", "NAMEDOTCOM");
var r53 = NewDnsProvider("r53", "ROUTE53")

D("example.com", namecom, DnsProvider(r53),
  A("@", "1.2.3.4"),
  CNAME("www","@"),
  MX("@",5,"mail.myserver.com."),
  A("test", "5.6.7.8")
)

Running dnscontrol preview will talk to the providers (here name.com as registrar and route 53 as the dns host), and determine what changes need to be made.

Running dnscontrol push will make those changes with the provider and my dns records will be correctly updated.

See Getting Started page on documentation site.

Benefits

  • Editing zone files is error-prone. Clicking buttons on a web page is irreproducible.
  • Switching DNS providers becomes a no-brainer. The DNSControl language is vendor-agnostic. If you use it to maintain your DNS zone records, you can switch between DNS providers easily. In fact, DNSControl will upload your DNS records to multiple providers, which means you can test one while switching to another. We've switched providers 3 times in three years and we've never lost a DNS record.
  • Adopt CI/CD principles to DNS! At StackOverflow we maintain our DNSControl configurations in Git and use our CI system to roll out changes. Keeping DNS information in a VCS means we have full history. Using CI enables us to include unit-tests and system-tests. Remember when you forgot to include a "." at the end of an MX record? We haven't had that problem since we included a test to make sure Tom doesn't make that mistake... again.
  • Variables save time! Assign an IP address to a constant and use the variable name throughout the file. Need to change the IP address globally? Just change the variable and "recompile."
  • Macros! Define your SPF records, MX records, or other repeated data once and re-use them for all domains.
  • Control Cloudflare from a single location. Enable/disable Cloudflare proxying (the "orange cloud" button) directly from your DNSControl files.
  • Keep similar domains in sync with transforms and other features. If one domain is supposed to be the same
  • It is extendable! All the DNS providers are written as plugins. Writing new plugins is very easy.

Installation

From source

DNSControl can be built with Go version 1.10 or higher. To install, simply run

go get github.com/StackExchange/dnscontrol

dnscontrol should be installed in $GOPATH/bin

Via packages

Get prebuilt binaries from github releases

Alternatively, on Mac you can install it using homebrew:

brew install dnscontrol

Via docker

docker run --rm -it -v $(pwd)/dnsconfig.js:/dns/dnsconfig.js -v $(pwd)/creds.json:/dns/creds.json stackexchange/dnscontrol dnscontrol preview