confctl 1.0.0

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

@@ -0,0 +1,1334 @@
+.TH confctl\-options.nix 8           2024\-02\-17                             master
+.SH NAME
+.PP
+\fB\fCconfctl\-options.nix\fR \- confctl configuration documentation
+.SH DESCRIPTION
+.PP
+This document describes Nix options, which can be used in 
+.BR confctl (8) 
+cluster
+configurations to configure \fB\fCconfctl\fR and machines within the cluster.
+.SH CONFCTL SETTINGS
+.PP
+The following \fB\fCconfctl\fR settings can be configured in \fB\fCconfigs/confctl.nix\fR
+within the deployment configuration directory:
+.TP
+\fB\fCconfctl.buildGenerations.max\fR
+The maximum number of build generations to be kept.
+.IP
+This is the default value, which can be overriden per host.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC30\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.buildGenerations.maxAge\fR
+Delete build generations older than
+\fB\fCconfctl.buildGenerations.maxAge\fR seconds. Old generations
+are deleted even if \fB\fCconfctl.buildGenerations.max\fR is
+not reached.
+.IP
+This is the default value, which can be overriden per host.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC15552000\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.buildGenerations.min\fR
+The minimum number of build generations to be kept.
+.IP
+This is the default value, which can be overriden per host.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC5\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.hostGenerations.collectGarbage\fR
+Run nix\-collect\-garbage
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCtrue\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.hostGenerations.max\fR
+The maximum number of generations to be kept on machines.
+.IP
+This is the default value, which can be overriden per host.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC30\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.hostGenerations.maxAge\fR
+Delete generations older than
+\fB\fCconfctl.hostGenerations.maxAge\fR seconds from
+machines. Old generations
+are deleted even if \fB\fCconfctl.hostGenerations.max\fR is
+not reached.
+.IP
+This is the default value, which can be overriden per host.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC15552000\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.hostGenerations.min\fR
+The minimum number of generations to be kept on machines.
+.IP
+This is the default value, which can be overriden per host.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC5\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/generations.nix>\fR
+.TP
+\fB\fCconfctl.list.columns\fR
+Configure which columns should \fB\fCconfctl ls\fR show.
+Names correspond to options within \fB\fCcluster.<name>\fR
+module.
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fC[
+  "name"
+  "spin"
+  "host.fqdn"
+]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/cli.nix>\fR
+.TP
+\fB\fCconfctl.nix.maxJobs\fR
+Maximum number of build jobs, passed to \fB\fCnix\-build\fR
+commands.
+.PP
+    \fIType:\fP null or signed integer or value "auto" (singular enum)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/nix.nix>\fR
+.TP
+\fB\fCconfctl.nix.nixPath\fR
+List of extra paths added to environment variable
+\fB\fCNIX_PATH\fR for all \fB\fCnix\-build\fR
+invokations
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/nix.nix>\fR
+.SH SOFTWARE PIN CHANNELS
+.PP
+The following \fB\fCconfctl\fR settings for software pin channels can be configured
+in \fB\fCconfigs/swpins.nix\fR within the deployment configuration directory:
+.TP
+\fB\fCconfctl.swpins.channels\fR
+Software pin channels
+.PP
+    \fIType:\fP attribute set of attribute set of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC{ }\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.directory\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.directory.path\fR
+Absolute path to the directory
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"/opt/my\-swpin"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git.fetchSubmodules\fR
+Fetch git submodules
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git.update.auto\fR
+When enabled, the pin is automatically updated to
+\fB\fCref\fR before building machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git.update.interval\fR
+Number of seconds from the last update to trigger the next
+auto\-update, if auto\-update is enabled.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC3600\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git.update.ref\fR
+Implicit git reference to use for both manual and automatic updates
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"refs/heads/master"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git.url\fR
+URL of the git repository
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"https://github.com/vpsfreecz/vpsadminos"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\-rev\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\-rev.fetchSubmodules\fR
+Fetch git submodules
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\-rev.update.auto\fR
+When enabled, the pin is automatically updated to
+\fB\fCref\fR before building machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\-rev.update.interval\fR
+Number of seconds from the last update to trigger the next
+auto\-update, if auto\-update is enabled.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC3600\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\-rev.update.ref\fR
+Implicit git reference to use for both manual and automatic updates
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"refs/heads/master"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.git\-rev.url\fR
+URL of the git repository
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"https://github.com/vpsfreecz/vpsadminos"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.channels.<name>.<name>.type\fR
+This option has no description.
+.PP
+    \fIType:\fP one of "directory", "git", "git\-rev"
+.PP
+    \fIDefault:\fP \fB\fC"git"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.channels\fR
+List of channels from \fB\fCconfctl.swpins.channels\fR
+to use for core swpins
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins\fR
+Core software packages used internally by confctl
+.IP
+It has to contain package \fB\fCnixpkgs\fR, which is used
+to resolve other software pins from channels or cluster machines.
+.PP
+    \fIType:\fP attribute set of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC{
+  nixpkgs = {
+    git\-rev = {
+      update = {
+        auto = true;
+        interval = 2592000;
+        ref = "refs/heads/nixos\-unstable";
+      };
+      url = "https://github.com/NixOS/nixpkgs";
+    };
+    type = "git\-rev";
+  };
+}\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.directory\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.directory.path\fR
+Absolute path to the directory
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"/opt/my\-swpin"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git.fetchSubmodules\fR
+Fetch git submodules
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git.update.auto\fR
+When enabled, the pin is automatically updated to
+\fB\fCref\fR before building machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git.update.interval\fR
+Number of seconds from the last update to trigger the next
+auto\-update, if auto\-update is enabled.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC3600\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git.update.ref\fR
+Implicit git reference to use for both manual and automatic updates
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"refs/heads/master"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git.url\fR
+URL of the git repository
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"https://github.com/vpsfreecz/vpsadminos"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\-rev\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\-rev.fetchSubmodules\fR
+Fetch git submodules
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\-rev.update.auto\fR
+When enabled, the pin is automatically updated to
+\fB\fCref\fR before building machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\-rev.update.interval\fR
+Number of seconds from the last update to trigger the next
+auto\-update, if auto\-update is enabled.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC3600\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\-rev.update.ref\fR
+Implicit git reference to use for both manual and automatic updates
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"refs/heads/master"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.git\-rev.url\fR
+URL of the git repository
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"https://github.com/vpsfreecz/vpsadminos"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.TP
+\fB\fCconfctl.swpins.core.pins.<name>.type\fR
+This option has no description.
+.PP
+    \fIType:\fP one of "directory", "git", "git\-rev"
+.PP
+    \fIDefault:\fP \fB\fC"git"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/confctl/swpins.nix>\fR
+.SH MACHINE CONFIGURATION
+.PP
+The following options can be configured in per\-machine \fB\fCmodule.nix\fR files within
+the deployment configuration directory, i.e. \fB\fCcluster/<machine\-name>/module.nix\fR:
+.TP
+\fB\fCcluster.<name>.addresses\fR
+IP addresses
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.addresses.primary\fR
+Default address other machines should use to connect to this machine
+.IP
+Defaults to the first IPv4 address if not set
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.addresses.primary.address\fR
+IPv4 address
+.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>.addresses.primary.prefix\fR
+Prefix length
+.PP
+    \fIType:\fP positive integer, meaning >0
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.addresses.primary.string\fR
+Address with prefix as string
+.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>.addresses.v4\fR
+List of IPv4 addresses this machine responds to
+.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>.addresses.v4.*.address\fR
+IPv4 address
+.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>.addresses.v4.*.prefix\fR
+Prefix length
+.PP
+    \fIType:\fP positive integer, meaning >0
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.addresses.v4.*.string\fR
+Address with prefix as string
+.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>.addresses.v6\fR
+List of IPv6 addresses this machine responds to
+.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>.addresses.v6.*.address\fR
+IPv6 address
+.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>.addresses.v6.*.prefix\fR
+Prefix length
+.PP
+    \fIType:\fP positive integer, meaning >0
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.addresses.v6.*.string\fR
+Address with prefix as string
+.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>.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>.buildGenerations.maxAge\fR
+Delete build generations older than
+\fB\fCcluster.<name>.buildGenerations.maxAge\fR
+seconds from the build machine. Old generations are deleted even
+if \fB\fCcluster.<name>.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>.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>.healthChecks.builderCommands\fR
+Check commands run on the build machine
+.PP
+    \fIType:\fP list of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIExample:\fP \fB\fC[
+  { description = "ping"; command = [ "ping" "\-c1" "{host.fqdn}" ]; }
+]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.builderCommands.*.command\fR
+Command and its arguments
+.IP
+It is possible to access machine attributes as from CLI using curly
+brackets. For example, {host.fqdn} would be replaced by machine FQDN.
+See confctl ls \-L for a list of available attributes.
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.builderCommands.*.cooldown\fR
+Number of seconds in between check attempts
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC3\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.builderCommands.*.description\fR
+Command description
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fC""\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.builderCommands.*.exitStatus\fR
+Expected exit status
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC0\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.builderCommands.*.standardError.exclude\fR
+String that must not be included in standard error
+.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.*.standardError.include\fR
+String that must be included in standard error
+.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.*.standardError.match\fR
+Standard error must match this string
+.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>.healthChecks.builderCommands.*.standardOutput.exclude\fR
+Strings that must not be included in standard output
+.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.*.standardOutput.include\fR
+Strings that must be included in standard output
+.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.*.standardOutput.match\fR
+Standard output must match this string
+.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>.healthChecks.builderCommands.*.timeout\fR
+Max number of seconds to wait for the check to pass
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC60\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.machineCommands\fR
+Check commands run on the target machine
+.IP
+Note that the commands have to be available on the machine.
+.PP
+    \fIType:\fP list of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC[ ]\fR
+.PP
+    \fIExample:\fP \fB\fC[
+  { description = "curl"; command = [ "curl" "\-s" "http://localhost:80" ]; }
+]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.machineCommands.*.command\fR
+Command and its arguments
+.IP
+It is possible to access machine attributes as from CLI using curly
+brackets. For example, {host.fqdn} would be replaced by machine FQDN.
+See confctl ls \-L for a list of available attributes.
+.PP
+    \fIType:\fP list of string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.machineCommands.*.cooldown\fR
+Number of seconds in between check attempts
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC3\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.machineCommands.*.description\fR
+Command description
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fC""\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.machineCommands.*.exitStatus\fR
+Expected exit status
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC0\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.machineCommands.*.standardError.exclude\fR
+String that must not be included in standard error
+.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.machineCommands.*.standardError.include\fR
+String that must be included in standard error
+.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.machineCommands.*.standardError.match\fR
+Standard error must match this string
+.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>.healthChecks.machineCommands.*.standardOutput.exclude\fR
+Strings that must not be included in standard output
+.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.machineCommands.*.standardOutput.include\fR
+Strings that must be included in standard output
+.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.machineCommands.*.standardOutput.match\fR
+Standard output must match this string
+.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>.healthChecks.machineCommands.*.timeout\fR
+Max number of seconds to wait for the check to pass
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC60\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.enable\fR
+Enable systemd checks, enabled by default
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCtrue\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.systemProperties\fR
+Check systemd manager properties reported by systemctl show
+.PP
+    \fIType:\fP list of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC[
+  {
+    property = "SystemState";
+    value = "running";
+  }
+]\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.systemProperties.*.cooldown\fR
+Number of seconds in between check attempts
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC3\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.systemProperties.*.property\fR
+systemd property 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>.healthChecks.systemd.systemProperties.*.timeout\fR
+Max number of seconds to wait for the check to pass
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC60\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.systemProperties.*.value\fR
+value to be checked
+.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>.healthChecks.systemd.unitProperties\fR
+Check systemd unit properties reported by systemctl show <unit>
+.PP
+    \fIType:\fP attribute set of list of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC{ }\fR
+.PP
+    \fIExample:\fP \fB\fC{
+  "firewall.service" = [
+    { property = "ActiveState"; value = "active"; }
+  ];
+}\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.unitProperties.<name>.*.cooldown\fR
+Number of seconds in between check attempts
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC3\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.unitProperties.<name>.*.property\fR
+systemd property 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>.healthChecks.systemd.unitProperties.<name>.*.timeout\fR
+Max number of seconds to wait for the check to pass
+.PP
+    \fIType:\fP unsigned integer, meaning >=0
+.PP
+    \fIDefault:\fP \fB\fC60\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.healthChecks.systemd.unitProperties.<name>.*.value\fR
+value to be checked
+.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>.host\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.host.domain\fR
+Host domain
+.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>.host.fqdn\fR
+Host FQDN
+.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>.host.fullDomain\fR
+Domain including location, i.e. FQDN without host 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>.host.location\fR
+Host location domain
+.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>.host.name\fR
+Host 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>.host.target\fR
+Address/host to which the configuration is deployed to
+.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>.hostGenerations.collectGarbage\fR
+Run nix\-collect\-garbage
+.PP
+    \fIType:\fP null or boolean
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.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>.hostGenerations.maxAge\fR
+Delete generations older than
+\fB\fCcluster.<name>.hostGenerations.maxAge\fR
+seconds from the machine. Old generations are deleted even
+if \fB\fCcluster.<name>.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>.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>.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>.managed\fR
+Determines whether the machine is managed using confctl or not
+.IP
+By default, NixOS and vpsAdminOS machines are managed by confctl.
+.PP
+    \fIType:\fP null or boolean
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.netboot.enable\fR
+Whether to enable Include this system on pxe servers.
+.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>.netboot.macs\fR
+List of MAC addresses for iPXE node auto\-detection
+.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>.nix.nixPath\fR
+List of extra paths added to environment variable
+\fB\fCNIX_PATH\fR for \fB\fCnix\-build\fR
+.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>.spin\fR
+OS type
+.PP
+    \fIType:\fP one of "openvz", "nixos", "vpsadminos", "other"
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.channels\fR
+List of channels from \fB\fCconfctl.swpins.channels\fR
+to use on this 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>.swpins.pins\fR
+List of swpins for this machine, which can supplement or
+override swpins from configured channels
+.PP
+    \fIType:\fP attribute set of (submodule)
+.PP
+    \fIDefault:\fP \fB\fC{ }\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.directory\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.directory.path\fR
+Absolute path to the directory
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"/opt/my\-swpin"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git.fetchSubmodules\fR
+Fetch git submodules
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git.update.auto\fR
+When enabled, the pin is automatically updated to
+\fB\fCref\fR before building machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git.update.interval\fR
+Number of seconds from the last update to trigger the next
+auto\-update, if auto\-update is enabled.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC3600\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git.update.ref\fR
+Implicit git reference to use for both manual and automatic updates
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"refs/heads/master"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git.url\fR
+URL of the git repository
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"https://github.com/vpsfreecz/vpsadminos"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\-rev\fR
+This option has no description.
+.PP
+    \fIType:\fP null or (submodule)
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\-rev.fetchSubmodules\fR
+Fetch git submodules
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\-rev.update.auto\fR
+When enabled, the pin is automatically updated to
+\fB\fCref\fR before building machines.
+.PP
+    \fIType:\fP boolean
+.PP
+    \fIDefault:\fP \fB\fCfalse\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\-rev.update.interval\fR
+Number of seconds from the last update to trigger the next
+auto\-update, if auto\-update is enabled.
+.PP
+    \fIType:\fP signed integer
+.PP
+    \fIDefault:\fP \fB\fC3600\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\-rev.update.ref\fR
+Implicit git reference to use for both manual and automatic updates
+.PP
+    \fIType:\fP null or string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"refs/heads/master"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.git\-rev.url\fR
+URL of the git repository
+.PP
+    \fIType:\fP string
+.PP
+    \fIDefault:\fP \fB\fCnull\fR
+.PP
+    \fIExample:\fP \fB\fC"https://github.com/vpsfreecz/vpsadminos"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.swpins.pins.<name>.type\fR
+This option has no description.
+.PP
+    \fIType:\fP one of "directory", "git", "git\-rev"
+.PP
+    \fIDefault:\fP \fB\fC"git"\fR
+.PP
+    \fIDeclared by:\fP \fB\fC<confctl/nix/modules/cluster>\fR
+.TP
+\fB\fCcluster.<name>.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
+.SH SERVICES
+.PP
+The following options can be configured in per\-machine \fB\fCconfig.nix\fR files within
+the deployment configuration directory, i.e. \fB\fCcluster/<machine\-name>/config.nix\fR,
+or any other imported Nix file. These options are added by \fB\fCconfctl\fR in addition
+to options from \fB\fCNixOS\fR or \fB\fCvpsAdminOS\fR\&.
+.SH SEE ALSO
+.PP
+.BR confctl (8)
+.SH BUGS
+.PP
+Report bugs to \[la]https://github.com/vpsfreecz/confctl/issues\[ra]\&.
+.SH ABOUT
+.PP
+\fB\fCconfctl\fR was originally developed for the purposes of
+vpsFree.cz \[la]https://vpsfree.org\[ra] and its cluster
+configuration \[la]https://github.com/vpsfreecz/vpsfree-cz-configuration\[ra]\&.