confctl 1.0.0 → 2.1.0

data/nix/modules/cluster/default.nix

@@ -46,7 +46,7 @@ let
 
         addresses = mkOption {
           type = types.nullOr (types.submodule addresses);
-          default = null;
+          default = {};
           description = ''
             IP addresses
           '';
@@ -63,6 +63,29 @@ let
           };
         };
 
+        buildAttribute = mkOption {
+          type = types.listOf types.str;
+          default = [ "system" "build" "toplevel" ];
+          description = ''
+            Path to the attribute in machine system config that should be built
+
+            For example, `[ "system" "build" "toplevel" ]` will select attribute
+            `config.system.build.toplevel`.
+          '';
+        };
+
+        carrier = {
+          enable = mkEnableOption "This machine is a carrier for other machines";
+
+          machines = mkOption {
+            type = types.listOf (types.submodule carriedMachine);
+            default = [];
+            description = ''
+              List of carried machines
+            '';
+          };
+        };
+
         host = mkOption {
           type = types.nullOr (types.submodule host);
           default = null;
@@ -163,6 +186,26 @@ let
           };
         };
 
+        autoRollback = {
+          enable = mkOption {
+            type = types.bool;
+            default = true;
+            description = ''
+              Enable automatic rollback in case the machine is unresponsive after
+              deploy
+            '';
+          };
+
+          timeout = mkOption {
+            type = types.int;
+            default = 60;
+            description = ''
+              Number of seconds after which if the machine is unreachable, auto-rollback
+              is initiated
+            '';
+          };
+        };
+
         healthChecks = {
           systemd = {
             enable = mkOption {
@@ -321,11 +364,11 @@ let
             Host FQDN
           '';
           apply = v:
-            if isNull v && !isNull config.name && !isNull config.domain then
+            if isNull v && !isNull config.name then
               concatStringsSep "." (
                 [ config.name ]
                 ++ (optional (!isNull config.location) config.location)
-                ++ [ config.domain ]
+                ++ (optional (!isNull config.domain) config.domain)
               )
             else
               v;
@@ -336,8 +379,124 @@ let
           default = config.fqdn;
           description = ''
             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.
+          '';
+        };
+      };
+    };
+
+  carriedMachine =
+    { config, ... }:
+    {
+      options = {
+        machine = mkOption {
+          type = types.str;
+          description = "Machine name";
+        };
+
+        alias = mkOption {
+          type = types.nullOr types.str;
+          description = "Alias for carried machine name";
+        };
+
+        labels = mkOption {
+          type = types.attrs;
+          default = {};
+          description = ''
+            Optional user-defined labels to classify the machine
+          '';
+        };
+
+        tags = mkOption {
+          type = types.listOf types.str;
+          default = [];
+          description = ''
+            Optional user-defined tags to classify the machine
+          '';
+        };
+
+        extraModules = mkOption {
+          type = types.listOf types.path;
+          default = [];
+          description = ''
+            A list of additional NixOS modules to be imported for this machine
+          '';
+        };
+
+        buildAttribute = mkOption {
+          type = types.listOf types.str;
+          default = [ "system" "build" "toplevel" ];
+          description = ''
+            Path to the attribute in machine system config that should be built
+
+            For example, `[ "system" "build" "toplevel" ]` will select attribute
+            `config.system.build.toplevel`.
           '';
         };
+
+        buildGenerations = {
+          min = mkOption {
+            type = types.nullOr types.int;
+            default = null;
+            description = ''
+              The minimum number of build generations to be kept on the build
+              machine.
+            '';
+          };
+
+          max = mkOption {
+            type = types.nullOr types.int;
+            default = null;
+            description = ''
+              The maximum number of build generations to be kept on the build
+              machine.
+            '';
+          };
+
+          maxAge = mkOption {
+            type = types.nullOr types.int;
+            default = null;
+            description = ''
+              Delete build generations older than
+              <option>cluster.&lt;name&gt;.carrier.machines.*.buildGenerations.maxAge</option>
+              seconds from the build machine. Old generations are deleted even
+              if <option>cluster.&lt;name&gt;.carrier.machines.*.buildGenerations.max</option> is
+              not reached.
+            '';
+          };
+        };
+
+        hostGenerations = {
+          min = mkOption {
+            type = types.nullOr types.int;
+            default = null;
+            description = ''
+              The minimum number of generations to be kept on the machine.
+            '';
+          };
+
+          max = mkOption {
+            type = types.nullOr types.int;
+            default = null;
+            description = ''
+              The maximum number of generations to be kept on the machine.
+            '';
+          };
+
+          maxAge = mkOption {
+            type = types.nullOr types.int;
+            default = null;
+            description = ''
+              Delete generations older than
+              <option>cluster.&lt;name&gt;.carrier.machines.*.hostGenerations.maxAge</option>
+              seconds from the machine. Old generations are deleted even
+              if <option>cluster.&lt;name&gt;.carrier.machines.*.hostGenerations.max</option> is
+              not reached.
+            '';
+          };
+        };
       };
     };
 

