deploy_nixos

@@ -7,9 +7,9 @@ copy cluster/$CLUSTER/cluster.nix /etc/nixos/cluster.nix
 copy cluster/$CLUSTER/node/$NIXHOST.nix /etc/nixos/node.nix
 copy cluster/$CLUSTER/node/$NIXHOST.site.nix /etc/nixos/site.nix
 
-cmd mkdir -p /var/lib/wgautomesh
-write_pass deuxfleurs/cluster/$CLUSTER/wgautomesh_gossip_secret /var/lib/wgautomesh/gossip_secret
 copy nix/wgautomesh.nix /etc/nixos/wgautomesh.nix
+cmd mkdir -p /var/lib/deuxfleurs
+write_pass deuxfleurs/cluster/$CLUSTER/wgautomesh_gossip_secret /var/lib/deuxfleurs/wgautomesh_gossip_secret
 
 if [ "$CLUSTER" = "staging" ]; then
 	copy nix/nomad-driver-nix2.nix /etc/nixos/nomad-driver-nix2.nix

nix/deuxfleurs.nix

@@ -207,11 +207,11 @@ in
     };
     services.wgautomesh = {
       enable = true;
+      gossipSecretFile = "/var/lib/deuxfleurs/wgautomesh_gossip_secret";
+      settings = {
         interface = "wg0";
-      gossipPort = 1666;
+        gossip_port = 1666;
-      gossipSecretFile = "/var/lib/wgautomesh/gossip_secret";
+        upnp_forward_external_port =
-      persistFile = "/var/lib/wgautomesh/state";
-      upnpForwardPublicPort = 
           if clusterNodeCfg.endpoint != null then
             strings.toInt (lists.last (split ":" clusterNodeCfg.endpoint))
           else null;
@@ -220,6 +220,7 @@ in
           pubkey = publicKey;
         }) cfg.clusterNodes);
       };
+    };
     # Old code for wg-quick, we can use this as a fallback if we fail to make wgautomesh work
     # systemd.services."wg-quick-wg0".after = [ "unbound.service" ];
     # networking.wg-quick.interfaces.wg0 = {

nix/wgautomesh.nix

@@ -9,121 +9,157 @@ in
 with lib;
 let
   cfg = config.services.wgautomesh;
+  settingsFormat = pkgs.formats.toml { };
+  configFile =
+    # Have to remove nulls manually as TOML generator will not just skip key
+    # if value is null
+    settingsFormat.generate "wgautomesh-config.toml"
+      (filterAttrs (k: v: v != null)
+        (mapAttrs
+          (k: v:
+            if k == "peers"
+            then map (e: filterAttrs (k: v: v != null) e) v
+            else v)
+          cfg.settings));
+  runtimeConfigFile =
+    if cfg.enableGossipEncryption
+    then "/run/wgautomesh/wgautomesh.toml"
+    else configFile;
 in
