confctl 2.0.0 → 2.1.0

data/nix/modules/confctl/carrier/netboot/build-netboot-server.rb

@@ -166,7 +166,7 @@ class NetbootBuilder
 
       link_path = File.join(LINK_DIR, v)
 
-      machines[name] ||= Machine.new(name)
+      machines[name] ||= Machine.new(@config, name)
       machines[name].add_generation(link_path, generation)
     end
 
@@ -255,6 +255,12 @@ class RootBuilder
       FileUtils.mkdir_p(File.join(root, v))
     end
   end
+
+  # Create a file within root
+  def write_to(path, content)
+    mkdir_p(File.dirname(path))
+    File.write(File.join(root, path), content)
+  end
 end
 
 class TftpBuilder < RootBuilder
@@ -301,10 +307,10 @@ class TftpBuilder < RootBuilder
         path = File.join('boot', m.fqdn, g.generation.to_s)
         mkdir_p(path)
 
-        Dir.entries(g.store_path).each do |v|
-          next unless %w[bzImage initrd].include?(v)
+        g.boot_files.each_value do |boot_file|
+          next unless %w[bzImage initrd].include?(boot_file.name)
 
-          ln_s(File.join(g.store_path, v), File.join(path, v))
+          ln_s(boot_file.path, File.join(path, boot_file.name))
         end
 
         ln_s(g.generation.to_s, File.join('boot', m.fqdn, 'current')) if g.current
@@ -432,7 +438,7 @@ class TftpBuilder < RootBuilder
 
       <% m.generations[1..].each do |g| -%>
       LABEL <%= m.fqdn %>-<%= g.generation %>
-        MENU LABEL Configuration <%= g.generation %> - <%= g.time_s %> - <%= g.shortrev %>
+        MENU LABEL Gen <%= g.generation %> - <%= g.time_s %> - <%= g.shortrev %>
         LINUX boot/<%= m.fqdn %>/<%= g.generation %>/bzImage
         INITRD boot/<%= m.fqdn %>/<%= g.generation %>/initrd
         APPEND init=<%= g.toplevel %>/init loglevel=7
@@ -496,47 +502,19 @@ class TftpBuilder < RootBuilder
   # @param root [Boolean] true if this is machine menu page, not generation menu
   # @param timeout [Integer, nil] timeout in seconds until the default action is taken
   def render_machine_vpsadminos_config(machine, generation:, file:, root:, timeout: nil)
-    variants = {
-      default: {
-        label: 'Default runlevel',
-        kernel_params: [],
-        runlevel: 'default'
-      },
-      nopools: {
-        label: 'Default runlevel without container imports',
-        kernel_params: ['osctl.pools=0'],
-        runlevel: 'default'
-      },
-      nostart: {
-        label: 'Default runlevel without container autostart',
-        kernel_params: ['osctl.autostart=0'],
-        runlevel: 'default'
-      },
-      rescue: {
-        label: 'Rescue runlevel (network and sshd)',
-        kernel_params: [],
-        runlevel: 'rescue'
-      },
-      single: {
-        label: 'Single-user runlevel (console only)',
-        kernel_params: [],
-        runlevel: 'single'
-      }
-    }
-
     tpl = <<~ERB
       <% if timeout -%>
       DEFAULT menu.c32
       TIMEOUT 50
       <% end -%>
-      MENU TITLE <%= m.label %> (<%= g.generation %> - <%= g.current ? 'current' : g.time_s %> - <%= g.shortrev %>)
+      MENU TITLE <%= m.short_label %> (<%= g.generation %> - <%= g.current ? 'current' : g.time_s %> - <%= g.shortrev %> - <%= g.kernel_version %>)
 
-      <% variants.each do |variant, vopts| -%>
-      LABEL <%= variant %>
-        MENU LABEL <%= vopts[:label] %>
+      <% g.variants.each do |variant| -%>
+      LABEL <%= variant.name %>
+        MENU LABEL <%= variant.label %>
         LINUX boot/<%= m.fqdn %>/<%= g.generation %>/bzImage
         INITRD boot/<%= m.fqdn %>/<%= g.generation %>/initrd