data/nix/modules/confctl/carrier/base.nix

@@ -0,0 +1,35 @@
+{ config, pkgs, lib, confMachine, ... }:
+let
+  inherit (lib) mkIf mkOption types;
+
+  cfg = config.confctl.carrier;
+
+  carrier-env = pkgs.substituteAll {
+    src = ./carrier-env.rb;
+    name = "carrier-env";
+    isExecutable = true;
+    dir = "bin";
+    ruby = pkgs.ruby;
+    onChangeCommands = pkgs.writeScript "carrier-on-change-commands.sh" ''
+      #!${pkgs.bash}/bin/bash
+      ${cfg.onChangeCommands}
+    '';
+  };
+in {
+  options = {
+    confctl.carrier.onChangeCommands = mkOption {
+      type = types.lines;
+      default = "";
+      description = ''
+        Extra commands executed on a carrier machine when carried machine
+        is deployed or removed
+      '';
+    };
+  };
+
+  config = mkIf confMachine.carrier.enable {
+    environment.systemPackages = [
+      carrier-env
+    ];
+  };
+}

data/nix/modules/confctl/carrier/carrier-env.rb

@@ -0,0 +1,81 @@
+#!@ruby@/bin/ruby
+require 'optparse'
+
+class CarrierEnv
+  ON_CHANGE_COMMANDS = '@onChangeCommands@'.freeze
+
+  def self.run(args)
+    env = new
+    env.run(args)
+  end
+
+  def initialize
+    @action = nil
+    @profile = nil
+    @generation = nil
+
+    @optparser = OptionParser.new do |parser|
+      parser.banner = "Usage: #{$0} <options>"
+
+      parser.on('-p', '--profile PROFILE', 'Profile path') do |v|
+        @profile = v
+      end
+
+      parser.on('--set GENERATION', 'Set profile to generation') do |v|
+        @action = :set
+        @generation = v
+      end
+
+      parser.on('--delete-generations GENERATIONS', 'Delete generations') do |v|
+        @action = :delete
+        @generation = v
+      end
+    end
+  end
+
+  def run(args)
+    @optparser.parse!(args)
+
+    if args.any?
+      warn 'Too many arguments'
+      puts parser
+      exit(false)
+    elsif @action.nil?
+      warn 'No action specified'
+      exit(false)
+    elsif @profile.nil?
+      warn 'Profile not set'
+      exit(false)
+    end
+
+    send(:"run_#{@action}")
+  end
+
+  protected
+
+  def run_set
+    nix_env('--set', @generation)
+    on_change_commands
+  end
+
+  def run_delete
+    nix_env('--delete-generations', @generation)
+    on_change_commands
+  end
+
+  def nix_env(*args)
+    system_command('nix-env', '-p', @profile, *args)
+  end
+
+  def on_change_commands
+    system_command(ON_CHANGE_COMMANDS)
+  end
+
+  def system_command(*args)
+    return if Kernel.system(*args)
+
+    raise "#{args.join(' ')} failed"
+  end
+end
+
+CarrierEnv.run(ARGV)