confctl 1.0.0 → 2.1.0

data/lib/confctl/generation/build.rb

@@ -16,6 +16,9 @@ module ConfCtl
     # @return [String]
     attr_reader :toplevel
 
+    # @return [String]
+    attr_reader :auto_rollback
+
     # @return [Array<String>]
     attr_reader :swpin_names
 
@@ -29,22 +32,28 @@ module ConfCtl
     # @return [Boolean]
     attr_accessor :current
 
+    # @return [String, nil]
+    attr_reader :kernel_version
+
     # @param host [String]
     def initialize(host)
       @host = host
     end
 
     # @param toplevel [String]
+    # @param auto_rollback [String]
     # @param swpin_paths [Hash]
     # @param swpin_specs [Hash]
     # @param date [Time]
-    def create(toplevel, swpin_paths, swpin_specs, date: nil)
+    def create(toplevel, auto_rollback, swpin_paths, swpin_specs, date: nil)
       @toplevel = toplevel
+      @auto_rollback = auto_rollback
       @swpin_names = swpin_paths.keys
       @swpin_paths = swpin_paths
       @swpin_specs = swpin_specs
       @date = date || Time.now
       @name = date.strftime('%Y-%m-%d--%H-%M-%S')
+      @kernel_version = extract_kernel_version
     end
 
     # @param name [String]
@@ -53,6 +62,7 @@ module ConfCtl
 
       cfg = JSON.parse(File.read(config_path))
       @toplevel = cfg['toplevel']
+      @auto_rollback = cfg['auto_rollback']
 
       @swpin_names = []
       @swpin_paths = {}
@@ -69,6 +79,7 @@ module ConfCtl
       end
 
       @date = Time.iso8601(cfg['date'])
+      @kernel_version = extract_kernel_version
     rescue StandardError => e
       raise Error, "invalid generation '#{name}': #{e.message}"
     end
@@ -76,6 +87,7 @@ module ConfCtl
     def save
       FileUtils.mkdir_p(dir)
       File.symlink(toplevel, toplevel_path)
+      File.symlink(auto_rollback, auto_rollback_path)
 
       swpin_paths.each do |name, path|
         File.symlink(path, swpin_path(name))