-        APPEND httproot=<%= File.join(http_url, m.fqdn, g.generation.to_s, 'root.squashfs') %> <%= g.kernel_params.join(' ') %> runlevel=<%= vopts[:runlevel] %> <%= vopts[:kernel_params].join(' ') %>
+        APPEND <%= g.kernel_params.join(' ') %> <%= variant.kernel_params.join(' ') %>
 
       <% end -%>
       LABEL <%= m.fqdn %>-generations
@@ -562,7 +540,6 @@ class TftpBuilder < RootBuilder
       {
         m: machine,
         g: generation,
-        variants:,
         http_url: @config.http_url,
         root:,
         timeout:,
@@ -579,7 +556,7 @@ class TftpBuilder < RootBuilder
 
       <% m.generations.each do |g| -%>
       LABEL generations
-        MENU LABEL Configuration <%= g.generation %> - <%= g.time_s %> - <%= g.shortrev %>
+        MENU LABEL Gen <%= g.generation %> - <%= g.time_s %> - <%= g.shortrev %> - <%= g.kernel_version %>
         KERNEL menu.c32
         APPEND pxeserver/machines/<%= m.fqdn %>/generation-<%= g.generation %>.cfg
 
@@ -640,19 +617,23 @@ class HttpBuilder < RootBuilder
   def build
     machines.each do |m|
       m.generations.each do |g|
-        begin
-          rootfs = File.realpath(File.join(g.link_path, 'root.squashfs'))
-        rescue Errno::ENOENT
-          next
+        gen_path = File.join(m.fqdn, g.generation.to_s)
+        mkdir_p(gen_path)
+
+        g.boot_files.each_value do |boot_file|
+          ln_s(boot_file.path, File.join(gen_path, boot_file.name))
         end
 
-        gen_path = File.join(m.fqdn, g.generation.to_s)
+        write_to(File.join(gen_path, 'generation.json'), JSON.pretty_generate(g))
+        write_to(File.join(gen_path, 'kernel-params'), g.kernel_params.join(' '))
 
-        mkdir_p(gen_path)
-        ln_s(rootfs, File.join(gen_path, 'root.squashfs'))
         ln_s(g.generation.to_s, File.join(m.fqdn, 'current')) if g.current
       end
+
+      write_to(File.join(m.fqdn, 'machine.json'), JSON.pretty_generate(m))
     end
+
+    write_to('machines.json', JSON.pretty_generate({ machines: }))
   end
 end
 
@@ -669,18 +650,27 @@ class Machine
   # @return [String]
   attr_reader :label
 
+  # @return [String]
+  attr_reader :short_label
+
+  # @return [String]
+  attr_reader :url
+
   # @return [Array<Generation>]
   attr_reader :generations
 
   # @return [Generation]
   attr_reader :current
 
+  # @param config [Config]
   # @param name [String] machine name
-  def initialize(name)
+  def initialize(config, name)
+    @config = config
     @name = name
     @spin = 'nixos'
     @fqdn = name
     @label = name
+    @short_label = name[0..14]
     @toplevel = nil
     @macs = []
     @generations = []
@@ -690,13 +680,29 @@ class Machine
   # @param link_path [String] Nix store path
   # @param generation [Integer]
   def add_generation(link_path, generation)
-    @generations << Generation.new(link_path, generation)
+    @generations << Generation.new(self, link_path, generation)
     nil
   end
 
   def resolve
     sort_generations
     load_json
+
+    @url = File.join(@config.http_url, fqdn)
+    generations.each(&:resolve)
+
+    nil
+  end
+
+  def to_json(*args)
+    {
+      url:,
+      name:,
+      spin:,
+      fqdn:,
+      label:,
+      generations:
+    }.to_json(*args)
   end
 
   protected
@@ -722,10 +728,15 @@ class Machine
     @label ||= @current.json.fetch('fqdn', nil)
     @label ||= name
     # rubocop:enable Naming/MemoizedInstanceVariableName
+
+    @short_label = @label.split('.')[0..1].join('.')
   end
 end
 
 class Generation
+  # @return [Machine]
+  attr_reader :machine
+
   # @return [String]
   attr_reader :link_path
 
@@ -741,9 +752,18 @@ class Generation
   # @return [String]
   attr_reader :time_s
 
+  # @return [String]
+  attr_reader :kernel_version
+
   # @return [Array<String>]
   attr_reader :kernel_params
 
+  # @return [Hash<String, BootFile>]
+  attr_reader :boot_files
+
+  # @return [Array<Variant>]
+  attr_reader :variants
+
   # @return [String] Nix store path to `config.system.build.toplevel`
   attr_reader :toplevel
 
@@ -765,9 +785,14 @@ class Generation
   # @return [Hash] contents of `machine.json`
   attr_reader :json
 
+  # @return [String]
+  attr_reader :url
+
+  # @param machine [Machine]
   # @param link_path [String] Nix store path
   # @param generation [Integer]
-  def initialize(link_path, generation)
+  def initialize(machine, link_path, generation)
+    @machine = machine
     @link_path = link_path
     @store_path = File.realpath(link_path)
     @generation = generation
@@ -789,6 +814,8 @@ class Generation
 
     @macs = json.fetch('macs', [])
 
+    @kernel_version = extract_kernel_version
+
     kernel_params_file = File.join(store_path, 'kernel-params')
 
     @kernel_params =
@@ -798,6 +825,138 @@ class Generation
         json.fetch('kernelParams', [])
       end
   end
+
+  def resolve
+    @url = File.join(machine.url, generation.to_s)
+    @boot_files = find_boot_files
+    @variants = Variant.for_machine(machine)
+
+    return if machine.spin != 'vpsadminos'
+
+    @kernel_params.insert(0, "httproot=#{boot_files['root.squashfs'].url}")
+  end
+
+  def to_json(*args)
+    {
+      url:,
+      store_path:,
+      generation:,
+      time: time.to_i,
+      time_s:,
+      current:,
+      toplevel:,
+      version:,
+      revision:,
+      shortrev:,
+      macs:,
+      kernel_version:,
+      kernel_params:,
+      boot_files:,
+      variants:,
+      swpins_info: json['swpins-info']
+    }.to_json(*args)
+  end
+
+  protected
+
+  def extract_kernel_version
+    link = File.readlink(File.join(toplevel, 'kernel'))
+    return unless %r{\A/nix/store/[^-]+-linux-([^/]+)} =~ link
+
+    ::Regexp.last_match(1)
+  rescue Errno::ENOENT
+    nil
+  end
+
+  def find_boot_files
+    %w[bzImage initrd root.squashfs].to_h do |name|
+      [name, BootFile.new(name, File.realpath(File.join(link_path, name)), File.join(url, name))]
+    rescue Errno::ENOENT
+      [name, nil]
+    end.compact
+  end
+end
+
+class BootFile
+  # @return [String]
+  attr_reader :name
+
+  # @return [String]
+  attr_reader :path
+
+  # @return [String]
+  attr_reader :url
+
+  def initialize(name, path, url)
+    @name = name
+    @path = path
+    @url = url
+  end
+
+  def to_json(*args)
+    url.to_json(*args)
+  end
+end
+
+class Variant
+  # @param machine [Machine]
+  # @return [Array<Variant>]
+  def self.for_machine(machine)
+    if machine.spin == 'vpsadminos'
+      [
+        new(
+          name: 'default',
+          label: 'Default runlevel',
+          kernel_params: ['runlevel=default']
+        ),
+        new(
+          name: 'nopools',
+          label: 'Default runlevel without container imports',
+          kernel_params: ['runlevel=default', 'osctl.pools=0']
+        ),
+        new(
+          name: 'nostart',
+          label: 'Default runlevel without container autostart',
+          kernel_params: ['runlevel=default', 'osctl.autostart=0']
+        ),
+        new(
+          name: 'rescue',
+          label: 'Rescue runlevel (network and sshd)',
+          kernel_params: ['runlevel=rescue']
+        ),
+        new(
+          name: 'single',
+          label: 'Single-user runlevel (console only)',
+          kernel_params: ['runlevel=single']
+        )
+      ]
+    else
+      []
+    end
+  end
+
+  # @return [String]
+  attr_reader :name
+
+  # @return [String]
+  attr_reader :label
+
+  # @return [String]
+  attr_reader :kernel_params
+
+  def initialize(name:, label:, kernel_params:)
+    @name = name
+    @label = label
+    @kernel_params = kernel_params
+  end
+
+  def to_json(*args)
+    {
+      name:,
+      label:,
+      kernel_params:
+    }.to_json(*args)
+  end
 end
 
 NetbootBuilder.run

data/nix/modules/confctl/kexec-netboot/default.nix

@@ -0,0 +1,36 @@
+{ config, lib, pkgs, confMachine, ... }:
+let
+  inherit (lib) mkEnableOption mkIf;
+
+  cfg = config.confctl.programs.kexec-netboot;
+
+  kexecNetboot = pkgs.substituteAll {
+    name = "kexec-netboot";
+    src = ./kexec-netboot.rb;
+    isExecutable = true;
+    ruby = pkgs.ruby;
+    kexecTools = pkgs.kexec-tools;
+    machineFqdn = confMachine.host.fqdn;
+  };
+
+  kexecNetbootBin = pkgs.runCommand "kexec-netboot-bin" {} ''
+    mkdir -p $out/bin
+    ln -s ${kexecNetboot} $out/bin/kexec-netboot
+
+    mkdir -p $out/share/man/man8
+    ${pkgs.asciidoctor}/bin/asciidoctor \
+      -b manpage \
+      -D $out/share/man/man8 \
+      ${./kexec-netboot.8.adoc}
+  '';
+in {
+  options  = {
+    confctl.programs.kexec-netboot = {
+      enable = mkEnableOption "Enable kexec-netboot utility";
+    };
+  };
+
+  config = mkIf cfg.enable {
+    environment.systemPackages = [ kexecNetbootBin ];
+  };
+}

data/nix/modules/confctl/kexec-netboot/kexec-netboot.8.adoc

@@ -0,0 +1,62 @@
+= kexec-netboot(8)
+:doctype: manpage
+:docdate: 2025-03-03
+:manmanual: kexec-netboot
+:mansource: kexec-netboot
+:man-linkstyle: pass:[blue R < >]
+
+== Name
+
+kexec-netboot - Prepare machine for kexec using kernel/initrd from netboot server
+
+== Synopsis
+
+*kexec-netboot* [_options_]
+
+== Description
+
+*kexec-netboot* may be used to download kernel and initrd from the netboot server
+the machine was booted from and load it using *kexec*.
+
+It is possible to boot into any machine available on the netboot server
+and to select generation and variant (default, single-user mode).
+
+== Options
+
+The following options are understood:
+
+*-h*, *--help*::
+  Print a short help text and exit.
+
+*-s*, *--server-url* _URL_::
+  Specify URL to the netboot server. By default, the URL is auto-detected
+  by reading *httproot* from */proc/cmdline*.
+
+*-m*, *--machine* _FQDN_::
+  Select machine from the netboot server.
+
+*-g*, *--generation* _GENERATION_::
+  Select machine generation identified by its number.
+
+*-v*, *--variant* _VARIANT_::
+  Select generation variant identified by its name.
+
+*-i*, *--interactive*::
+  Ask the user to select machine, generation and variant interactively.
+
+*-a*, *--append* _PARAMS_::
+  Append parameters to the kernel command line.
+
+*-u*, *--unload*::
+  Unload the current kexec target kernel and exit.
+
+*-e*, *--exec*::
+  Run the currently loaded kernel.
+
+== Bugs
+
+Report bugs to https://github.com/vpsfreecz/confctl/issues.
+
+== About
+
+*kexec-netboot* is a part of https://github.com/vpsfreecz/confctl[confctl].