git.delta.rocks / jrsonnet / refs/commits / d9fb30d36ead

difftreelog

feat lenient nixosModules type

Yaroslav Bolyukin2024-07-11parent: #e9ac172.patch.diff
in: trunk

8 files changed

modifiedREADME.adocdiffbeforeafterboth
--- a/README.adoc
+++ b/README.adoc
@@ -63,18 +63,14 @@
       # nixosModules section of fleet config declares modules, which are used for all configured nixos hosts.
       nixosModules = [
         lanzaboote.nixosModules.lanzaboote
-        ({
-          config,
-          lib,
-          ...
-        }: {
+        {
           # Make `nix shell nixpkgs#thing` use the same nixpkgs, as used to build the system.
           nix.registry.nixpkgs = {
             from = { id = "nixpkgs"; type = "indirect"; };
             flake = nixpkgs;
             exact = false;
           };
-        })
+        }
       ];
 
       # Those modules are used to configure all the machines in cluster at the same time, good example of global modules
@@ -97,12 +93,12 @@
           ./controlplane-1/hardware-configuration.nix
           ./controlplane-1/configuration.nix
           # Configuration may also be specified inline, as in any nixos config.
-          ({...}: {
+          {
             services.ray = {
               gpus = 4;
               cpus = 128;
             };
-          })
+          }
         ];
       };
     };
modifiedflake.nixdiffbeforeafterboth
--- a/flake.nix
+++ b/flake.nix
@@ -16,19 +16,18 @@
       inputs.nixpkgs.follows = "nixpkgs";
     };
   };
