disable the chatty query channel
[docker_bind.git] / README.md
1 # zeke.ecotroph.net DNS service
2
3 This repo and directory consists of the revamped DNS service for zeke.ecotroph.net.  The goals of this service are:
4
5 1. Host the primary zones we want.
6 2. DNSSEC-sign those primary zones, if desired.
7 3. Provide local recursive service for the host itself.
8
9 ## Overview
10
11 In the past, we just ran the version of BIND that came with our distribution (at this moment, that is CentOS 7, which translates to bind 9.11.)  This new configuration runs a recent very version of BIND 9 via a docker image produced by ISC themselves.  We are staring with 9.18.12.
12
13 This docker image imposes a few requirements:
14
15 * Interally, the image runs `named` as the `bind` user, (104:105) by default.  Since we bind-mount directories, we do need those directories owned by whatever internal UID it is using.
16 * We need some way to ensure that our container is run on system reboots, etc.  Here we chose to use `systemd` to do this, although that is not ideal.
17 * Presumably the normal way to do logging for a docker container is to use the standard journal service, however, this image is set up to bind-mount `/var/log` anyway.  On the other hand, the standard command uses the `-g` flag, which is "debug" mode, and causes all of the logs to go to stderr.
18 * We do want named to stay in the foreground here.  Fortunately, there have always been command line options that do this (`-g` and `-f`).
19
20 ## Source
21
22 I have this in a local git repository on zeke, however we can see it (sort of) here: <https://blacka.com/cgit/docker_bind.git/tree/> (athough the viewer here is subject to change, and when that does, the URL will change.)
23
24 ## Design
25
26 We have in this repo:
27
28 * named configurations.  I've broken this up into sections (options, keys, logging, primary, secondary, etc.), which all just get included in the primary named.conf.  It isn't tricky.
29 * "keys".  Well, mostly TSIG keys.  Those are are but are encrypted with `git-crypt`.  With a key that is ... somewhere.  I've saved it in my password manager, but it can be extracted from the current checkout in `/etc/bind` with `cd /etc/bind; git-crypt export-key /tmp/docker_bind_crypto.key`.
30 * zone files.  I have all of the zone files we started with, although currently the configuration does not load all of them.
31 * A script to launch the container (`run_bind_container.sh`).
32 * A script to use as the internal "command" (`cfg/run.sh`) -- it isn't config, but we need to bind-mount it.
33 * A helper script to run `rndc` that just runs that inside the container itself (via a docker exec).  You would need to be in the `docker` group to run it.  Another helper script to run `named-checkconf`.
34 * A helper script to prepare zeke to run this container and properly work, in case we want to do this install again (`setup.sh`).
35
36 ## Installation
37
38 1. Clone this repo to `/etc/bind` (clone in `/etc` -- we want the working copy to *be* `/etc/bind`.)
39 2. Create a user to match the internal user (uid 104): `useradd -u 104 -g 105 -M --no-log-init bind`
40 3. Change the ownership of everything under `/etc/bind` to the `bind` user and group: `chown -R 104:105 /etc/bind`.
41 3. Copy the supplied systemd unit file to /etc/systemd/system, and `systemctl enable docker.bind.service`, then `systemctl start docker.bind.service`.
42
43 ## Zone Changes
44
45 All of our zone files are now in this git repo, so we can just make changes and commit them, assuming you have write access to the local repo, that is.  The `bind` user should be able to do it, though.  Once you've changed your zone, you *could* bounce the service via systemctl, or we could use `rndc`.  I've made a little script that will do this with `docker exec`, `/etc/bind/run_rndc.sh`.  Thus:
46
47 ```bash
48 sudo -u bind -s
49 cd /etc/bind/zones
50 vi <zonefile> # remember to update the serial
51 git commit -a <zonefile>
52 git push
53 cd ..
54 ./run_rndc.sh reload <zone>
55 ```
56
57 ## DNSSEC
58
59 More modern BIND releases have changed the configuration for this.  Now, *how* your zone is signed is based on a `dnssec-policy` block (I've put those in `cfg/named.dnssec.conf`).  Then, in your zone, you add:
60
61 ```
62   dnssec-policy "default_alg13";
63   inline-signing yes;
64 ```
65
66 in your zone block.  After restarting/reconfiguring BIND, it will create a <zonefile>.signed and <zonefile>.signed.jnl file, and start serving a DNSSEC signed version of the zone.  It will then take care of resigning activities, key rollovers etc.