@@ -85,6 +97,7 @@ module ConfCtl
         f.puts(JSON.pretty_generate({
           date: date.iso8601,
           toplevel:,
+          auto_rollback:,
           swpins: swpin_paths.to_h do |name, path|
             [name, { path:, spec: swpin_specs[name].as_json }]
           end
@@ -97,6 +110,13 @@ module ConfCtl
     def destroy
       remove_gcroot
       File.unlink(toplevel_path)
+
+      begin
+        File.unlink(auto_rollback_path)
+      rescue Errno::ENOENT
+        # Older generations might not have auto_rollback
+      end
+
       swpin_paths.each_key { |name| File.unlink(swpin_path(name)) }
       File.unlink(config_path)
       Dir.rmdir(dir)
@@ -104,6 +124,7 @@ module ConfCtl
 
     def add_gcroot
       GCRoot.add(gcroot_name('toplevel'), toplevel_path)
+      GCRoot.add(gcroot_name('auto_rollback'), auto_rollback_path)
       swpin_paths.each_key do |name|
         GCRoot.add(gcroot_name("swpin.#{name}"), toplevel_path)
       end
@@ -111,6 +132,7 @@ module ConfCtl
 
     def remove_gcroot
       GCRoot.remove(gcroot_name('toplevel'))
+      GCRoot.remove(gcroot_name('auto_rollback'))
       swpin_paths.each_key do |name|
         GCRoot.remove(gcroot_name("swpin.#{name}"))
       end
@@ -130,6 +152,10 @@ module ConfCtl
       @toplevel_path ||= File.join(dir, 'toplevel')
     end
 
+    def auto_rollback_path
+      @auto_rollback_path ||= File.join(dir, 'auto_rollback')
+    end
+
     def swpin_path(name)
       File.join(dir, "#{name}.swpin")
     end
@@ -141,5 +167,20 @@ module ConfCtl
     def gcroot_name(file)
       "#{escaped_host}-generation-#{name}-#{file}"
     end
+
+    def extract_kernel_version
+      # `kernel` is for NixOS/vpsAdminOS and also carried NixOS machines (netboot)
+      # `bzImage` is for carried vpsAdminOS machines (netboot)
+      %w[kernel bzImage].each do |v|
+        link = File.readlink(File.join(toplevel, v))
+        next unless %r{\A/nix/store/[^-]+-linux-([^/]+)} =~ link
+
+        return ::Regexp.last_match(1)
+      rescue Errno::ENOENT, Errno::EINVAL
+        next
+      end
+
+      nil
+    end
   end
 end

data/lib/confctl/generation/build_list.rb

@@ -55,6 +55,16 @@ module ConfCtl
       index[name]
     end
 
+    # @param offset [Integer] 0 = current/last, 1 = first (oldest), -1 = before last
+    # @return [Generation::Build]
+    def at_offset(offset)
+      if offset == 0
+        generations.last
+      else
+        generations[offset - 1]
+      end
+    end
+
     def each(&)
       generations.each(&)
     end

data/lib/confctl/generation/host.rb

@@ -1,19 +1,22 @@
 module ConfCtl
   class Generation::Host
-    attr_reader :host, :profile, :id, :toplevel, :date, :current
+    attr_reader :host, :profile, :id, :toplevel, :date, :kernel_version, :current
 
-    # @param host [String]
+    # @param machine [Machine]
     # @param profile [String]
     # @param id [Integer]
     # @param toplevel [String]
     # @param date [Time]
+    # @param kernel_version [String, nil]
     # @param mc [MachineControl]
-    def initialize(host, profile, id, toplevel, date, current: false, mc: nil)
-      @host = host
+    def initialize(machine, profile, id, toplevel, date, kernel_version, current: false, mc: nil)
+      @host = machine.name
+      @machine = machine
       @profile = profile
       @id = id
       @toplevel = toplevel
       @date = date
+      @kernel_version = kernel_version
       @current = current
       @mc = mc
     end
@@ -25,7 +28,8 @@ module ConfCtl
     def destroy
       raise 'machine control not available' if mc.nil?
 
-      mc.execute('nix-env', '-p', profile, '--delete-generations', id.to_s)
+      env_cmd = @machine.carried? ? 'carrier-env' : 'nix-env'
+      mc.execute(env_cmd, '-p', profile, '--delete-generations', id.to_s)
     end
 
     protected

data/lib/confctl/generation/host_list.rb

@@ -1,24 +1,33 @@
 module ConfCtl
   class Generation::HostList
+    # @parma machine [Machine]
     # @param mc [MachineControl]
+    # @param profile [String]
     # @return [Generation::HostList]
-    def self.fetch(mc, profile: '/nix/var/nix/profiles/system')
-      out, = mc.bash_script(<<-END
+    def self.fetch(machine, mc, profile:)
+      out, = mc.bash_script(<<~END)
         realpath #{profile}
 
         for generation in `ls -d -1 #{profile}-*-link` ; do
-          echo "$generation;$(readlink $generation);$(stat --format=%Y $generation)"
+          echo -n "$generation;"
+          echo -n "$(readlink $generation);"
+          echo -n "$(stat --format=%Y $generation);"
+
+          for kernel_file in kernel bzImage ; do
+            [ -h "$generation/$kernel_file" ] && echo -n $(readlink "$generation/$kernel_file")
+          done
+
+          echo
         done
       END
-                           )
 
-      list = new(mc.machine.name)
+      list = new(machine.name)
       lines = out.strip.split("\n")
       current_path = lines.shift
       id_rx = /^#{Regexp.escape(profile)}-(\d+)-link$/
 
       lines.each do |line|
-        link, path, created_at = line.split(';')
+        link, path, created_at, kernel = line.split(';')
 
         if id_rx =~ link
           id = ::Regexp.last_match(1).to_i
@@ -27,12 +36,18 @@ module ConfCtl
           next
         end
 
+        kernel_version =
+          if kernel && %r{\A/nix/store/[^-]+-linux-([^/]+)} =~ kernel
+            ::Regexp.last_match(1)
+          end
+
         list << Generation::Host.new(
-          mc.machine.name,
+          machine,
           profile,
           id,
           path,
           Time.at(created_at.to_i),
+          kernel_version,
           current: path == current_path,
           mc:
         )

data/lib/confctl/generation/unified.rb

@@ -15,6 +15,9 @@ module ConfCtl
     # @return [Time]
     attr_reader :date
 
+    # @return [String, nil]
+    attr_reader :kernel_version
+
     # @return [Boolean]
     attr_reader :current
 
@@ -37,11 +40,13 @@ module ConfCtl
         @name = build_generation.name
         @toplevel = build_generation.toplevel
         @date = build_generation.date
+        @kernel_version = build_generation.kernel_version
         @current ||= build_generation.current
       elsif host_generation
         @name = host_generation.approx_name
         @toplevel = host_generation.toplevel
         @date = host_generation.date
+        @kernel_version = host_generation.kernel_version
         @current ||= host_generation.current
       else
         raise ArgumentError, 'set build or host'

data/lib/confctl/generation/unified_list.rb

@@ -46,6 +46,16 @@ module ConfCtl
       generations.each(&)
     end
 
+    # @param offset [Integer] 0 = current/last, 1 = first (oldest), -1 = before last
+    # @return [Generation::Unified]
+    def at_offset(offset)
+      if offset == 0
+        generations.last
+      else
+        generations[offset - 1]
+      end
+    end
+
     def delete_if(&)
       generations.delete_if(&)
     end

data/lib/confctl/git_repo_mirror.rb

@@ -14,13 +14,13 @@ module ConfCtl
       @cmd = SystemCommand.new
     end
 
-    def setup
+    def setup(ref: nil)
       File.stat(mirror_path)
     rescue Errno::ENOENT
       FileUtils.mkdir_p(mirror_path)
       git('clone', args: ['--mirror', url, mirror_path])
     else
-      git_repo('fetch')
+      git_repo('fetch', opts: ['--no-show-forced-updates'], args: (ref ? ['origin', ref] : []))
     end
 
     def revision_parse(str)

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?
 
@@ -28,12 +116,16 @@ module ConfCtl
       end
     end
 
+    def auto_rollback?
+      meta.fetch('autoRollback', {}).fetch('enable', true)
+    end
+
     def health_checks
       return @health_checks if @health_checks
 
       @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 +168,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

@@ -6,10 +6,11 @@ module ConfCtl
     attr_reader :machine
 
     # @param machine [Machine]
-    def initialize(machine)
+    # @param logger [#<<]
+    def initialize(machine, logger: nil)
       @machine = machine
       @extra_ssh_opts = []
-      @cmd = SystemCommand.new
+      @cmd = SystemCommand.new(logger:)
     end
 
     # Try to open SSH connection
@@ -108,6 +109,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]
@@ -79,11 +90,17 @@ module ConfCtl
       !empty?
     end
 
+    def to_a
+      @machines.values
+    end
+
     # @return [Array<HealthChecks::Base>]
     def health_checks
       checks = []
 
       machines.each_value do |machine|
+        next if machine.carried?
+
         checks.concat(machine.health_checks)
       end
 
@@ -101,7 +118,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(machine, 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