confctl 2.0.0 → 2.1.0

data/man/man8/confctl.8

@@ -37,6 +37,11 @@ for more information.
 similarly to shell patterns, see
 \[la]http://ruby-doc.org/core/File.html#method-c-fnmatch-3F\[ra] for more
 information.
+.SH GENERATION OFFSETS
+.PP
+Generations can be selected by \fIoffset\fP\&. \fB\fC0\fR is the current (last) generation.
+\fB\fC1\fR is the first (oldest) generation, \fB\fC2\fR the second generation, etc. \fB\fC\-1\fR is
+the generation before last and so on.
 .SH GLOBAL OPTIONS
 .TP
 \fB\fC\-c\fR, \fB\fC\-\-color\fR \fB\fCalways\fR|\fB\fCnever\fR|\fB\fCauto\fR
@@ -139,7 +144,7 @@ the target machine. The default action is \fB\fCswitch\fR\&.
     \fB\fC\-y\fR, \fB\fC\-\-yes\fR
       Do not ask for confirmation on standard input, assume the answer is yes.
 .PP
-    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fB\fCcurrent\fR
+    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fIoffset\fP|\fB\fCcurrent\fR
       Do not build a new generation, but deploy an existing generation.
 .PP
     \fB\fC\-\-outdated\fR
@@ -169,6 +174,12 @@ the target machine. The default action is \fB\fCswitch\fR\&.
 .PP
     \fB\fC\-\-copy\-only\fR
       Do not activate the copied closures.
+.PP
+    \fB\fC\-\-enable\-auto\-rollback\fR
+      Enable auto\-rollback on deploy even if it is not enabled in machine configuration.
+.PP
+    \fB\fC\-\-disable\-auto\-rollback\fR
+      Disable auto\-rollback on deploy if it is enabled in machine configuration.
 .PP
     \fB\fC\-\-reboot\fR
       Applicable only when \fIswitch\-action\fP is \fB\fCboot\fR\&. Reboot the machine after the
@@ -226,7 +237,7 @@ Probe managed machines and determine their status.
     \fB\fC\-y\fR, \fB\fC\-\-yes\fR
       Do not ask for confirmation on standard input, assume the answer is yes.
 .PP
-    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fB\fCcurrent\fR|\fB\fCnone\fR
+    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fIoffset\fP|\fB\fCcurrent\fR|\fB\fCnone\fR
       Check status against a selected generation instead of a new build. If set
       to \fB\fCnone\fR, only the currently configured software pins are checked and not
       the system version itself.
@@ -264,7 +275,7 @@ itself, it works only on software pins.
     \fB\fC\-y\fR, \fB\fC\-\-yes\fR
       Do not ask for confirmation on standard input, assume the answer is yes.
 .PP
-    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fB\fCcurrent\fR
+    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fIoffset\fP|\fB\fCcurrent\fR
       Show changelog against software pins from a selected generation instead
       of the current configuration.
 .PP
@@ -312,7 +323,7 @@ itself, it works only on software pins.
     \fB\fC\-y\fR, \fB\fC\-\-yes\fR
       Do not ask for confirmation on standard input, assume the answer is yes.
 .PP
-    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fB\fCcurrent\fR
+    \fB\fC\-g\fR, \fB\fC\-\-generation\fR \fIgeneration\fP|\fIoffset\fP|\fB\fCcurrent\fR
       Show diff against software pins from a selected generation instead
       of the current configuration.
 .PP
@@ -406,7 +417,7 @@ Open ClusterSSH to selected or all machines.
     \fB\fC\-y\fR, \fB\fC\-\-yes\fR
       Do not ask for confirmation on standard input, assume the answer is yes.
 .TP
-\fB\fCconfctl generation ls\fR [\fImachine\-pattern\fP [\fIgeneration\-pattern\fP]|\fIn\fP\fB\fCd\fR|\fB\fCold\fR]
+\fB\fCconfctl generation ls\fR [\fImachine\-pattern\fP [\fIgeneration\-pattern\fP]|\fIn\fP\fB\fCd\fR|\fIoffset\fP|\fB\fCold\fR]
 List all or selected generations. By default only local build generations
 are listed.
 .PP