-  outputs = {
+  outputs = inputs @ {
     self,
-    rust-overlay,
     flake-parts,
-    nixpkgs,
-    nixpkgs-stable-for-tests,
     crane,
+    ...
   }:
     flake-parts.lib.mkFlake {
-      # Not passing inputs through inputs for better visibility.
-      inputs = {};
+      inherit inputs;
     } {
-      flake = {
+      flake = let
+        inherit (inputs.nixpkgs.lib) mapAttrs;
+      in {
         lib = import ./lib {
           fleetPkgsForPkgs = pkgs:
             import ./pkgs {
@@ -45,11 +44,11 @@
             '';
             inventory = output: {
               children =
-                builtins.mapAttrs (configName: cluster: {
+                mapAttrs (configName: cluster: {
                   what = "fleet cluster configuration";
 
                   children =
-                    builtins.mapAttrs (hostName: host: {
+                    mapAttrs (hostName: host: {
                       what = "host [${host.system}]";
                     })
                     cluster.config.hosts;
@@ -70,19 +69,20 @@
         pkgs,
         ...
       }: let
+        inherit (lib) mapAttrs' elem;
         # Can also be built for darwin, through it is not usual to deploy nixos systems from macos machines.
         # I have no hardware for such testing, thus only adding machines I actually have and use.
         #
         # It is not possible to deploy any host from armv6/armv7 hardware, and I don't think it even makes sense.
         deployerSystems = ["aarch64-linux" "x86_64-linux"];
-        deployerSystem = builtins.elem system deployerSystems;
+        deployerSystem = elem system deployerSystems;
         lib = pkgs.lib;
         rust = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
         craneLib = (crane.mkLib pkgs).overrideToolchain rust;
       in {
-        _module.args.pkgs = import nixpkgs {
+        _module.args.pkgs = import inputs.nixpkgs {
           inherit system;
-          overlays = [(rust-overlay.overlays.default)];
+          overlays = [(inputs.rust-overlay.overlays.default)];
         };
         # Reference fleet package should be built with nightly rust, specified in rust-toolchain.toml.
         packages = lib.mkIf deployerSystem (let
@@ -116,14 +116,14 @@
         checks = let
           packages = import ./pkgs {
             inherit (pkgs) callPackage;
-            craneLib = crane.mkLib (import nixpkgs {inherit system;});
+            craneLib = crane.mkLib pkgs;
           };
           packages-with-nixpkgs-stable = import ./pkgs {
             inherit (pkgs) callPackage;
-            craneLib = crane.mkLib (import nixpkgs-stable-for-tests {inherit system;});
+            craneLib = crane.mkLib (import inputs.nixpkgs-stable-for-tests {inherit system;});
           };
           prefixAttrs = prefix: attrs:
-            nixpkgs.lib.attrsets.mapAttrs' (name: value: {
+            mapAttrs' (name: value: {
               name = "${prefix}${name}";
               value = value.overrideAttrs (prev: {
                 pname = "${prefix}${prev.pname}";
modifiedlib/fleetLib.nixdiffbeforeafterboth
--- a/lib/fleetLib.nix
+++ b/lib/fleetLib.nix
@@ -2,8 +2,11 @@
 {
   nixpkgs,
   hostNames,
-}:
-with nixpkgs.lib; rec {
+}: let
+  inherit (nixpkgs) lib;
+  inherit (lib) listToAttrs remove unique crossLists sort elemAt mkOptionType mkOverride optionalString;
+  inherit (lib.types) listOf coercedTo oneOf submodule;
+in rec {
   hostsToAttrs = f:
     listToAttrs (
       map (name: {
@@ -34,6 +37,27 @@
     then "${this}-${other}"
     else "${other}-${this}";
 
+  types = rec {
+    anyModule = mkOptionType {
+      name = "submodule";
+      inherit (submodule {}) check;
+      merge = lib.options.mergeOneOption;
+      description = "Nixos module";
+    };
+    listOfAnyModuleStrict =
+      listOf anyModule;
+    listOfAnyModule =
+      coercedTo (oneOf [listOfAnyModuleStrict anyModule]) (
+        v:
+          if builtins.isAttrs v
+          then [v]
+          else if builtins.isFunction v
+          then [v]
+          else v
+      )
+      listOfAnyModuleStrict;
+  };
+
   # mkDefault = mkOverride 1000
   # For places, where fleet knows better than nixpkgs defaults.
   mkFleetDefault = mkOverride 999;
modifiedmodules/fleet/assertions.nixdiffbeforeafterboth
--- a/modules/fleet/assertions.nix
+++ b/modules/fleet/assertions.nix
@@ -1,8 +1,10 @@
-{lib, ...}:
-with lib; {
+{lib, ...}: let
+  inherit (lib) mkOption;
+  inherit (lib.types) listOf unspecified str;
+in {
   options = {
     assertions = mkOption {
-      type = types.listOf types.unspecified;
+      type = listOf unspecified;
       internal = true;
       default = [];
       example = [
@@ -21,7 +23,7 @@
     warnings = mkOption {
       internal = true;
       default = [];
-      type = types.listOf types.str;
+      type = listOf str;
       example = ["The `foo' service is deprecated and will go away soon!"];
       description = ''
         This option allows modules to show warnings to users during
modifiedmodules/fleet/meta.nixdiffbeforeafterboth
--- a/modules/fleet/meta.nix
+++ b/modules/fleet/meta.nix
@@ -4,58 +4,53 @@
   config,
   nixpkgs,
   ...
-}:
-with lib;
-with fleetLib; let
-  hostModule = with types;
-    {...} @ hostConfig: let
-      hostName = hostConfig.config._module.args.name;
-    in {
-      options = {
-        nixosModules = mkOption {
-          type = listOf (mkOptionType {
-            name = "submodule";
-            inherit (submodule {}) check;
-            merge = lib.options.mergeOneOption;
-            description = "Nixos module";
-          });
-          description = "List of nixos modules";
-          default = [];
-        };
-        system = mkOption {
-          type = str;
-          description = "Type of system";
-        };
-        encryptionKey = mkOption {
-          type = str;
-          description = "Encryption key";
-        };
-        nixosSystem = mkOption {
-          type = unspecified;
-          description = "Nixos configuration";
-        };
-        nixpkgs = mkOption {
-          type = unspecified;
-          description = "Nixpkgs override";
-          default = nixpkgs;
-        };
+}: let
+  inherit (fleetLib) hostsToAttrs mkFleetGeneratorDefault;
+  inherit (fleetLib.types) listOfAnyModule;
+  inherit (lib) mkOption mkOptionType;
+  inherit (lib.types) str unspecified attrsOf listOf submodule;
+  hostModule = {...} @ hostConfig: let
+    hostName = hostConfig.config._module.args.name;
+  in {
+    options = {
+      nixosModules = mkOption {
+        # Not too strict, but nixos module system will fix everything.
+        type =
+          listOfAnyModule;
+
+        description = "List of nixos modules";
+        default = [];
+      };
+      system = mkOption {
+        type = str;
+        description = "Type of system";
+      };
+      encryptionKey = mkOption {
+        type = str;
+        description = "Encryption key";
+      };
+      nixosSystem = mkOption {
+        type = unspecified;
+        description = "Nixos configuration";
+      };
+      nixpkgs = mkOption {
+        type = unspecified;
+        description = "Nixpkgs override";
+        default = nixpkgs;
       };
-      config = {
-        nixosSystem = hostConfig.config.nixpkgs.lib.nixosSystem {
-          inherit (hostConfig.config) system;
-          modules = hostConfig.config.nixosModules;
-          specialArgs = {
-            inherit fleetLib;
-            fleet = hostsToAttrs (host: config.hosts.${host}.nixosSystem.config);
-          };
+    };
+    config = {
+      nixosSystem = hostConfig.config.nixpkgs.lib.nixosSystem {
+        inherit (hostConfig.config) system;
+        modules = hostConfig.config.nixosModules;
+        specialArgs = {
+          inherit fleetLib;
+          fleet = hostsToAttrs (host: config.hosts.${host}.nixosSystem.config);
         };
-        nixosModules = [
-          ({...}: {
-            networking.hostName = mkFleetGeneratorDefault hostName;
-          })
-        ];
       };
+      nixosModules.networking.hostName = mkFleetGeneratorDefault hostName;
     };
+  };
   overlayType = mkOptionType {
     name = "nixpkgs-overlay";
     description = "nixpkgs overlay";
@@ -63,19 +58,14 @@
     merge = lib.mergeOneOption;
   };
 in {
-  options = with types; {
+  options = {
     hosts = mkOption {
       type = attrsOf (submodule hostModule);
       default = {};
       description = "Configurations of individual hosts";
     };
     nixosModules = mkOption {
-      type = listOf (mkOptionType {
-        name = "submodule";
-        inherit (submodule {}) check;
-        merge = lib.options.mergeOneOption;
-        description = "Nixos modules";
-      });
+      type = listOfAnyModule;
       description = "Modules, which should be added to every system";
       default = [];
     };
@@ -89,9 +79,9 @@
       nixosModules =
         config.nixosModules
         ++ [
-          ({...}: {
+          {
             nixpkgs.overlays = config.overlays;
-          })
+          }
         ];
     });
     nixosModules = import ../../nixos/modules/module-list.nix;
modifiedmodules/fleet/secrets.nixdiffbeforeafterboth
3 fleetLib,3 fleetLib,
4 config,4 config,
5 ...5 ...
6}:6}: let
7 inherit (fleetLib) hostsToAttrs;
7with lib;8 inherit (lib) mkOption mapAttrsToList mapAttrs filterAttrs concatStringsSep;
9 inherit (lib.types) lazyAttrsOf unspecified nullOr listOf str bool attrsOf submodule;
10
11 sharedSecret = {config, ...}: {
12 freeformType = lazyAttrsOf unspecified;
13 options = {
14 expectedOwners = mkOption {
15 type = nullOr (listOf str);
16 description = ''
17 List of hosts to encrypt secret for. null if managed by user (= via owners field from fleet.nix)
18
19 Secrets would be decrypted and stored to /run/secrets/$\{name} on owners
20 '';
21 default = null;
22 };
23 # TODO: Aren't those options may be just desugared to data/expectedData?
24 regenerateOnOwnerAdded = mkOption {
25 type = bool;
26 description = ''
27 Is this secret owner-dependent, and needs to be regenerated on ownership set change, or it may be just reencrypted.
28
29 You want to have this option set to true, when this secret contains some reference to its owners, i.e x509 SANs.
30 '';
31 };
32 regenerateOnOwnerRemoved = mkOption {
33 default = config.regenerateOnOwnerAdded;
34 type = bool;
35 description = ''
36 Should this secret be removed on owner removal, or it may be just reencrypted
37
38 Most probably its value should be equal to regenerateOnOwnerAdded, override only if you know what are you doing.
39 Contrary to regenerateOnOwnerAdded, you may want to set this option to false, when host permissions are revoked
40 in some other way than by this secret ownership, I.e by firewall/etc.
41 '';
42 };
43 generator = mkOption {
44 type = nullOr unspecified;
45 description = "Derivation to evaluate for secret generation";
46 default = null;
47 };
48 createdAt = mkOption {
49 type = nullOr str;
50 description = "When this secret was (re)generated";
51 default = null;
52 };
53 expiresAt = mkOption {
54 type = nullOr str;
55 description = "On which date this secret will expire, someone should regenerate this secret before it expires.";
56 default = null;
57 };
58
59 owners = mkOption {
60 type = listOf str;
61 description = ''
62 For which owners this secret is currently encrypted,
63 if not matches expectedOwners - then this secret is considered outdated, and
64 should be regenerated/reencrypted.
65
66 Imported from fleet.nix
67 '';
68 default = [];
69 };
70 };
8with fleetLib; let71 };
9 sharedSecret = with types; ({config, ...}: {72 hostSecret = {
10 freeformType = types.lazyAttrsOf unspecified;73 freeformType = lazyAttrsOf unspecified;
11 options = {74 options = {
12 expectedOwners = mkOption {75 createdAt = mkOption {
13 type = nullOr (listOf str);76 type = nullOr str;
14 description = ''
15 List of hosts to encrypt secret for. null if managed by user (= via owners field from fleet.nix)
16
17 Secrets would be decrypted and stored to /run/secrets/$\{name} on owners
18 '';
19 default = null;77 default = null;
20 };78 };
21 # TODO: Aren't those options may be just desugared to data/expectedData?
22 regenerateOnOwnerAdded = mkOption {
23 type = bool;
24 description = ''
25 Is this secret owner-dependent, and needs to be regenerated on ownership set change, or it may be just reencrypted.
26
27 You want to have this option set to true, when this secret contains some reference to its owners, i.e x509 SANs.
28 '';
29 };
30 regenerateOnOwnerRemoved = mkOption {
31 default = config.regenerateOnOwnerAdded;
32 type = bool;
33 description = ''
34 Should this secret be removed on owner removal, or it may be just reencrypted
35
36 Most probably its value should be equal to regenerateOnOwnerAdded, override only if you know what are you doing.
37 Contrary to regenerateOnOwnerAdded, you may want to set this option to false, when host permissions are revoked
38 in some other way than by this secret ownership, I.e by firewall/etc.
39 '';
40 };
41 generator = mkOption {
42 type = nullOr unspecified;
43 description = "Derivation to evaluate for secret generation";
44 default = null;
45 };
46 createdAt = mkOption {79 expiresAt = mkOption {
47 type = nullOr str;80 type = nullOr str;
48 description = "When this secret was (re)generated";
49 default = null;81 default = null;
50 };82 };
51 expiresAt = mkOption {
52 type = nullOr str;
53 description = "On which date this secret will expire, someone should regenerate this secret before it expires.";
54 default = null;
55 };
56
57 owners = mkOption {
58 type = listOf str;
59 description = ''
60 For which owners this secret is currently encrypted,
61 if not matches expectedOwners - then this secret is considered outdated, and
62 should be regenerated/reencrypted.
63
64 Imported from fleet.nix
65 '';
66 default = [];
67 };
68 };83 };
69 });84 };
70 hostSecret = with types; {
71 freeformType = types.lazyAttrsOf unspecified;
72 options = {
73 createdAt = mkOption {
74 type = nullOr str;
75 default = null;
76 };
77 expiresAt = mkOption {
78 type = nullOr str;
79 default = null;
80 };
81 };
82 };
83in {85in {
84 options = with types; {86 options = {
85 version = mkOption {87 version = mkOption {
86 type = str;88 type = str;
87 default = "";89 default = "";
128 });130 });
129 # TODO: Should this attribute be moved to `nixpkgs.overlays`?131 # TODO: Should this attribute be moved to `nixpkgs.overlays`?
130 overlays = [132 overlays = [
131 (final: prev: let133 (final: prev: {
132 lib = final.lib;
133 inherit (lib) strings;
134 inherit (strings) concatStringsSep;
135 in {
136 mkSecretGenerators = {recipients}: rec {134 mkSecretGenerators = {recipients}: rec {
137 # TODO: Merge both generators to one with consistent options syntax?135 # TODO: Merge both generators to one with consistent options syntax?
138 # Impure generator is built on local machine, then built closure is copied to remote machine,136 # Impure generator is built on local machine, then built closure is copied to remote machine,
modifiednixos/meta.nixdiffbeforeafterboth
--- a/nixos/meta.nix
+++ b/nixos/meta.nix
@@ -2,11 +2,13 @@
   lib,
   pkgs,
   ...
-}:
-with lib; {
-  options = with types; {
+}: let
+  inherit (lib) mkOption;
+  inherit (lib.types) listOf str submodule;
+in {
+  options = {
     nixpkgs.resolvedPkgs = mkOption {
-      type = types.pkgs // {description = "nixpkgs.pkgs";};
+      type = lib.types.pkgs // {description = "nixpkgs.pkgs";};
       description = "Value of pkgs";
     };
     tags = mkOption {
@@ -30,9 +32,6 @@
         };
       };
       description = "Network definition of host";
-    };
-    buildTarget = mkOption {
-      type = enum ["toplevel" "sd-image" "installation-cd"];
     };
   };
   config = {
modifiednixos/secrets.nixdiffbeforeafterboth
--- a/nixos/secrets.nix
+++ b/nixos/secrets.nix
@@ -3,16 +3,17 @@
   config,
   pkgs,
   ...
-}:
-with lib; let
+}: let
   inherit (lib.strings) hasPrefix removePrefix;
+  inherit (lib) mkOption mkOptionDefault mapAttrs stringAfter;
+  inherit (lib.types) submodule str attrsOf nullOr unspecified lazyAttrsOf;
   plaintextPrefix = "<PLAINTEXT>";
   plaintextNewlinePrefix = "<PLAINTEXT-NL>";
 
   sysConfig = config;
   secretPartType = secretName:
-    types.submodule ({config, ...}: {
-      options = with types; {
+    submodule ({config, ...}: {
+      options = {
         raw = mkOption {
           description = "Secret in fleet-specific undocumented format, do not use. Import from fleet.nix";
           internal = true;
@@ -49,11 +50,11 @@
         stablePath = mkOptionDefault "/run/secrets/${secretName}/${partName}";
       };
     });
-  secretType = types.submodule ({config, ...}: let
+  secretType = submodule ({config, ...}: let
     secretName = config._module.args.name;
   in {
-    freeformType = types.lazyAttrsOf (secretPartType secretName);
-    options = with types; {
+    freeformType = lazyAttrsOf (secretPartType secretName);
+    options = {
       shared = mkOption {
         description = "Is this secret owned by this machine, or propagated from shared secrets";
         default = false;
@@ -112,7 +113,7 @@
 in {
   options = {
     secrets = mkOption {
-      type = types.attrsOf secretType;
+      type = attrsOf secretType;
       default = {};
       description = "Host-local secrets";
     };