feat(bind9): support systemd drop-ins

Keep role configuration namespaced and allow hosts to customize systemd startup.

Co-authored-by: Copilot <copilot@github.com>

defaults/main.yaml

@@ -110,6 +110,10 @@ bind9_statics:
     acls:
     - "localhost"
 
+bind9_systemd_dropin: ~
+# [Service]
+# ExecStart=
+# ExecStart={{ bind9_binary }} -f -u {{ bind9_unix_user }} -4
 
 bind9_tsigkeys: []
 # - name: "name"

handlers/main.yaml

@@ -2,6 +2,6 @@
 
 - name: Restart named
   ansible.builtin.systemd:
-    name: "{{ bind_service_name }}"
+    name: "{{ bind9_service_name }}"
     state: restarted
     daemon_reload: true

tasks/create_dnssec_files.yaml

@@ -4,8 +4,8 @@
   ansible.builtin.copy:
     dest: "{{ item.private.filename }}"
     content: "{{ item.private.content }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0600"
   no_log: true
   with_items:
@@ -16,8 +16,8 @@
   ansible.builtin.copy:
     dest: "{{ item.public.filename }}"
     content: "{{ item.public.content }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0644"
   no_log: true
   with_items:

tasks/main.yaml

@@ -17,22 +17,22 @@
   ansible.builtin.package:
     name: "{{ item }}"
     state: present
-  with_items: "{{ bind_package_names }}"
+  with_items: "{{ bind9_package_names }}"
 
 - name: Create logging directory
   ansible.builtin.file:
