confctl 1.0.0 → 2.0.0

data/man/man8/confctl-options.nix.8.md

@@ -1,4 +1,4 @@
-# confctl-options.nix 8           2024-02-17                             master
+# confctl-options.nix 8           2024-05-07                             master
 
 ## NAME
 `confctl-options.nix` - confctl configuration documentation
@@ -601,6 +601,22 @@ the deployment configuration directory, i.e. `cluster/<machine-name>/module.nix`
 
     *Declared by:* `<confctl/nix/modules/cluster>`
 
+`cluster.<name>.buildAttribute`
+  Path to the attribute in machine system config that should be built
+  
+  For example, `[ "system" "build" "toplevel" ]` will select attribute
+  `config.system.build.toplevel`.
+
+    *Type:* list of string
+
+    *Default:* `[
+  "system"
+  "build"
+  "toplevel"
+]`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
 `cluster.<name>.buildGenerations.max`
   The maximum number of build generations to be kept on the build
   machine.
@@ -634,6 +650,151 @@ the deployment configuration directory, i.e. `cluster/<machine-name>/module.nix`
 
     *Declared by:* `<confctl/nix/modules/cluster>`
 
+`cluster.<name>.carrier.enable`
+  Whether to enable This machine is a carrier for other machines.
+
+    *Type:* boolean
+
+    *Default:* `false`
+
+    *Example:* `true`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines`
+  List of carried machines
+
+    *Type:* list of (submodule)
+
+    *Default:* `[ ]`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.alias`
+  Alias for carried machine name
+
+    *Type:* null or string
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.buildAttribute`
+  Path to the attribute in machine system config that should be built
+  
+  For example, `[ "system" "build" "toplevel" ]` will select attribute
+  `config.system.build.toplevel`.
+
+    *Type:* list of string
+
+    *Default:* `[
+  "system"
+  "build"
+  "toplevel"
+]`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.buildGenerations.max`
+  The maximum number of build generations to be kept on the build
+  machine.
+
+    *Type:* null or signed integer
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.buildGenerations.maxAge`
+  Delete build generations older than
+  `cluster.<name>.carrier.machines.*.buildGenerations.maxAge`
+  seconds from the build machine. Old generations are deleted even
+  if `cluster.<name>.carrier.machines.*.buildGenerations.max` is
+  not reached.
+
+    *Type:* null or signed integer
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.buildGenerations.min`
+  The minimum number of build generations to be kept on the build
+  machine.
+
+    *Type:* null or signed integer
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.extraModules`
+  A list of additional NixOS modules to be imported for this machine
+
+    *Type:* list of path
+
+    *Default:* `[ ]`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.hostGenerations.max`
+  The maximum number of generations to be kept on the machine.
+
+    *Type:* null or signed integer
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.hostGenerations.maxAge`
+  Delete generations older than
+  `cluster.<name>.carrier.machines.*.hostGenerations.maxAge`
+  seconds from the machine. Old generations are deleted even
+  if `cluster.<name>.carrier.machines.*.hostGenerations.max` is
+  not reached.
+
+    *Type:* null or signed integer
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.hostGenerations.min`
+  The minimum number of generations to be kept on the machine.
+
+    *Type:* null or signed integer
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.labels`
+  Optional user-defined labels to classify the machine
+
+    *Type:* attribute set
+
+    *Default:* `{ }`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.machine`
+  Machine name
+
+    *Type:* string
+
+    *Default:* `null`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
+`cluster.<name>.carrier.machines.*.tags`
+  Optional user-defined tags to classify the machine
+
+    *Type:* list of string
+
+    *Default:* `[ ]`
+
+    *Declared by:* `<confctl/nix/modules/cluster>`
+
 `cluster.<name>.healthChecks.builderCommands`
   Check commands run on the build machine
 
@@ -1034,6 +1195,9 @@ the deployment configuration directory, i.e. `cluster/<machine-name>/module.nix`
 
 `cluster.<name>.host.target`
   Address/host to which the configuration is deployed to
+  
+  Set to null if the machine is not deployable, e.g. when it is only used
+  as a carried machine.
 
     *Type:* null or string
 

data/man/man8/confctl.8

@@ -113,6 +113,10 @@ generations can be managed using \fB\fCconfctl generation\fR command family.
     \fB\fC\-j\fR, \fB\fC\-\-max\-jobs\fR \fInumber\fP
       Maximum number of build jobs, passed to \fB\fCnix\-build\fR\&. See man 
 .BR nix-build (1).
+.PP
+    \fB\fC\-\-cores\fR \fInumber\fP
+      Number of CPU cores to use, passed to \fB\fCnix\-build\fR\&. See man 
+.BR nix-build (1).
 .TP
 \fB\fCconfctl deploy\fR [\fIoptions\fP] [\fImachine\-pattern\fP [\fB\fCboot\fR|\fB\fCswitch\fR|\fB\fCtest\fR|\fB\fCdry\-activate\fR]]
 Deploy either a new or an existing build generation to matching machines.
@@ -177,6 +181,10 @@ the target machine. The default action is \fB\fCswitch\fR\&.
     \fB\fC\-j\fR, \fB\fC\-\-max\-jobs\fR \fInumber\fP
       Maximum number of build jobs, passed to \fB\fCnix\-build\fR\&. See man 
 .BR nix-build (1).
+.PP
+    \fB\fC\-\-cores\fR \fInumber\fP
+      Number of CPU cores to use, passed to \fB\fCnix\-build\fR\&. See man 
+.BR nix-build (1).
 .PP
     \fB\fC\-\-no\-health\-checks\fR
       Do not run configured health checks. Health checks are run by default
@@ -226,6 +234,10 @@ Probe managed machines and determine their status.
     \fB\fC\-j\fR, \fB\fC\-\-max\-jobs\fR \fInumber\fP
       Maximum number of build jobs, passed to \fB\fCnix\-build\fR\&. See man 
 .BR nix-build (1).
+.PP
+    \fB\fC\-\-cores\fR \fInumber\fP
+      Number of CPU cores to use, passed to \fB\fCnix\-build\fR\&. See man 
+.BR nix-build (1).
 .TP
 \fB\fCconfctl changelog\fR [\fIoptions\fP] [\fImachine\-pattern\fP [\fIsw\-pattern\fP]]
 Show differences in deployed and configured software pins. For git software
@@ -270,6 +282,10 @@ itself, it works only on software pins.
     \fB\fC\-j\fR, \fB\fC\-\-max\-jobs\fR \fInumber\fP
       Maximum number of build jobs, passed to \fB\fCnix\-build\fR\&. See man 
 .BR nix-build (1).
+.PP
+    \fB\fC\-\-cores\fR \fInumber\fP
+      Number of CPU cores to use, passed to \fB\fCnix\-build\fR\&. See man 
+.BR nix-build (1).
 .TP
 \fB\fCconfctl diff\fR [\fIoptions\fP] [\fImachine\-pattern\fP [\fIsw\-pattern\fP]]
 Show differences in deployed and configured software pins. For git software
@@ -308,6 +324,10 @@ itself, it works only on software pins.
     \fB\fC\-j\fR, \fB\fC\-\-max\-jobs\fR \fInumber\fP
       Maximum number of build jobs, passed to \fB\fCnix\-build\fR\&. See man 
 .BR nix-build (1).
+.PP
+    \fB\fC\-\-cores\fR \fInumber\fP
+      Number of CPU cores to use, passed to \fB\fCnix\-build\fR\&. See man 
+.BR nix-build (1).
 .TP
 \fB\fCconfctl test\-connection\fR [\fIoptions\fP] [\fImachine\-pattern\fP]
 Try to open a SSH connection to the selected machines. This command can be
@@ -656,5 +676,5 @@ Report bugs to \[la]https://github.com/vpsfreecz/confctl/issues\[ra]\&.
 .SH ABOUT
 .PP
 \fB\fCconfctl\fR was originally developed for the purposes of
-vpsFree.cz \[la]https://vpsfree.org\[ra] and its cluster 
+vpsFree.cz \[la]https://vpsfree.org\[ra] and its cluster
 configuration \[la]https://github.com/vpsfreecz/vpsfree-cz-configuration\[ra]\&.

data/man/man8/confctl.8.md

@@ -113,6 +113,9 @@ information.
     `-j`, `--max-jobs` *number*
       Maximum number of build jobs, passed to `nix-build`. See man nix-build(1).
 
+    `--cores` *number*
+      Number of CPU cores to use, passed to `nix-build`. See man nix-build(1).
+
 `confctl deploy` [*options*] [*machine-pattern* [`boot`|`switch`|`test`|`dry-activate`]]
   Deploy either a new or an existing build generation to matching machines.
 
@@ -176,6 +179,9 @@ information.
     `-j`, `--max-jobs` *number*
       Maximum number of build jobs, passed to `nix-build`. See man nix-build(1).
 
+    `--cores` *number*
+      Number of CPU cores to use, passed to `nix-build`. See man nix-build(1).
+
     `--no-health-checks`
       Do not run configured health checks. Health checks are run by default
       when *switch-action* is `switch`, `test` or `boot` with `--reboot`.
@@ -224,6 +230,9 @@ information.
     `-j`, `--max-jobs` *number*
       Maximum number of build jobs, passed to `nix-build`. See man nix-build(1).
 
+    `--cores` *number*
+      Number of CPU cores to use, passed to `nix-build`. See man nix-build(1).
+
 `confctl changelog` [*options*] [*machine-pattern* [*sw-pattern*]]
   Show differences in deployed and configured software pins. For git software
   pins, it's a git log.
@@ -267,6 +276,9 @@ information.
     `-j`, `--max-jobs` *number*
       Maximum number of build jobs, passed to `nix-build`. See man nix-build(1).
 
+    `--cores` *number*
+      Number of CPU cores to use, passed to `nix-build`. See man nix-build(1).
+
 `confctl diff` [*options*] [*machine-pattern* [*sw-pattern*]]
   Show differences in deployed and configured software pins. For git software
   pins, it's a git diff.
@@ -304,6 +316,9 @@ information.
     `-j`, `--max-jobs` *number*
       Maximum number of build jobs, passed to `nix-build`. See man nix-build(1).
 
+    `--cores` *number*
+      Number of CPU cores to use, passed to `nix-build`. See man nix-build(1).
+
 `confctl test-connection` [*options*] [*machine-pattern*]
   Try to open a SSH connection to the selected machines. This command can be
   used to confirm SSH host keys of the selected machines.
@@ -650,5 +665,5 @@ Report bugs to https://github.com/vpsfreecz/confctl/issues.
 
 ## ABOUT
 `confctl` was originally developed for the purposes of
-[vpsFree.cz](https://vpsfree.org) and its cluster 
+[vpsFree.cz](https://vpsfree.org) and its cluster
 [configuration](https://github.com/vpsfreecz/vpsfree-cz-configuration).

data/nix/evaluator.nix

@@ -18,8 +18,8 @@ let
   nameValuePairs = builtins.map (m: {
     name = m.name;
     value = {
-      inherit (m) name;
-    } // m.config;
+      inherit (m) name alias clusterName carrier metaConfig;
+    };
   }) machines;
 
   machinesAttrs = builtins.listToAttrs nameValuePairs;
@@ -53,7 +53,7 @@ let
     import ./lib/swpins/eval.nix {
       inherit (arg) confDir;
       name = m.name;
-      channels = m.config.swpins.channels;
+      channels = m.metaConfig.swpins.channels;
       pkgs = corePkgs.pkgs;
       lib = corePkgs.lib;
     };
@@ -70,17 +70,28 @@ let
     value = buildToplevel fullMachinesAttrs.${host};
   }) arg.machines);
 
