feat(zones): skip on slave servers

Introduce 'nsd:opmode' pillar option, allowing the zone file management
to be skipped on slave DNS servers.

Signed-off-by: Georg Pfuetzenreuter <mail@georg-pfuetzenreuter.net>

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
         additional_dependencies: ['@commitlint/config-conventional@8.3.4']
         always_run: true
   - repo: https://github.com/rubocop-hq/rubocop
-    rev: v1.42.0
+    rev: v1.30.1
     hooks:
       - id: rubocop
         name: Check Ruby files with rubocop
@@ -38,14 +38,14 @@ repos:
         always_run: true
         pass_filenames: false
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: v0.9.0.2
+    rev: v0.8.0.4
     hooks:
       - id: shellcheck
         name: Check shell scripts with shellcheck
         files: ^.*\.(sh|bash|ksh)$
         types: []
   - repo: https://github.com/adrienverge/yamllint
-    rev: v1.28.0
+    rev: v1.26.3
     hooks:
       - id: yamllint
         name: Check YAML syntax with yamllint
@@ -58,8 +58,8 @@ repos:
       - id: salt-lint
         name: Check Salt files using salt-lint
         files: ^.*\.(sls|jinja|j2|tmpl|tst)$
-  - repo: https://github.com/rstcheck/rstcheck
-    rev: v6.1.1
+  - repo: https://github.com/myint/rstcheck
+    rev: 3f929574
     hooks:
       - id: rstcheck
         name: Check reST files using rstcheck

nsd/config/file.sls