@@ -425,11 +436,13 @@ are listed.
     \fB\fC\-r\fR, \fB\fC\-\-remote\fR
       List remote generations found on deployed machines.
 .TP
-\fB\fCconfctl generation rm\fR [\fImachine\-pattern\fP [\fIgeneration\-pattern\fP|\fIn\fP\fB\fCd\fR|\fB\fCold\fR]]
+\fB\fCconfctl generation rm\fR [\fImachine\-pattern\fP [\fIgeneration\-pattern\fP|\fIn\fP\fB\fCd\fR|\fIoffset\fP|\fB\fCold\fR]]
 Remove selected generations.
 .IP
 \fIn\fP\fB\fCd\fR will remove generations older than \fIn\fP days.
 .IP
+\fIoffset\fP will remove generations at a specific offset, see \fB\fCGENERATION OFFSETS\fR\&.
+.IP
 \fB\fCold\fR will remove all generations except the current one, i.e. the one that
 was built by \fB\fCconfctl build\fR the last.
 .IP
@@ -485,6 +498,9 @@ configuration also runs \fB\fCnix\-collect\-garbage\fR\&.
 .PP
     \fB\fC\-r\fR, \fB\fC\-\-remote\fR
       Consider generations found on deployed machines.
+.PP
+    \fB\fC\-\-no\-gc\fR, \fB\fC\-\-no\-collect\-garbage\fR
+      Do not run the garbage collector even if it is enabled in configuration.
 .PP
     \fB\fC\-\-max\-concurrent\-gc\fR \fIn\fP
       Run \fB\fCnix\-collect\-garbage\fR at most on \fIn\fP machines at the same time.
@@ -540,17 +556,17 @@ on the type of the software pin, for git it is a git reference, e.g. a revision.
 \fB\fCconfctl swpins cluster update\fR [\fIname\-pattern\fP [\fIsw\-pattern\fP]]
 Update selected or all software packages that have been configured to support
 this command. The usual case for git is to pin to the current branch head.
-.TP
-\fB\fC\-\-[no\-]commit\fR
-    Commit changed swpins files to git. Disabled by default.
-.TP
-\fB\fC\-\-[no\-]changelog\fR
-    Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
-    default.
-.TP
-\fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+.PP
+    \fB\fC\-\-[no\-]commit\fR
+      Commit changed swpins files to git. Disabled by default.
+.PP
+    \fB\fC\-\-[no\-]changelog\fR
+      Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
+      default.
+.PP
+    \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 .TP
 \fB\fCconfctl swpins channel ls\fR [\fIchannel\-pattern\fP [\fIsw\-pattern\fP]]
 List existing channels with pinned software packages.
@@ -559,33 +575,33 @@ List existing channels with pinned software packages.
 Set selected software packages in channels to new \fIversion\fP\&. The value
 of \fIversion\fP depends on the type of the software pin, for git it is a git
 reference, e.g. a revision.
-.TP
-\fB\fC\-\-[no\-]commit\fR
-    Commit changed swpins files to git. Disabled by default.
-.TP
-\fB\fC\-\-[no\-]changelog\fR
-    Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
-    default.
-.TP
-\fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+.PP
+    \fB\fC\-\-[no\-]commit\fR
+      Commit changed swpins files to git. Disabled by default.
+.PP
+    \fB\fC\-\-[no\-]changelog\fR
+      Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
+      default.
+.PP
+    \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 .TP
 \fB\fCconfctl swpins channel update\fR [\fIchannel\-pattern\fP [\fIsw\-pattern\fP]]
 Update selected or all software packages in channels that have been configured
 to support this command. The usual case for git is to pin to the current
 branch head.
