Merge pull request #81460 from vcunat/p/knot-nixConfig

nixos/knot: allow full configuration by nix values

Changed files
+207 -92
nixos
doc
manual
release-notes
modules
services
networking
tests
+2
nixos/doc/manual/release-notes/rl-2311.section.md
···
- `pass` now does not contain `password-store.el`. Users should get `password-store.el` from Emacs lisp package set `emacs.pkgs.password-store`.
+
- `services.knot` now supports `.settings` from RFC42. The change is not 100% compatible with the previous `.extraConfig`.
+
- `mu` now does not install `mu4e` files by default. Users should get `mu4e` from Emacs lisp package set `emacs.pkgs.mu4e`.
- `mariadb` now defaults to `mariadb_1011` instead of `mariadb_106`, meaning the default version was upgraded from 10.6.x to 10.11.x. See the [upgrade notes](https://mariadb.com/kb/en/upgrading-from-mariadb-10-6-to-mariadb-10-11/) for potential issues.
+125 -7
nixos/modules/services/networking/knot.nix
···
let
cfg = config.services.knot;
-
configFile = pkgs.writeTextFile {
+
yamlConfig = let
+
result = assert secsCheck; nix2yaml cfg.settings;
+
+
secAllow = n: hasPrefix "mod-" n || elem n [
+
"module"
+
"server" "xdp" "control"
+
"log"
+
"statistics" "database"
+
"keystore" "key" "remote" "remotes" "acl" "submission" "policy"
+
"template"
+
"zone"
+
"include"
+
];
+
secsCheck = let
+
secsBad = filter (n: !secAllow n) (attrNames cfg.settings);
+
in if secsBad == [] then true else throw
+
("services.knot.settings contains unknown sections: " + toString secsBad);
+
+
nix2yaml = nix_def: concatStrings (
+
# We output the config section in the upstream-mandated order.
+
# Ordering is important due to forward-references not being allowed.
+
# See definition of conf_export and 'const yp_item_t conf_schema'
+
# upstream for reference. Last updated for 3.3.
+
# When changing the set of sections, also update secAllow above.
+
[ (sec_list_fa "id" nix_def "module") ]
+
++ map (sec_plain nix_def)
+
[ "server" "xdp" "control" ]
+
++ [ (sec_list_fa "target" nix_def "log") ]
+
++ map (sec_plain nix_def)
+
[ "statistics" "database" ]
+
++ map (sec_list_fa "id" nix_def)
+
[ "keystore" "key" "remote" "remotes" "acl" "submission" "policy" ]
+
+
# Export module sections before the template section.
+
++ map (sec_list_fa "id" nix_def) (filter (hasPrefix "mod-") (attrNames nix_def))
+
+
++ [ (sec_list_fa "id" nix_def "template") ]
+
++ [ (sec_list_fa "domain" nix_def "zone") ]
+
++ [ (sec_plain nix_def "include") ]
+
);
+
+
# A plain section contains directly attributes (we don't really check that ATM).
+
sec_plain = nix_def: sec_name: if !hasAttr sec_name nix_def then "" else
+
n2y "" { ${sec_name} = nix_def.${sec_name}; };
+
+
# This section contains a list of attribute sets. In each of the sets
+
# there's an attribute (`fa_name`, typically "id") that must exist and come first.
+
# Alternatively we support using attribute sets instead of lists; example diff:
+
# -template = [ { id = "default"; /* other attributes */ } { id = "foo"; } ]
+
# +template = { default = { /* those attributes */ }; foo = { }; }
+
sec_list_fa = fa_name: nix_def: sec_name: if !hasAttr sec_name nix_def then "" else
+
let
+
elem2yaml = fa_val: other_attrs:
+
" - " + n2y "" { ${fa_name} = fa_val; }
+
+ " " + n2y " " other_attrs
+
+ "\n";
+
sec = nix_def.${sec_name};
+
in
+
sec_name + ":\n" +
+
(if isList sec
+
then flip concatMapStrings sec
+
(elem: elem2yaml elem.${fa_name} (removeAttrs elem [ fa_name ]))
+
else concatStrings (mapAttrsToList elem2yaml sec)
+
);
+
+
# This convertor doesn't care about ordering of attributes.
+
# TODO: it could probably be simplified even more, now that it's not
+
# to be used directly, but we might want some other tweaks, too.
+
n2y = indent: val:
+
if doRecurse val then concatStringsSep "\n${indent}"
+
(mapAttrsToList
+
# This is a bit wacky - set directly under a set would start on bad indent,
+
# so we start those on a new line, but not other types of attribute values.
+
(aname: aval: "${aname}:${if doRecurse aval then "\n${indent} " else " "}"
+
+ n2y (indent + " ") aval)
+
val
+
)
+
+ "\n"
+
else
+
/*
+
if isList val && stringLength indent < 4 then concatMapStrings
+
(elem: "\n${indent}- " + n2y (indent + " ") elem)
+
val
+
else
+
*/
+
if isList val /* and long indent */ then
+
"[ " + concatMapStringsSep ", " quoteString val + " ]" else
+
if isBool val then (if val then "on" else "off") else
+
quoteString val;
+
+
# We don't want paths like ./my-zone.txt be converted to plain strings.
+
quoteString = s: ''"${if builtins.typeOf s == "path" then s else toString s}"'';
+
# We don't want to walk the insides of derivation attributes.
+
doRecurse = val: isAttrs val && !isDerivation val;
+
+
in result;
+
+
configFile = if cfg.settingsFile != null then
+
assert cfg.settings == {} && cfg.keyFiles == [];
+
cfg.settingsFile
+
else pkgs.writeTextFile {
name = "knot.conf";
-
text = (concatMapStringsSep "\n" (file: "include: ${file}") cfg.keyFiles) + "\n" +
-
cfg.extraConfig;
+
text = (concatMapStringsSep "\n" (file: "include: ${file}") cfg.keyFiles) + "\n" + yamlConfig;
+
# TODO: maybe we could do some checks even when private keys complicate this?
checkPhase = lib.optionalString (cfg.keyFiles == []) ''
${cfg.package}/bin/knotc --config=$out conf-check
'';
···
'';
};
-
extraConfig = mkOption {
-
type = types.lines;
-
default = "";
+
settings = mkOption {
+
type = types.attrs;
+
default = {};
description = lib.mdDoc ''
-
Extra lines to be added verbatim to knot.conf
+
Extra configuration as nix values.
+
'';
+
};
+
+
settingsFile = mkOption {
+
type = types.nullOr types.path;
+
default = null;
+
description = lib.mdDoc ''
+
As alternative to ``settings``, you can provide whole configuration
+
directly in the almost-YAML format of Knot DNS.
+
You might want to utilize ``writeTextFile`` for this.
'';
};
···
};
};
};
+
imports = [
+
# Compatibility with NixOS 23.05. At least partial, as it fails assert if used with keyFiles.
+
(mkChangedOptionModule [ "services" "knot" "extraConfig" ] [ "services" "knot" "settingsFile" ]
+
(config: pkgs.writeText "knot.conf" config.services.knot.extraConfig)
+
)
+
];
config = mkIf config.services.knot.enable {
users.groups.knot = {};
···
group = "knot";
description = "Knot daemon user";
};
+
+
environment.etc."knot/knot.conf".source = configFile; # just for user's convenience
systemd.services.knot = {
unitConfig.Documentation = "man:knotd(8) man:knot.conf(5) man:knotc(8) https://www.knot-dns.cz/docs/${cfg.package.version}/html/";
+22 -21
nixos/tests/kea.nix
···
extraArgs = [
"-v"
];
-
extraConfig = ''
-
server:
-
listen: 0.0.0.0@53
+
settings = {
+
server.listen = [
+
"0.0.0.0@53"
+
];
-
log:
-
- target: syslog
-
any: debug
+
log.syslog.any = "info";
-
acl:
-
- id: dhcp_ddns
-
address: 10.0.0.1
-
action: update
+
acl.dhcp_ddns = {
+
address = "10.0.0.1";
+
action = "update";
+
};
-
template:
-
- id: default
-
storage: ${zonesDir}
-
zonefile-sync: -1
-
zonefile-load: difference-no-serial
-
journal-content: all
+
template.default = {
+
storage = zonesDir;
+
zonefile-sync = "-1";
+
zonefile-load = "difference-no-serial";
+
journal-content = "all";
+
};
-
zone:
-
- domain: lan.nixos.test
-
file: lan.nixos.test.zone
-
acl: [dhcp_ddns]
-
'';
+
zone."lan.nixos.test" = {
+
file = "lan.nixos.test.zone";
+
acl = [
+
"dhcp_ddns"
+
];
+
};
+
};
};
};
+58 -64
nixos/tests/knot.nix
···
services.knot.enable = true;
services.knot.extraArgs = [ "-v" ];
services.knot.keyFiles = [ tsigFile ];
-
services.knot.extraConfig = ''
-
server:
-
listen: 0.0.0.0@53
-
listen: ::@53
-
automatic-acl: true
+
services.knot.settings = {
+
server = {
+
listen = [
+
"0.0.0.0@53"
+
"::@53"
+
];
+
automatic-acl = true;
+
};
-
remote:
-
- id: secondary
-
address: 192.168.0.2@53
-
key: xfr_key
+
acl.secondary_acl = {
+
address = "192.168.0.2";
+
key = "xfr_key";
+
action = "transfer";
+
};
-
template:
-
- id: default
-
storage: ${knotZonesEnv}
-
notify: [secondary]
-
dnssec-signing: on
-
# Input-only zone files
-
# https://www.knot-dns.cz/docs/2.8/html/operation.html#example-3
-
# prevents modification of the zonefiles, since the zonefiles are immutable
-
zonefile-sync: -1
-
zonefile-load: difference
-
journal-content: changes
-
# move databases below the state directory, because they need to be writable
-
journal-db: /var/lib/knot/journal
-
kasp-db: /var/lib/knot/kasp
-
timer-db: /var/lib/knot/timer
+
remote.secondary.address = "192.168.0.2@53";
-
zone:
-
- domain: example.com
-
file: example.com.zone
+
template.default = {
+
storage = knotZonesEnv;
+
notify = [ "secondary" ];
+
acl = [ "secondary_acl" ];
+
dnssec-signing = true;
+
# Input-only zone files
+
# https://www.knot-dns.cz/docs/2.8/html/operation.html#example-3
+
# prevents modification of the zonefiles, since the zonefiles are immutable
+
zonefile-sync = -1;
+
zonefile-load = "difference";
+
journal-content = "changes";
+
};
-
- domain: sub.example.com
-
file: sub.example.com.zone
+
zone = {
+
"example.com".file = "example.com.zone";
+
"sub.example.com".file = "sub.example.com.zone";
+
};
-
log:
-
- target: syslog
-
any: info
-
'';
+
log.syslog.any = "info";
+
};
};
secondary = { lib, ... }: {
···
services.knot.enable = true;
services.knot.keyFiles = [ tsigFile ];
services.knot.extraArgs = [ "-v" ];
-
services.knot.extraConfig = ''
-
server:
-
listen: 0.0.0.0@53
-
listen: ::@53
-
automatic-acl: true
+
services.knot.settings = {
+
server = {
+
listen = [
+
"0.0.0.0@53"
+
"::@53"
+
];
+
automatic-acl = true;
+
};
-
remote:
-
- id: primary
-
address: 192.168.0.1@53
-
key: xfr_key
+
remote.primary = {
+
address = "192.168.0.1@53";
+
key = "xfr_key";
+
};
-
template:
-
- id: default
-
master: primary
-
# zonefileless setup
-
# https://www.knot-dns.cz/docs/2.8/html/operation.html#example-2
-
zonefile-sync: -1
-
zonefile-load: none
-
journal-content: all
-
# move databases below the state directory, because they need to be writable
-
journal-db: /var/lib/knot/journal
-
kasp-db: /var/lib/knot/kasp
-
timer-db: /var/lib/knot/timer
-
-
zone:
-
- domain: example.com
-
file: example.com.zone
+
template.default = {
+
master = "primary";
+
# zonefileless setup
+
# https://www.knot-dns.cz/docs/2.8/html/operation.html#example-2
+
zonefile-sync = "-1";
+
zonefile-load = "none";
+
journal-content = "all";
+
};
-
- domain: sub.example.com
-
file: sub.example.com.zone
+
zone = {
+
"example.com".file = "example.com.zone";
+
"sub.example.com".file = "sub.example.com.zone";
+
};
-
log:
-
- target: syslog
-
any: info
-
'';
+
log.syslog.any = "info";
+
};
};
client = { lib, nodes, ... }: {
imports = [ common ];