-    path: "{{ bind_log_directory }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    path: "{{ bind9_log_directory }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0755"
     state: directory
     recurse: true
 
 - name: Create config directory
   ansible.builtin.file:
-    path: "{{ bind_config_directory }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    path: "{{ bind9_config_directory }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0755"
     state: directory
     recurse: true
@@ -41,7 +41,7 @@
   block:
   - name: Find existing journal files
     ansible.builtin.find:
-      path: "{{ bind_config_directory }}"
+      path: "{{ bind9_config_directory }}"
       recurse: true
       patterns: "*.jnl"
     register: files_to_delete
@@ -55,7 +55,7 @@
   block:
   - name: Find existing signed zone files
     ansible.builtin.find:
-      path: "{{ bind_config_directory }}"
+      path: "{{ bind9_config_directory }}"
       recurse: true
       patterns: "*.signed"
     register: files_to_delete
@@ -80,8 +80,8 @@
 - name: Create DNSSEC key directory
   ansible.builtin.file:
     path: "{{ bind9_options.key_directory }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0700"
     state: directory
 
@@ -102,18 +102,18 @@
 - name: Create main configuration file
   ansible.builtin.template:
     src: "etc/named.conf.j2"
-    dest: "{{ bind_main_config }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    dest: "{{ bind9_main_config }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0644"
   notify: Restart named
 
 - name: Create excluded configuration files
   ansible.builtin.template:
     src: "{{ item }}.j2"
-    dest: "{{ item | replace('etc/named', bind_config_directory) }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    dest: "{{ item | replace('etc/named', bind9_config_directory) }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0644"
   with_items:
   - etc/named.conf
@@ -124,9 +124,45 @@
   - etc/named/named.conf.views
   notify: Restart named
 
+- name: Create systemd drop-in
+  when: bind9_systemd_dropin | default('', true) | length > 0
+  block:
+  - name: Create systemd drop-in directory
+    ansible.builtin.file:
+      path: "{{ bind9_systemd_dropin_dir }}"
+      owner: "root"
+      group: "root"
+      mode: "0755"
+      state: "directory"
+  - name: Template systemd drop-in
+    ansible.builtin.template:
+      src: etc/systemd/system/named.service.d/override.conf.j2
+      dest: "{{ bind9_systemd_dropin_dir }}/override.conf"
+      owner: "root"
+      group: "root"
+      mode: "0644"
+    register: _bind9_systemd_drop_in
+  - name: Systemd reload
+    ansible.builtin.systemd:
+      daemon_reload: true
+    when: _bind9_systemd_drop_in.changed
+
+- name: Remove systemd drop-in
+  when: bind9_systemd_dropin | default('', true) | length == 0
+  block:
+  - name: Remove systemd drop-in file
+    ansible.builtin.file:
+      path: "{{ bind9_systemd_dropin_dir }}/override.conf"
+      state: "absent"
+    register: _bind9_systemd_drop_in
+  - name: Systemd reload
+    ansible.builtin.systemd:
+      daemon_reload: true
+    when: _bind9_systemd_drop_in.changed
+
 - name: Start and enabled named
   ansible.builtin.systemd:
-    name: named
+    name: "{{ bind9_service_name }}"
     state: started
     enabled: true
 
@@ -134,8 +170,8 @@
   ansible.builtin.template:
     src: etc/rndc.key.j2
     dest: /etc/rndc.key
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0600"
   when: bind9_rndc_key.name | length > 0 and
         bind9_rndc_key.algorithm | length > 0 and

tasks/sign_zone_file.yaml

@@ -15,14 +15,14 @@
       _dnssec_cmd: "{{ dnssec_cmd + ['-o', zone.config.origin] }}"
   - name: "Extend dnssec command of zone file"
     ansible.builtin.set_fact:
-      _dnssec_cmd: "{{ _dnssec_cmd + [bind_config_directory + '/' + zone.file] }}"
+      _dnssec_cmd: "{{ _dnssec_cmd + [bind9_config_directory + '/' + zone.file] }}"
   - name: "Sign zone {{ zone.config.origin }}"
     ansible.builtin.command:
       argv: "{{ _dnssec_cmd }}"
-      creates: "{{ bind_config_directory + '/' + zone.file }}.signed"
+      creates: "{{ bind9_config_directory + '/' + zone.file }}.signed"
   - name: Adapt signed zone file permissions
     ansible.builtin.file:
-      path: "{{ bind_config_directory + '/' + zone.file }}.signed"
-      owner: "{{ bind_unix_user }}"
-      group: "{{ bind_unix_group }}"
+      path: "{{ bind9_config_directory + '/' + zone.file }}.signed"
+      owner: "{{ bind9_unix_user }}"
+      group: "{{ bind9_unix_group }}"
       mode: "0644"

tasks/template_zone_files.yaml

@@ -2,9 +2,9 @@
 
 - name: "Create config directory of DNS zones"
   ansible.builtin.file:
-    path: "{{ bind_config_directory }}/{{ zone.file | dirname }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    path: "{{ bind9_config_directory }}/{{ zone.file | dirname }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0755"
     state: directory
   with_items:
@@ -17,9 +17,9 @@
 - name: "Template view {{ view.name }}"
   ansible.builtin.template:
     src: "{{ inventory_hostname }}/etc/named/{{ zone.file }}.j2"
-    dest: "{{ bind_config_directory + '/' + zone.file }}"
-    owner: "{{ bind_unix_user }}"
-    group: "{{ bind_unix_group }}"
+    dest: "{{ bind9_config_directory + '/' + zone.file }}"
+    owner: "{{ bind9_unix_user }}"
+    group: "{{ bind9_unix_group }}"
     mode: "0644"
   with_items:
   - "{{ view.zones }}"

tasks/verify_zone_file.yaml

@@ -2,12 +2,12 @@
 
 - name: "Read the last character of DNS zone: {{ zone.config.origin }}"
   ansible.builtin.command:
-    cmd: "tail --bytes 1 {{ bind_config_directory + '/' + zone.file }}"
+    cmd: "tail --bytes 1 {{ bind9_config_directory + '/' + zone.file }}"
   register: _bind9_zone_last_character
   changed_when: _bind9_zone_last_character.rc == 0
   failed_when: _bind9_zone_last_character.rc > 0
 
-- name: "Fail when the last character of DNS zone file is not a newline: {{ bind_config_directory + '/' + zone.file }}"
+- name: "Fail when the last character of DNS zone file is not a newline: {{ bind9_config_directory + '/' + zone.file }}"
   ansible.builtin.fail:
-    msg: "Last character of DNS zone file is not a newline: {{ bind_config_directory + '/' + zone.file }}"
+    msg: "Last character of DNS zone file is not a newline: {{ bind9_config_directory + '/' + zone.file }}"
   when: _bind9_zone_last_character.stdout != ''

templates/etc/named.conf.j2

@@ -7,8 +7,8 @@
 #   file "named.ca";
 # };
 
-include "{{ bind_config_directory }}/named.conf.acl";
-include "{{ bind_config_directory }}/named.conf.logging";
-include "{{ bind_config_directory }}/named.conf.options";
-include "{{ bind_config_directory }}/named.conf.tsigkeys";
-include "{{ bind_config_directory }}/named.conf.views";
+include "{{ bind9_config_directory }}/named.conf.acl";
+include "{{ bind9_config_directory }}/named.conf.logging";
+include "{{ bind9_config_directory }}/named.conf.options";
+include "{{ bind9_config_directory }}/named.conf.tsigkeys";
+include "{{ bind9_config_directory }}/named.conf.views";

templates/etc/named/named.conf.options.j2

@@ -184,7 +184,7 @@ options {
   # allow-update-forwarding {};
 {% endif %}
 
-  directory "{{ bind_config_directory }}";
+  directory "{{ bind9_config_directory }}";
 
   # This accepts expired signatures when verifying DNSSEC signatures. The default is no. Setting this option to yes
   # leaves named vulnerable to replay attacks.

templates/etc/named/named.conf.views.j2

@@ -148,11 +148,11 @@ view "{{ view.name }}" {
     #   contact the Master, ffor whatever reason, the zone may be left with
     #   no effective Authoritative Name Servers.
 {% if zone.file is defined and zone.file | length > 0 and not zone.file.startswith('/') %}
-    file "{{ bind_config_directory }}/{{ zone.config.file }}";
+    file "{{ bind9_config_directory }}/{{ zone.config.file }}";
 {% elif zone.file is defined and zone.file | length > 0 and zone.file.startswith('/')%}
     file "{{ zone.config.file }}";
 {% else %}
-    # file "{{ bind_config_directory }}/...";
+    # file "{{ bind9_config_directory }}/...";
 {% endif %}
 
     # This option is only meaningful if the forwarders list is not empty. A

templates/etc/systemd/system/named.service.d/override.conf.j2

@@ -0,0 +1,4 @@
+#
+# {{ ansible_managed }}
+#
+{{ bind9_systemd_dropin }}

vars/Archlinux.yaml

@@ -1,13 +1,16 @@
 ---
 
-bind_main_config: /etc/named.conf
-bind_config_directory: /etc/named
-bind_log_directory: /var/log/named
+bind9_binary: /usr/bin/named
 
-bind_package_names:
+bind9_main_config: /etc/named.conf
+bind9_config_directory: /etc/named
+bind9_log_directory: /var/log/named
+
+bind9_package_names:
 - bind
 
-bind_service_name: named
+bind9_service_name: named
+bind9_systemd_dropin_dir: "/etc/systemd/system/{{ bind9_service_name }}.service.d"
 
-bind_unix_user: named
-bind_unix_group: named
+bind9_unix_user: named
+bind9_unix_group: named

vars/Debian.yaml

@@ -1,13 +1,16 @@
 ---
 
-bind_main_config: /etc/bind/named.conf
-bind_config_directory: /etc/bind
-bind_log_directory: /var/log/bind
+bind9_binary: /usr/sbin/named
 
-bind_package_names:
+bind9_main_config: /etc/bind/named.conf
+bind9_config_directory: /etc/bind
+bind9_log_directory: /var/log/bind
+
+bind9_package_names:
 - bind9
 
-bind_service_name: named
+bind9_service_name: named
+bind9_systemd_dropin_dir: "/etc/systemd/system/{{ bind9_service_name }}.service.d"
 
-bind_unix_user: bind
-bind_unix_group: bind
+bind9_unix_user: bind
+bind9_unix_group: bind

vars/RedHat.yaml

@@ -1,14 +1,17 @@
 ---
 
-bind_main_config: /etc/named.conf
-bind_config_directory: /etc/named
-bind_log_directory: /var/log/named
+bind9_binary: /usr/sbin/named
 
-bind_package_names:
+bind9_main_config: /etc/named.conf
+bind9_config_directory: /etc/named
+bind9_log_directory: /var/log/named
+
+bind9_package_names:
 - bind
 - bind-utils # for dig and tsig-keygen and so on
 
-bind_service_name: named
+bind9_service_name: named
+bind9_systemd_dropin_dir: "/etc/systemd/system/{{ bind9_service_name }}.service.d"
 
-bind_unix_user: named
-bind_unix_group: named
+bind9_unix_user: named
+bind9_unix_group: named