-.TP
-\fB\fC\-\-[no\-]commit\fR
-    Commit changed swpins files to git. Disabled by default.
-.TP
-\fB\fC\-\-[no\-]changelog\fR
-    Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
-    default.
-.TP
-\fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+.PP
+    \fB\fC\-\-[no\-]commit\fR
+      Commit changed swpins files to git. Disabled by default.
+.PP
+    \fB\fC\-\-[no\-]changelog\fR
+      Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
+      default.
+.PP
+    \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 .TP
 \fB\fCconfctl swpins core ls\fR [\fIsw\-pattern\fP]
 List core software packages used internally by confctl.
@@ -594,48 +610,48 @@ List core software packages used internally by confctl.
 Set selected core software package to new \fIversion\fP\&. The value
 of \fIversion\fP depends on the type of the software pin, for git it is a git
 reference, e.g. a revision.
-.TP
-\fB\fC\-\-[no\-]commit\fR
-    Commit changed swpins files to git. Disabled by default.
-.TP
-\fB\fC\-\-[no\-]changelog\fR
-    Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
-    default.
-.TP
-\fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+.PP
+    \fB\fC\-\-[no\-]commit\fR
+      Commit changed swpins files to git. Disabled by default.
+.PP
+    \fB\fC\-\-[no\-]changelog\fR
+      Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
+      default.
+.PP
+    \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 .TP
 \fB\fCconfctl swpins core update\fR [\fIsw\-pattern\fP]
 Update selected or all core software packages that have been configured
 to support this command. The usual case for git is to pin to the current
 branch head.
-.TP
-\fB\fC\-\-[no\-]commit\fR
-    Commit changed swpins files to git. Disabled by default.
-.TP
-\fB\fC\-\-[no\-]changelog\fR
-    Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
-    default.
-.TP
-\fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+.PP
+    \fB\fC\-\-[no\-]commit\fR
+      Commit changed swpins files to git. Disabled by default.
+.PP
+    \fB\fC\-\-[no\-]changelog\fR
+      Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
+      default.
+.PP
+    \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 .TP
 \fB\fCconfctl swpins update\fR
 Update software pins that have been configured for updates, including pins
 in all channels, all machine\-specific pins and the core pins.
-.TP
-\fB\fC\-\-[no\-]commit\fR
-    Commit changed swpins files to git. Disabled by default.
-.TP
-\fB\fC\-\-[no\-]changelog\fR
-    Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
-    default.
-.TP
-\fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+.PP
+    \fB\fC\-\-[no\-]commit\fR
+      Commit changed swpins files to git. Disabled by default.
+.PP
+    \fB\fC\-\-[no\-]changelog\fR
+      Include changelog in the commit message when \fB\fC\-\-commit\fR is used. Enabled by
+      default.
+.PP
+    \fB\fC\-d\fR, \fB\fC\-\-downgrade\fR
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 .TP
 \fB\fCconfctl swpins reconfigure\fR
 Regenerate all confctl\-managed software pin files according to the Nix

data/man/man8/confctl.8.md

@@ -38,6 +38,11 @@ similarly to shell patterns, see
 <http://ruby-doc.org/core/File.html#method-c-fnmatch-3F> for more
 information.
 
+## GENERATION OFFSETS
+Generations can be selected by *offset*. `0` is the current (last) generation.
+`1` is the first (oldest) generation, `2` the second generation, etc. `-1` is
+the generation before last and so on.
+
 ## GLOBAL OPTIONS
 `-c`, `--color` `always`|`never`|`auto`
   Set output color mode. Defaults to `auto`, which enables colors when
@@ -137,7 +142,7 @@ information.
     `-y`, `--yes`
       Do not ask for confirmation on standard input, assume the answer is yes.
 
-    `-g`, `--generation` *generation*|`current`
+    `-g`, `--generation` *generation*|*offset*|`current`
       Do not build a new generation, but deploy an existing generation.
 
     `--outdated`
@@ -168,6 +173,12 @@ information.
     `--copy-only`
       Do not activate the copied closures.
 
+    `--enable-auto-rollback`
+      Enable auto-rollback on deploy even if it is not enabled in machine configuration.
+
+    `--disable-auto-rollback`
+      Disable auto-rollback on deploy if it is enabled in machine configuration.
+
     `--reboot`
       Applicable only when *switch-action* is `boot`. Reboot the machine after the
       configuration is activated.
@@ -222,7 +233,7 @@ information.
     `-y`, `--yes`
       Do not ask for confirmation on standard input, assume the answer is yes.
 
-    `-g`, `--generation` *generation*|`current`|`none`
+    `-g`, `--generation` *generation*|*offset*|`current`|`none`
       Check status against a selected generation instead of a new build. If set
       to `none`, only the currently configured software pins are checked and not
       the system version itself.
@@ -258,7 +269,7 @@ information.
     `-y`, `--yes`
       Do not ask for confirmation on standard input, assume the answer is yes.
 
-    `-g`, `--generation` *generation*|`current`
+    `-g`, `--generation` *generation*|*offset*|`current`
       Show changelog against software pins from a selected generation instead
       of the current configuration.
 
@@ -304,7 +315,7 @@ information.
     `-y`, `--yes`
       Do not ask for confirmation on standard input, assume the answer is yes.
 
-    `-g`, `--generation` *generation*|`current`
+    `-g`, `--generation` *generation*|*offset*|`current`
       Show diff against software pins from a selected generation instead
       of the current configuration.
 
@@ -396,7 +407,7 @@ information.
     `-y`, `--yes`
       Do not ask for confirmation on standard input, assume the answer is yes.
 
-`confctl generation ls` [*machine-pattern* [*generation-pattern*]|*n*`d`|`old`]
+`confctl generation ls` [*machine-pattern* [*generation-pattern*]|*n*`d`|*offset*|`old`]
   List all or selected generations. By default only local build generations
   are listed.
 
@@ -415,11 +426,13 @@ information.
     `-r`, `--remote`
       List remote generations found on deployed machines.
 
-`confctl generation rm` [*machine-pattern* [*generation-pattern*|*n*`d`|`old`]]
+`confctl generation rm` [*machine-pattern* [*generation-pattern*|*n*`d`|*offset*|`old`]]
   Remove selected generations.
 
   *n*`d` will remove generations older than *n* days.
 
+  *offset* will remove generations at a specific offset, see `GENERATION OFFSETS`.
+
   `old` will remove all generations except the current one, i.e. the one that
   was built by `confctl build` the last.
 
@@ -476,6 +489,9 @@ information.
     `-r`, `--remote`
       Consider generations found on deployed machines.
 
+    `--no-gc`, `--no-collect-garbage`
+      Do not run the garbage collector even if it is enabled in configuration.
+
     `--max-concurrent-gc` *n*
       Run `nix-collect-garbage` at most on *n* machines at the same time.
       Defaults to `5`.
@@ -531,16 +547,16 @@ information.
   Update selected or all software packages that have been configured to support
   this command. The usual case for git is to pin to the current branch head.
 
-  `--[no-]commit`
-    Commit changed swpins files to git. Disabled by default.
+    `--[no-]commit`
+      Commit changed swpins files to git. Disabled by default.
 
-  `--[no-]changelog`
-    Include changelog in the commit message when `--commit` is used. Enabled by
-    default.
+    `--[no-]changelog`
+      Include changelog in the commit message when `--commit` is used. Enabled by
+      default.
 
-  `-d`, `--downgrade`
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+    `-d`, `--downgrade`
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 
 `confctl swpins channel ls` [*channel-pattern* [*sw-pattern*]]
   List existing channels with pinned software packages.
@@ -550,32 +566,32 @@ information.
   of *version* depends on the type of the software pin, for git it is a git
   reference, e.g. a revision.
 
-  `--[no-]commit`
-    Commit changed swpins files to git. Disabled by default.
+    `--[no-]commit`
+      Commit changed swpins files to git. Disabled by default.
 
