dnscontrol/docs/_providers/bind.md
Tom Limoncelli 772ca4e7dd
Linting (#647)
* linting
* Fix adding-new-rtypes.md to include validation
* BIND: improve docs wrt SOA records, get-zones
2020-02-23 14:47:14 -05:00

2.2 KiB

name title layout jsId
BIND BIND Provider default BIND

BIND Provider

This provider maintains a directory with a collection of .zone files.

This provider does not generate or update the named.conf file, nor does it deploy the .zone files to the BIND master. Both of those tasks are different at each site, so they are best done by a locally-written script.

Configuration

The BIND provider does not require anything in creds.json. However you can specify a directory where the provider will look for and create zone files. The default is the zones directory (in the current directory).

{% highlight json %} { "bind": { "directory": "myzones" } } {% endhighlight %}

The BIND accepts some optional metadata via your DNS config when you create the provider:

In this example we set the default SOA settings and NS records.

{% highlight javascript %} var BIND = NewDnsProvider('bind', 'BIND', { 'default_soa': { 'master': 'ns1.example.tld.', 'mbox': 'sysadmin.example.tld.', 'refresh': 3600, 'retry': 600, 'expire': 604800, 'minttl': 1440, }, 'default_ns': [ 'ns1.example.tld.', 'ns2.example.tld.', 'ns3.example.tld.', 'ns4.example.tld.' ] }) {% endhighlight %}

FYI: get-zones

When used with "get-zones", specifying "all" scans the directory for any files named *.zone and assumes they are zone files.

dnscontrol get-zones --format=nameonly - BIND all

FYI: SOA Records

DNSControl assumes that SOA records are managed by the provider. Most providers simply generate the SOA record for you and do not permit you to control it at all. The BIND provider is unique in that it must emulate what most DNS-as-a-service providers do.

When DNSControl reads a BIND zonefile:

  • If there was no SOA record, one is created using the default_soa settings listed above.
  • When generating a new zonefile, the SOA serial number is updated.

DNSControl ties to maintain the serial number as yyyymmddvv. If the existing serial number is significantly higher it will simply increment the value by 1.

If you need to edit the SOA fields, the best way is to edit the zonefile directly, then run dnscontrol preview and dnscontrol push as normal.