70ce16ff23
According to the RFC, the way to indicate that a SRV has no target is to set the target to ".". Some providers do not handle this, or the API returns "" instead of ".". This situation is now tested in the integration tests and all providers (that support this) have been fixed. * Cloudflare: Fix decoding empty SRV target (fixes #561) SRV records with empty (".") targets are now returned as false by the API, which breaks Unmarshaling it into a string. * Use custom type for Cloudflare SRV target Rewrote the SRV target decoding to use a custom type for (un)marshaling, as Cloudflare returns false for null targets, but it requires a single period for giving it one. The target code has also been made more flexible to future API changes with additional normalization. This has been tested with record creation, deletion, and update and works as of 2019-11-05. * DigitalOcean: Fix target FQDN for null targets Without this, dnscontrol thinks an update is needed (.. != .) even when the SRV target is correct. * DNSimple: Fix parsing of null SRV target DNSimple only returns two fields when the target is null. * NameDotCom: Add note about not supporting null SRV targets, skip test * DNSimple: Do not append a . unless we have all three parts Signed-off-by: Amelia Aronsohn <squirrel@wearing.black> * Regenerated provider matrix |
||
|---|---|---|
| build | ||
| cmd/convertzone | ||
| commands | ||
| docs | ||
| integrationTest | ||
| models | ||
| pkg | ||
| providers | ||
| vendor | ||
| .gitignore | ||
| .prettierrc | ||
| .travis.yml | ||
| azure-pipelines.yml | ||
| build.ps1 | ||
| Dockerfile | ||
| LICENSE | ||
| main.go | ||
| OWNERS | ||
| README.md | ||
DNSControl
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
- DigitalOcean
- DNSimple
- Exoscale
- Gandi
- HEXONET
- 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