@@ -4,6 +4,7 @@
 {#- Get the `tplroot` from `tpldir` #}
 {%- set tplroot = tpldir.split('/')[0] %}
 {%- set sls_package_install = tplroot ~ '.package.install' %}
+{%- from tplroot ~ "/macros.jinja" import config_file with context %}
 {%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %}
 {%- from tplroot ~ "/libtofs.jinja" import files_switch with context %}
 
@@ -28,3 +29,12 @@ nsd-config-file-file-managed:
     - context:
         nsd: {{ nsd | json }}
     - check_cmd: nsd-checkconf
+
+{%- set config_data = nsd.get('config_data', {}) %}
+
+{%- if config_data | length > 0 %}
+
+{{    config_file('10-salt', 'pillar-configuration') }}
+
+{%- endif %}
+

nsd/config/init.sls

@@ -6,3 +6,4 @@ include:
   - .config_files
   - .file
   - .zones
+  - .keys

nsd/config/keys.sls

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# vim: ft=sls
+
+{%- set tplroot = tpldir.split('/')[0] %}
+{%- from tplroot ~ "/map.jinja" import mapdata as nsd with context %}
+{%- from tplroot ~ "/macros.jinja" import config_file with context %}
+
+{%- set keys = nsd.get('keys', {}) %}
+
+{%- if keys | length > 0 %}
+
+{{    config_file('80-generated-keys', 'generated-keys') }}
+
+{%- endif %}

nsd/config/zones.sls

@@ -10,11 +10,14 @@
 {%- from tplroot ~ "/macros.jinja" import zonefile_name with context %}
 
 {%- set zones = nsd.get('zones', {}) %}
+{%- set opmode = nsd.get('opmode', 'master') %}
 
 {%- if zones | length > 0 %}
 
 {{    config_file('90-generated-zones', 'generated-zones') }}
 
+{%- if opmode == 'master' %}
+
 nsd-config-zones-file-directory:
   file.directory:
     - name: {{ nsd.zones_dir }}
@@ -28,10 +31,14 @@ nsd-config-zones-file-directory:
 "{{ identifier }}":
   file.managed:
     - name: "{{ nsd.zones_dir }}/{{ zonefile_name(name, config) }}"
+    {%- if 'zone_source' in config %}
+    - source: {{ config['zone_source'] }}
+    {%- else %}
     - source: {{ files_switch([template, template+'.jinja'],
                               lookup=identifier
                  )
               }}
+    {%- endif %}
     - mode: 644
     - user: root
     - group: {{ nsd.rootgroup }}
@@ -49,3 +56,4 @@ nsd-config-zones-file-directory:
 
 {%-   endfor %}
 {%- endif %}
+{%- endif %}

nsd/files/default/generated-keys.conf.jinja

@@ -0,0 +1,11 @@
+########################################################################
+# File managed by Salt at <{{ source }}>.
+# Your changes will be overwritten.
+########################################################################
+
+{%- for name, config in nsd.get('keys').items() %}
+key:
+  name: "{{ name }}"
+  algorithm: "{{ config['algorithm'] }}"
+  secret: "{{ config['secret'] }}"
+{%- endfor %}

nsd/files/default/generated-zones.conf.jinja

@@ -1,4 +1,5 @@
 {%- from "nsd/macros.jinja" import zonefile_name with context -%}
+{%- set extraopts = ['allow-notify', 'request-xfr', 'outgoing-interface'] -%}
 ########################################################################
 # File managed by Salt at <{{ source }}>.
 # Your changes will be overwritten.
@@ -8,4 +9,9 @@
 zone:
   name: "{{ name }}"
   zonefile: "{{ nsd.zones_dir }}/{{ zonefile_name(name, config) }}"
+  {%- for option in extraopts %}
+  {%- if option in config %}
+  {{ option }}: {{ config[option] }}
+  {%- endif %}
+  {%- endfor %}
 {%- endfor %}

nsd/files/default/pillar-configuration.conf.jinja

@@ -0,0 +1,12 @@
+{%- for category, config in nsd.get('config_data').items() %}
+{{ category }}:
+{%- for option, value in config.items() %}
+  {%- if value is string or value is number %}
+  {{ option }}: {{ value }}
+  {%- elif value is iterable %}
+  {%- for item in value %}
+  {{ option }}: {{ item }}
+  {%- endfor %}
+  {%- endif %}
+{%- endfor %}
+{%- endfor %}

nsd/macros.jinja

@@ -25,7 +25,6 @@
       - file: nsd-config-file-file-managed
     - context:
         nsd: {{ nsd | json }}
-    - check_cmd: nsd-checkconf
     - watch_in:
       - service: nsd-service-running-service-running
 {%- endmacro %}

pillar.example

@@ -17,9 +17,17 @@ nsd:
   # config_include_glob: *.conf
 
   # Configuration is separated into several files which have their own templates
-  config_files:
-    10-server: local-nsd-for-unbound
-    # 90-generated-zones is reserved for zones generated by this formula
+  # config_files:
+  #   10-server: local-nsd-for-unbound
+  #   # 90-generated-zones is reserved for zones generated by this formula
+  #   # 10-salt is reserved for general configuration generated by this formula
+
+  # If this section is present in your Pillar data,
+  # nsd.conf.d/80-generated-keys will be created and managed
+  keys:
+    examplekey:
+      algorithm: hmac-sha512
+      secret: encryptme
 
   # If this section is present in your Pillar data,
   # nsd.conf.d/90-generated-zones will be created and managed.
@@ -30,6 +38,30 @@ nsd:
     "168.192.in-addr.arpa": {}
     # NSD's include-pattern directive may be a better way to share configuration
     # across zones than using YAML anchors.
+    #
+    # You can load the zone file from a custom source and specify additional configuration options:
+    # example.com:
+    #   zone_source: salt://zones/example.com.zone
+    #   request-xfr: 192.168.0.1
+
+  # If this section is present in your Pillar data,
+  # nsd.conf.d/10-salt.conf will be created and managed
+  config_data:
+    server:
+      hide-version: 'yes'
+      ip-address: 127.0.0.1
+      # to use an option multiple times, make it a list:
+      # ip-address:
+      #   - 127.0.0.1
+      #   - 192.168.0.1
+      verbosity: 2
+      port: 53530
+    remote-control:
+      control-enable: 'yes'
+      control-interface: /run/nsd.sock
+
+  # If this option is defined and set to 'slave', no DNS zone files will be installed
+  # opmode: slave
 
   tofs:
     # The files_switch key serves as a selector for alternative

test/integration/default/files/_mapdata/debian-10.yaml

@@ -7,8 +7,15 @@ values:
   added_in_pillar: pillar_value
   arch: amd64
   config: /etc/nsd/nsd.conf
-  config_files:
-   10-server: local-nsd-for-unbound
+  config_data:
+    remote-control:
+      control-enable: 'yes'
+      control-interface: /run/nsd.sock
+    server:
+      hide-version: 'yes'
+      ip-address: 127.0.0.1
+      port: 53530
+      verbosity: 2
   config_include_dir: "/etc/nsd/nsd.conf.d"
   config_include_glob: "*.conf"
   lookup:

test/integration/default/files/_mapdata/debian-9.yaml

@@ -7,8 +7,15 @@ values:
   added_in_pillar: pillar_value
   arch: amd64
   config: /etc/nsd/nsd.conf
-  config_files:
-   10-server: local-nsd-for-unbound
+  config_data:
+    remote-control:
+      control-enable: 'yes'
+      control-interface: /run/nsd.sock
+    server:
+      hide-version: 'yes'
+      ip-address: 127.0.0.1
+      port: 53530
+      verbosity: 2
   config_include_dir: "/etc/nsd/nsd.conf.d"
   config_include_glob: "*.conf"
   lookup:

test/integration/default/files/_mapdata/opensuse-15.yaml

@@ -7,8 +7,15 @@ values:
   added_in_pillar: pillar_value
   arch: amd64
   config: /etc/nsd/nsd.conf
-  config_files:
-   10-server: local-nsd-for-unbound
+  config_data:
+    remote-control:
+      control-enable: 'yes'
+      control-interface: /run/nsd.sock
+    server:
+      hide-version: 'yes'
+      ip-address: 127.0.0.1
+      port: 53530
+      verbosity: 2
   config_include_dir: "/etc/nsd/nsd.conf.d"
   config_include_glob: "*.conf"
   lookup:

test/integration/default/files/_mapdata/opensuse-tumbleweed.yaml

@@ -7,8 +7,15 @@ values:
   added_in_pillar: pillar_value
   arch: amd64
   config: /etc/nsd/nsd.conf
-  config_files:
-   10-server: local-nsd-for-unbound
+  config_data:
+    remote-control:
+      control-enable: 'yes'
+      control-interface: /run/nsd.sock
+    server:
+      hide-version: 'yes'
+      ip-address: 127.0.0.1
+      port: 53530
+      verbosity: 2
   config_include_dir: "/etc/nsd/nsd.conf.d"
   config_include_glob: "*.conf"
   lookup: