confctl 1.0.0 → 2.0.0

data/lib/confctl/machine.rb

@@ -1,26 +1,114 @@
 module ConfCtl
   class Machine
-    attr_reader :name, :safe_name, :managed, :spin, :opts
+    CarriedMachine = Struct.new(
+      :carrier,
+      :name,
+      :alias,
+      :attribute,
+      keyword_init: true
+    )
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :safe_name
+
+    # @return [Boolean]
+    attr_reader :managed
+
+    # @return [String]
+    attr_reader :spin
+
+    # @return [String]
+    attr_reader :carrier_name
+
+    # @return [String]
+    attr_reader :cluster_name
+
+    # @return [String]
+    attr_reader :safe_cluster_name
+
+    # Alias for this machine on the carrier
+    # @return [String]
+    attr_reader :carried_alias
+
+    # Alias for this machine on the carrier
+    # @return [String]
+    attr_reader :safe_carried_alias
+
+    # @return [Hash] machine metadata
+    attr_reader :meta
 
     # @param opts [Hash]
-    def initialize(opts)
-      @opts = opts
+    # @param machine_list [MachineList]
+    def initialize(opts, machine_list:)
+      @meta = opts['metaConfig']
       @name = opts['name']
-      @safe_name = opts['name'].gsub('/', ':')
-      @managed = opts['managed']
-      @spin = opts['spin']
+      @safe_name = name.gsub('/', ':')
+      @managed = meta['managed']
+      @spin = meta['spin']
+      @is_carrier = meta.fetch('carrier', {}).fetch('enable', false)
+      @carrier_name = opts['carrier']
+      @cluster_name = opts['clusterName']
+      @safe_cluster_name = cluster_name.gsub('/', ':')
+      @carried_alias = opts['alias'] || @cluster_name
+      @safe_carried_alias = @carried_alias.gsub('/', ':')
+      @machine_list = machine_list
+    end
+
+    # True if this machine carries other machines
+    def carrier?
+      @is_carrier
+    end
+
+    # @return [Array<CarriedMachine>]
+    def carried_machines
+      meta.fetch('carrier', {}).fetch('machines', []).map do |m|
+        CarriedMachine.new(
+          carrier: self,
+          name: m['machine'],
+          alias: m['alias'] || m['machine'],
+          attribute: m['attribute']
+        )
+      end
+    end
+
+    # True if this machine is on a carrier
+    def carried?
+      !@carrier_name.nil?
+    end
+
+    # @return [Machine] carrier
+    def carrier_machine
+      carrier = @machine_list[@carrier_name]
+
+      if carrier.nil?
+        raise "Carrier #{@carrier_name} not found in machine list"
+      end
+
+      carrier
     end
 
     def target_host
-      (opts['host'] && opts['host']['target']) || name
+      meta.fetch('host', {}).fetch('target', name)
     end
 
     def localhost?
       target_host == 'localhost'
     end
 
+    # @return [String] path to nix-env managed profile
+    def profile
+      if carried?
+        "/nix/var/nix/profiles/confctl-#{safe_carried_alias}"
+      else
+        '/nix/var/nix/profiles/system'
+      end
+    end
+
     def nix_paths
-      opts['nix']['nixPath'].to_h do |v|
+      meta['nix']['nixPath'].to_h do |v|
         eq = v.index('=')
         raise "'#{v}' is not a valid nix path entry " if eq.nil?
 
@@ -33,7 +121,7 @@ module ConfCtl
 
       @health_checks = []
 
-      opts['healthChecks'].each do |type, checks|
+      meta['healthChecks'].each do |type, checks|
         case type
         when 'systemd'
           next if !checks['enable'] || spin != 'nixos'
@@ -76,11 +164,13 @@ module ConfCtl
 
     def [](key)
       if key.index('.')
-        get(opts, key.split('.'))
+        get(meta, key.split('.'))
+      elsif key == 'name'
+        name
       elsif key == 'checks'
         health_checks.length
       else
-        opts[key]
+        meta[key]
       end
     end
 

data/lib/confctl/machine_control.rb

@@ -108,6 +108,13 @@ module ConfCtl
       out.strip
     end
 
+    # @param path [String]
+    # @return [String]
+    def read_realpath(path)
+      out, = run_cmd('realpath', path)
+      out.strip
+    end
+
     # Execute command, raises exception on error
     # @yieldparam out [String]
     # @yieldparam err [String]

data/lib/confctl/machine_list.rb

@@ -46,6 +46,12 @@ module ConfCtl
       machines.map(&)
     end
 
+    # @yieldparam [Machine] machine
+    # @return [Hash]
+    def transform_values(&)
+      machines.transform_values(&)
+    end
+
     # @return [MachineList]
     def managed
       select { |_host, machine| machine.managed }
@@ -56,6 +62,11 @@ module ConfCtl
       select { |_host, machine| !machine.managed }
     end
 
+    # @return [MachineList]
+    def runnable
+      select { |_host, machine| !machine.carried? && machine.target_host }
+    end
+
     # @param host [String]
     def [](host)
       @machines[host]
@@ -84,6 +95,8 @@ module ConfCtl
       checks = []
 
       machines.each_value do |machine|
+        next if machine.carried?
+
         checks.concat(machine.health_checks)
       end
 
@@ -101,7 +114,7 @@ module ConfCtl
 
     def parse(data)
       data.transform_values do |info|
-        Machine.new(info)
+        Machine.new(info, machine_list: self)
       end
     end
   end

data/lib/confctl/machine_status.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'tty-command'
 
 module ConfCtl
@@ -81,7 +82,7 @@ module ConfCtl
     # @param machine [Machine]
     def initialize(machine)
       @machine = machine
-      @mc = MachineControl.new(machine)
+      @mc = MachineControl.new(machine.carried? ? machine.carrier_machine : machine)
     end
 
     # Connect to the machine and query its state
@@ -94,7 +95,7 @@ module ConfCtl
 
       if toplevel
         begin
-          @current_toplevel = mc.read_symlink('/run/current-system')
+          @current_toplevel = query_toplevel
         rescue TTY::Command::ExitError
           return
         end
@@ -102,14 +103,14 @@ module ConfCtl
 
       if generations
         begin
-          @generations = Generation::HostList.fetch(mc)
+          @generations = Generation::HostList.fetch(mc, profile: machine.profile)
         rescue TTY::Command::ExitError
           return
         end
       end
 
       begin
-        @swpins_info = Swpins::DeployedInfo.parse!(mc.read_file('/etc/confctl/swpins-info.json'))
+        @swpins_info = query_swpins
       rescue Error
         nil
       end
@@ -131,5 +132,51 @@ module ConfCtl
     protected
 
     attr_reader :mc
+
+    def query_toplevel
+      path =
+        if machine.carried?
+          machine.profile
+        else
+          '/run/current-system'
+        end
+
+      mc.read_realpath(path)
+    end
+
+    def query_swpins
+      json =
+        if machine.carried?
+          query_carried_swpins
+        else
+          mc.read_file('/etc/confctl/swpins-info.json')
+        end
+
+      case json
+      when String
+        Swpins::DeployedInfo.parse!(json)
+      when Hash
+        json
+      end
+    end
+
+    # @return [Hash, String]
+    def query_carried_swpins
+      begin
+        json = mc.read_file(File.join(machine.profile, 'machine.json'))
+        parsed = JSON.parse(json)
+        return parsed['swpins-info'] if parsed['swpins-info']
+      rescue TTY::Command::ExitError
+        # pass
+      end
+
+      begin
+        return mc.read_file(File.join(machine.profile, '/etc/confctl/swpins-info.json'))
+      rescue TTY::Command::ExitError
+        # pass
+      end
+
+      nil
+    end
   end
 end

data/lib/confctl/nix.rb

@@ -15,10 +15,11 @@ module ConfCtl
 
     include Utils::File
 
-    def initialize(conf_dir: nil, show_trace: false, max_jobs: nil)
+    def initialize(conf_dir: nil, show_trace: false, max_jobs: nil, cores: nil)
       @conf_dir = conf_dir || ConfDir.path
       @show_trace = show_trace
       @max_jobs = max_jobs || Settings.instance.max_jobs
+      @cores = cores
       @cmd = SystemCommand.new
     end
 
@@ -40,6 +41,7 @@ module ConfCtl
             '--out-link', out_link,
             (show_trace ? '--show-trace' : nil),
             (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+            (cores ? ['--cores', cores.to_s] : nil),
             ConfCtl.nix_asset('evaluator.nix')
           ].flatten.compact
 
@@ -88,6 +90,7 @@ module ConfCtl
             '--out-link', out_link,
             (show_trace ? '--show-trace' : nil),
             (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+            (cores ? ['--cores', cores.to_s] : nil),
             ConfCtl.nix_asset('evaluator.nix')
           ].flatten.compact
 
@@ -124,6 +127,7 @@ module ConfCtl
           '--out-link', out_link,
           (show_trace ? '--show-trace' : nil),
           (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
           ConfCtl.nix_asset('evaluator.nix')
         ].flatten.compact
 
@@ -154,6 +158,7 @@ module ConfCtl
           '--out-link', out_link,
           (show_trace ? '--show-trace' : nil),
           (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
           ConfCtl.nix_asset('evaluator.nix')
         ].flatten.compact
 
@@ -165,7 +170,7 @@ module ConfCtl
 
     # Build config.system.build.toplevel for selected hosts
     #
-    # @param hosts [Array<String>]
+    # @param hosts [Array<Machine>]
     # @param swpin_paths [Hash]
     # @param host_swpin_specs [Hash]
     # @param time [Time]
@@ -176,7 +181,7 @@ module ConfCtl
     # @yieldparam path [String]
     #
     # @return [Hash<String, Generation::Build>]
-    def build_toplevels(hosts: [], swpin_paths: {}, host_swpin_specs: {}, time: nil, &block)
+    def build_attributes(hosts: [], swpin_paths: {}, host_swpin_specs: {}, time: nil, &block)
       with_argument({
         confDir: conf_dir,
         build: :toplevel,
@@ -191,6 +196,7 @@ module ConfCtl
           '--out-link', out_link,
           (show_trace ? '--show-trace' : nil),
           (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
           ConfCtl.nix_asset('evaluator.nix')
         ].flatten.compact
 
@@ -236,6 +242,9 @@ module ConfCtl
     def copy(machine, toplevel, &)
       if machine.localhost?
         true
+      elsif machine.carried?
+        cp = NixCopy.new(machine.carrier_machine.target_host, toplevel)
+        cp.run!(&).success?
       else
         cp = NixCopy.new(machine.target_host, toplevel)
         cp.run!(&).success?
@@ -258,13 +267,26 @@ module ConfCtl
     def set_profile(machine, toplevel)
       args = [
         'nix-env',
-        '-p', '/nix/var/nix/profiles/system',
+        '-p', machine.profile,
         '--set', toplevel
       ]
 
       MachineControl.new(machine).execute!(*args).success?
     end
 
+    # @param machine [Machine]
+    # @param toplevel [String]
+    # @return [Boolean]
+    def set_carried_profile(machine, toplevel)
+      args = [
+        'carrier-env',
+        '-p', machine.profile,
+        '--set', toplevel
+      ]
+
+      MachineControl.new(machine.carrier_machine).execute!(*args).success?
+    end
+
     # @param packages [Array<String>]
     # @param command [String]
     # @return [Boolean]
@@ -292,7 +314,7 @@ module ConfCtl
 
     protected
 
-    attr_reader :conf_dir, :show_trace, :max_jobs, :cmd
+    attr_reader :conf_dir, :show_trace, :max_jobs, :cores, :cmd
 
     # Execute block only if `out_link` does not exist or conf dir has changed
     # @param out_link [String] out link path
@@ -357,6 +379,7 @@ module ConfCtl
           '--arg', 'jsonArg', arg,
           (show_trace ? '--show-trace' : nil),
           (max_jobs ? ['--max-jobs', max_jobs.to_s] : nil),
+          (cores ? ['--cores', cores.to_s] : nil),
           ConfCtl.nix_asset('evaluator.nix')
         ].flatten.compact
 

data/lib/confctl/swpins/specs/git.rb

@@ -103,7 +103,7 @@ module ConfCtl
 
     def prefetch_github(ref)
       mirror = GitRepoMirror.new(nix_opts['url'])
-      mirror.setup
+      mirror.setup(ref:)
 
       rev = mirror.revision_parse(ref)
       url = File.join(nix_opts['url'], 'archive', "#{rev}.tar.gz")

data/lib/confctl/version.rb

@@ -1,3 +1,3 @@
 module ConfCtl
-  VERSION = '1.0.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

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

@@ -1,4 +1,4 @@
-.TH confctl\-options.nix 8           2024\-02\-17                             master
+.TH confctl\-options.nix 8           2024\-05\-07                             master
 .SH NAME
 .PP
 \fB\fCconfctl\-options.nix\fR \- confctl configuration documentation
@@ -599,6 +599,22 @@ Address with prefix as string
 .PP
     \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
 .TP
+\fB\fCcluster.<name>.buildAttribute\fR
+Path to the attribute in machine system config that should be built
+.IP
+For example, \fB\fC[ "system" "build" "toplevel" ]\fR will select attribute
+\fB\fCconfig.system.build.toplevel\fR\&.
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fC[
+  "system"
+  "build"
+  "toplevel"
+]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
 \fB\fCcluster.<name>.buildGenerations.max\fR
 The maximum number of build generations to be kept on the build
 machine.
@@ -632,6 +648,151 @@ machine.
 .PP
     \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
 .TP
+\fB\fCcluster.<name>.carrier.enable\fR
+Whether to enable This machine is a carrier for other machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIExample:\fP \fB\fCtrue\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines\fR
+List of carried machines
+.PP
+    \fIType:\fP list of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.alias\fR
+Alias for carried machine name
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.buildAttribute\fR
+Path to the attribute in machine system config that should be built
+.IP
+For example, \fB\fC[ "system" "build" "toplevel" ]\fR will select attribute
+\fB\fCconfig.system.build.toplevel\fR\&.
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fC[
+  "system"
+  "build"
+  "toplevel"
+]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.buildGenerations.max\fR
+The maximum number of build generations to be kept on the build
+machine.
+.PP
+    \fIType:\fP null or signed integer
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.buildGenerations.maxAge\fR
+Delete build generations older than
+\fB\fCcluster.<name>.carrier.machines.*.buildGenerations.maxAge\fR
+seconds from the build machine. Old generations are deleted even
+if \fB\fCcluster.<name>.carrier.machines.*.buildGenerations.max\fR is
+not reached.
+.PP
+    \fIType:\fP null or signed integer
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.buildGenerations.min\fR
+The minimum number of build generations to be kept on the build
+machine.
+.PP
+    \fIType:\fP null or signed integer
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.extraModules\fR
+A list of additional NixOS modules to be imported for this machine
+.PP
+    \fIType:\fP list of path
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.hostGenerations.max\fR
+The maximum number of generations to be kept on the machine.
+.PP
+    \fIType:\fP null or signed integer
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.hostGenerations.maxAge\fR
+Delete generations older than
+\fB\fCcluster.<name>.carrier.machines.*.hostGenerations.maxAge\fR
+seconds from the machine. Old generations are deleted even
+if \fB\fCcluster.<name>.carrier.machines.*.hostGenerations.max\fR is
+not reached.
+.PP
+    \fIType:\fP null or signed integer
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.hostGenerations.min\fR
+The minimum number of generations to be kept on the machine.
+.PP
+    \fIType:\fP null or signed integer
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.labels\fR
+Optional user\-defined labels to classify the machine
+.PP
+    \fIType:\fP attribute set
+.PP
+    \fIDefault:\fP \fB\fC{ }\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.machine\fR
+Machine name
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.carrier.machines.*.tags\fR
+Optional user\-defined tags to classify the machine
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
 \fB\fCcluster.<name>.healthChecks.builderCommands\fR
 Check commands run on the build machine
 .PP
@@ -1032,6 +1193,9 @@ Host name
 .TP
 \fB\fCcluster.<name>.host.target\fR
 Address/host to which the configuration is deployed to
+.IP
+Set to null if the machine is not deployable, e.g. when it is only used
+as a carried machine.
 .PP
     \fIType:\fP null or string
 .PP