-  with builtins;
 {
   options.services.wgautomesh = {
-      enable = mkEnableOption "wgautomesh";
+    enable = mkEnableOption (mdDoc "the wgautomesh daemon");
     logLevel = mkOption {
       type = types.enum [ "trace" "debug" "info" "warn" "error" ];
       default = "info";
-        description = "wgautomesh log level (trace/debug/info/warn/error)";
+      description = mdDoc "wgautomesh log level.";
     };
-      interface = mkOption {
+    enableGossipEncryption = mkOption {
-        type = types.str;
-        description = "Wireguard interface to manage";
-      };
-      gossipPort = mkOption {
-        type = types.port;
-        description = "wgautomesh gossip port";
-      };
-      gossipSecretFile = mkOption {
-        type = types.nullOr types.str;
-        description = "File containing the gossip secret encryption key";
-      };
-      persistFile = mkOption {
-        type = types.nullOr types.str;
-        description = "Path where to persist known peer addresses";
-      };
-      lanDiscovery = mkOption {
       type = types.bool;
       default = true;
-        description = "Enable discovery using LAN broadcast";
+      description = mdDoc "Enable encryption of gossip traffic.";
+    };
+    gossipSecretFile = mkOption {
+      type = types.path;
+      description = mdDoc ''
+        File containing the shared secret key to use for gossip encryption.
+        Required if `enableGossipEncryption` is set.
+      '';
+    };
+    enablePersistence = mkOption {
+      type = types.bool;
+      default = true;
+      description = mdDoc "Enable persistence of Wireguard peer info between restarts.";
     };
     openFirewall = mkOption {
       type = types.bool;
       default = true;
-        description = "Automatically open gossip port in firewall";
+      description = mdDoc "Automatically open gossip port in firewall (recommended).";
     };
-      upnpForwardPublicPort = mkOption {
+    settings = mkOption {
+      type = types.submodule {
+        freeformType = settingsFormat.type;
+        options = {
+          interface = mkOption {
+            type = types.str;
+            description = mdDoc ''
+              Wireguard interface to manage (it is NOT created by wgautomesh, you
+              should use another NixOS option to create it such as
+              `networking.wireguard.interfaces.wg0 = {...};`).
+            '';
+            example = "wg0";
+          };
+          gossip_port = mkOption {
+            type = types.port;
+            description = mdDoc ''
+              wgautomesh gossip port, this MUST be the same number on all nodes in
+              the wgautomesh network.
+            '';
+            default = 1666;
+          };
+          lan_discovery = mkOption {
+            type = types.bool;
+            default = true;
+            description = mdDoc "Enable discovery of peers on the same LAN using UDP broadcast.";
+          };
+          upnp_forward_external_port = mkOption {
             type = types.nullOr types.port;
             default = null;
-        description = "Public port number to try to redirect to this machine using UPnP IGD";
+            description = mdDoc ''
+              Public port number to try to redirect to this machine's Wireguard
+              daemon using UPnP IGD.
+            '';
           };
           peers = mkOption {
             type = types.listOf (types.submodule {
               options = {
                 pubkey = mkOption {
                   type = types.str;
-              description = "Wireguard public key";
+                  description = mdDoc "Wireguard public key of this peer.";
                 };
                 address = mkOption {
                   type = types.str;
-              description = "Wireguard peer address";
+                  description = mdDoc ''
+                    Wireguard address of this peer (a single IP address, multliple
+                    addresses or address ranges are not supported).
+                  '';
+                  example = "10.0.0.42";
                 };
                 endpoint = mkOption {
                   type = types.nullOr types.str;
-              description = "bootstrap endpoint";
+                  description = mdDoc ''
+                    Bootstrap endpoint for connecting to this Wireguard peer if no
+                    other address is known or none are working.
+                  '';
+                  default = null;
+                  example = "wgnode.mydomain.example:51820";
                 };
               };
             });
-        description = "wgautomesh peer list";
+            default = [ ];
+            description = mdDoc "wgautomesh peer list.";
+          };
+        };
+      };
+      default = { };
+      description = mdDoc "Configuration for wgautomesh.";
     };
   };
 
-    config = mkIf cfg.enable ( 
+  config = mkIf cfg.enable {
-    let
+    services.wgautomesh.settings = {
-      peerDefs = map (peer:
+      gossip_secret_file = mkIf cfg.enableGossipEncryption "$CREDENTIALS_DIRECTORY/gossip_secret";
-        let endpointDef = if peer.endpoint == null then ""
+      persist_file = mkIf cfg.enablePersistence "/var/lib/wgautomesh/state";
-        else ''endpoint = "${peer.endpoint}"'';
+    };
-        in
-        ''
-          [[peers]]
-          pubkey = "${peer.pubkey}"
-          address = "${peer.address}"
-          ${endpointDef}
-        '') cfg.peers;
-      extraDefs = (if cfg.lanDiscovery then ["lan_discovery = true"] else [])
-        ++ (if (cfg.gossipSecretFile != null)
-          then [''gossip_secret_file = "${cfg.gossipSecretFile}"''] else [])
-        ++ (if (cfg.persistFile != null)
-          then [''persist_file = "${cfg.persistFile}"''] else [])
-        ++ (if (cfg.upnpForwardPublicPort != null)
-          then [''upnp_forward_external_port = ${toString cfg.upnpForwardPublicPort}''] else []);
-      configfile = pkgs.writeText "wgautomesh.toml" ''
-        interface = "${cfg.interface}"
-        gossip_port = ${toString cfg.gossipPort}
-        ${concatStringsSep "\n" extraDefs}
 
-        ${concatStringsSep "\n" peerDefs}
-        '';
-    in {
     systemd.services.wgautomesh = {
-        enable = true;
       path = [ pkgs.wireguard-tools ];
-        environment = {
+      environment = { RUST_LOG = "wgautomesh=${cfg.logLevel}"; };
-          RUST_LOG = "wgautomesh=${cfg.logLevel}";
-        };
       description = "wgautomesh";
       serviceConfig = {
         Type = "simple";
 
-          ExecStart = "${wgautomesh}/bin/wgautomesh ${configfile}";
+        ExecStart = "${wgautomesh}/bin/wgautomesh ${runtimeConfigFile}";
         Restart = "always";
         RestartSec = "30";
+        LoadCredential = mkIf cfg.enableGossipEncryption [ "gossip_secret:${cfg.gossipSecretFile}" ];
 
-          ExecStartPre = [ "+${pkgs.coreutils}/bin/chown wgautomesh /var/lib/wgautomesh/gossip_secret" ];
+        ExecStartPre = mkIf cfg.enableGossipEncryption [
+          ''${pkgs.envsubst}/bin/envsubst \
+              -i ${configFile} \
+              -o ${runtimeConfigFile}''
+        ];
 
         DynamicUser = true;
-          User = "wgautomesh";
         StateDirectory = "wgautomesh";
         StateDirectoryMode = "0700";
+        RuntimeDirectory = "wgautomesh";
         AmbientCapabilities = "CAP_NET_ADMIN";
         CapabilityBoundingSet = "CAP_NET_ADMIN";
       };
       wantedBy = [ "multi-user.target" ];
     };
-      networking.firewall.allowedUDPPorts = mkIf cfg.openFirewall [ cfg.gossipPort ];
+    networking.firewall.allowedUDPPorts =
-    });
+      mkIf cfg.openFirewall [ cfg.settings.gossip_port ];
+  };
 }
-