-  `--[no-]changelog`
-    Include changelog in the commit message when `--commit` is used. Enabled by
-    default.
+    `--[no-]changelog`
+      Include changelog in the commit message when `--commit` is used. Enabled by
+      default.
 
-  `-d`, `--downgrade`
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+    `-d`, `--downgrade`
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 
 `confctl swpins channel update` [*channel-pattern* [*sw-pattern*]]
   Update selected or all software packages in channels that have been configured
   to support this command. The usual case for git is to pin to the current
   branch head.
 
-  `--[no-]commit`
-    Commit changed swpins files to git. Disabled by default.
+    `--[no-]commit`
+      Commit changed swpins files to git. Disabled by default.
 
-  `--[no-]changelog`
-    Include changelog in the commit message when `--commit` is used. Enabled by
-    default.
+    `--[no-]changelog`
+      Include changelog in the commit message when `--commit` is used. Enabled by
+      default.
 
-  `-d`, `--downgrade`
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+    `-d`, `--downgrade`
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 
 `confctl swpins core ls` [*sw-pattern*]
   List core software packages used internally by confctl.
@@ -585,47 +601,47 @@ information.
   of *version* depends on the type of the software pin, for git it is a git
   reference, e.g. a revision.
 
-  `--[no-]commit`
-    Commit changed swpins files to git. Disabled by default.
+    `--[no-]commit`
+      Commit changed swpins files to git. Disabled by default.
 
-  `--[no-]changelog`
-    Include changelog in the commit message when `--commit` is used. Enabled by
-    default.
+    `--[no-]changelog`
+      Include changelog in the commit message when `--commit` is used. Enabled by
+      default.
 
-  `-d`, `--downgrade`
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+    `-d`, `--downgrade`
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 
 `confctl swpins core update` [*sw-pattern*]
   Update selected or all core software packages that have been configured
   to support this command. The usual case for git is to pin to the current
   branch head.
 
-  `--[no-]commit`
-    Commit changed swpins files to git. Disabled by default.
+    `--[no-]commit`
+      Commit changed swpins files to git. Disabled by default.
 
-  `--[no-]changelog`
-    Include changelog in the commit message when `--commit` is used. Enabled by
-    default.
+    `--[no-]changelog`
+      Include changelog in the commit message when `--commit` is used. Enabled by
+      default.
 
-  `-d`, `--downgrade`
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+    `-d`, `--downgrade`
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 
 `confctl swpins update`
   Update software pins that have been configured for updates, including pins
   in all channels, all machine-specific pins and the core pins.
 
-  `--[no-]commit`
-    Commit changed swpins files to git. Disabled by default.
+    `--[no-]commit`
+      Commit changed swpins files to git. Disabled by default.
 
-  `--[no-]changelog`
-    Include changelog in the commit message when `--commit` is used. Enabled by
-    default.
+    `--[no-]changelog`
+      Include changelog in the commit message when `--commit` is used. Enabled by
+      default.
 
-  `-d`, `--downgrade`
-    Use when the new version is older than the previously set version. Used for
-    generating changelog for the commit message.
+    `-d`, `--downgrade`
+      Use when the new version is older than the previously set version. Used for
+      generating changelog for the commit message.
 
 `confctl swpins reconfigure`
   Regenerate all confctl-managed software pin files according to the Nix

data/nix/evaluator.nix

@@ -81,7 +81,15 @@ let
           abort "Attribute 'config.${coreLib.concatStringsSep "." machine.build.attribute}' not found on machine ${machine.name}"
         else
           buildAttr;
-    in result;
+    in {
+      attribute = result;
+
+      autoRollback = corePkgs.substituteAll {
+        src = ../libexec/auto-rollback.rb;
+        isExecutable = true;
+        ruby = nixpkgs.ruby;
+      };
+    };
 
   evalMachine = machine:
     let

data/nix/modules/cluster/default.nix

@@ -186,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 {