-  buildToplevel = m: (evalMachine m).config.system.build.toplevel;
+  buildToplevel = machine:
+    let
+      machineConfig = (evalMachine machine).config;
+
+      buildAttr = coreLib.attrByPath machine.build.attribute null machineConfig;
+
+      result =
+        if isNull buildAttr then
+          abort "Attribute 'config.${coreLib.concatStringsSep "." machine.build.attribute}' not found on machine ${machine.name}"
+        else
+          buildAttr;
+    in result;
 
-  evalMachine = m:
+  evalMachine = machine:
     let
       importPath = {
         nixos = <nixpkgs/nixos/lib/eval-config.nix>;
         vpsadminos = <vpsadminos/os/default.nix>;
       };
 
-      evalConfig = import importPath.${m.config.spin} {
-        modules = [ m.build.toplevel ];
+      evalConfig = import importPath.${machine.metaConfig.spin} {
+        modules = machine.extraModules ++ [ machine.build.toplevel ];
       };
     in evalConfig;
 

data/nix/lib/default.nix

@@ -1,29 +1,74 @@
 { confDir, coreLib, corePkgs }:
 with coreLib;
 let
-  machine = import ./machine { inherit confDir corePkgs coreLib findConfig; };
+  machine = import ./machine { inherit confDir corePkgs coreLib findMetaConfig; };
 
-  findConfig =
+  findMetaConfig =
     { cluster, name }:
     cluster.${name};
 
   makeMachine =
-    { name, config }:
-    {
-      inherit name config;
-      build.toplevel = buildConfig { inherit name config; };
+    { name, metaConfig, carrier ? null, alias ? null, clusterName ? null, extraModules ? [], buildAttribute ? null }:
+    let
+      ensuredClusterName = if isNull clusterName then name else clusterName;
+    in {
+      inherit name alias metaConfig carrier extraModules;
+      clusterName = ensuredClusterName;
+
+      build = {
+        attribute = if isNull buildAttribute then metaConfig.buildAttribute else buildAttribute;
+        toplevel = buildConfig { name = ensuredClusterName; inherit metaConfig; };
+      };
     };
 
   buildConfig =
-    { name, config }:
-    if !config.managed then
+    { name, metaConfig }:
+    if !metaConfig.managed then
       null
-    else if config.spin == "nixos" then
-      machine.nixos { inherit name config; }
-    else if config.spin == "vpsadminos" then
-      machine.vpsadminos { inherit name config; }
+    else if metaConfig.spin == "nixos" then
+      machine.nixos { inherit name metaConfig; }
+    else if metaConfig.spin == "vpsadminos" then
+      machine.vpsadminos { inherit name metaConfig; }
     else
       null;
+
+  expandCarriers = machineAttrs: flatten (mapAttrsToList (name: m:
+    if m.metaConfig.carrier.enable then
+      [ m ] ++ (expandCarrier machineAttrs m)
+    else
+      m
+  ) machineAttrs);
+
+  expandCarrier = machineAttrs: carrierMachine: map (cm:
+    makeMachine {
+      name = "${carrierMachine.name}#${if isNull cm.alias then cm.machine else cm.alias}";
+      alias = cm.alias;
+      clusterName = cm.machine;
+      carrier = carrierMachine.name;
+      extraModules = cm.extraModules;
+      buildAttribute = cm.buildAttribute;
+      metaConfig = coreLib.updateManyAttrsByPath ([
+        {
+          path = [ "labels" ];
+          update = old: old // cm.labels;
+        }
+        {
+          path = [ "tags" ];
+          update = old: old ++ cm.tags;
+        }
+      ] ++ (generationUpdates cm)) machineAttrs.${cm.machine}.metaConfig;
+    }
+  ) carrierMachine.metaConfig.carrier.machines;
+
+  generationUpdates = cm:
+    flatten (map (generations:
+      map (attr: {
+        path = [ generations attr ];
+        update = old:
+          let v = cm.${generations}.${attr};
+          in if isNull v then old else v;
+      }) [ "min" "max" "maxAge" ]
+    ) [ "buildGenerations" "hostGenerations" ]);
 in rec {
   inherit corePkgs coreLib;
 
@@ -35,20 +80,22 @@ in rec {
     mkNetUdevRule name mac
   ) rs);
 
-  inherit findConfig;
+  inherit findMetaConfig;
 
   # Return all configured machines in a list
   getClusterMachines = cluster:
-    mapAttrsToList (name: config:
-      makeMachine { inherit name config; }
-    ) cluster;
+    let
+      machineAttrs = mapAttrs (name: metaConfig:
+        makeMachine { inherit name metaConfig; }
+      ) cluster;
+    in expandCarriers machineAttrs;
 
   # Get IP version addresses from all machines in a cluster
   getAllAddressesOf = cluster: v:
     let
       machines = getClusterMachines cluster;
       addresses = flatten (map (machine:
-        map (addr: machine // addr) machine.config.addresses.${"v${toString v}"}
+        map (addr: machine // addr) machine.metaConfig.addresses.${"v${toString v}"}
       ) machines);
     in addresses;
 

data/nix/lib/machine/default.nix

@@ -1,19 +1,19 @@
-{ confDir, corePkgs, coreLib, findConfig }:
+{ confDir, corePkgs, coreLib, findMetaConfig }:
 let
   swpinsFor =
-    { name, config }:
+    { name, metaConfig }:
     import ../swpins/eval.nix {
       inherit confDir name;
-      channels = config.swpins.channels;
+      channels = metaConfig.swpins.channels;
       pkgs = corePkgs;
       lib = coreLib;
     };
 
   makeModuleArgs =
-    { config, swpins, spin, name }@args: {
+    { metaConfig, swpins, spin, name }@args: {
       swpins = swpins.evaluated;
       swpinsInfo = swpins.infos;
-      confMachine = import ./info.nix (args // { inherit findConfig; });
+      confMachine = import ./info.nix (args // { inherit findMetaConfig; });
     };
 
   makeImports = spin: extraImports: [
@@ -34,18 +34,20 @@ let
         lib.mkIf (confMachine.host != null) (lib.mkDefault confMachine.host.fullDomain);
     })
   ] ++ (import ../../modules/module-list.nix).${spin}
+    ++ (import ../../modules/system-list.nix).${spin}
     ++ (import "${toString confDir}/modules/module-list.nix").${spin}
     ++ (import "${toString confDir}/cluster/module-list.nix")
     ++ extraImports;
 in rec {
-  nixos = { name, config }:
+  nixos = { name, metaConfig }:
     let
-      swpins = swpinsFor { inherit name config; };
+      swpins = swpinsFor { inherit name metaConfig; };
     in
       { config, pkgs, ... }@args:
       {
         _module.args = makeModuleArgs {
-          inherit config swpins;
+          metaConfig = config;
+          inherit swpins;
           spin = "nixos";
           inherit name;
         };
@@ -55,14 +57,15 @@ in rec {
         ];
       };
 
-  vpsadminos = { name, config }:
+  vpsadminos = { name, metaConfig }:
     let
-      swpins = swpinsFor { inherit name config; };
+      swpins = swpinsFor { inherit name metaConfig; };
     in
       { config, pkgs, ... }@args:
       {
         _module.args = makeModuleArgs {
-          inherit config swpins;
+          metaConfig = config;
+          inherit swpins;
           spin = "vpsadminos";
           inherit name;
         };

data/nix/lib/machine/info.nix

@@ -1,5 +1,5 @@
-{ config, spin, name, findConfig, ... }:
-({ inherit name; } // findConfig {
-  inherit (config) cluster;
+{ metaConfig, spin, name, findMetaConfig, ... }:
+({ inherit name; } // findMetaConfig {
+  inherit (metaConfig) cluster;
   inherit name;
 })