gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/systemd: refactor option definitions

Browse Source 
- factor out `config.systemd.`;
- remove `lib.mdDoc` no-op.
This commit is contained in:
nicoo
2023-11-21 16:22:50 +00:00
parent e6fc0a2e3a
commit 667e7ca0bd
1 changed files with 54 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
nixos/modules/system/boot/systemd.nix
View File

@@ -177,189 +177,189 @@ in
{ {
###### interface ###### interface
options = { options.systemd = {
systemd.package = mkOption { package = mkOption {
default = pkgs.systemd; default = pkgs.systemd;
defaultText = literalExpression "pkgs.systemd"; defaultText = literalExpression "pkgs.systemd";
type = types.package; type = types.package;
description = lib.mdDoc "The systemd package."; description = lib.mdDoc "The systemd package.";
}; };
systemd.units = mkOption { units = mkOption {
description = lib.mdDoc "Definition of systemd units."; description = "Definition of systemd units.";
default = {}; default = {};
type = systemdUtils.types.units; type = systemdUtils.types.units;
}; };
systemd.packages = mkOption { packages = mkOption {
default = []; default = [];
type = types.listOf types.package; type = types.listOf types.package;
example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]"; example = literalExpression "[ pkgs.systemd-cryptsetup-generator ]";
description = lib.mdDoc "Packages providing systemd units and hooks."; description = "Packages providing systemd units and hooks.";
}; };
systemd.targets = mkOption { targets = mkOption {
default = {}; default = {};
type = systemdUtils.types.targets; type = systemdUtils.types.targets;
description = lib.mdDoc "Definition of systemd target units."; description = "Definition of systemd target units.";
}; };
systemd.services = mkOption { services = mkOption {
default = {}; default = {};
type = systemdUtils.types.services; type = systemdUtils.types.services;
description = lib.mdDoc "Definition of systemd service units."; description = "Definition of systemd service units.";
}; };
systemd.sockets = mkOption { sockets = mkOption {
default = {}; default = {};
type = systemdUtils.types.sockets; type = systemdUtils.types.sockets;
description = lib.mdDoc "Definition of systemd socket units."; description = "Definition of systemd socket units.";
}; };
systemd.timers = mkOption { timers = mkOption {
default = {}; default = {};
type = systemdUtils.types.timers; type = systemdUtils.types.timers;
description = lib.mdDoc "Definition of systemd timer units."; description = "Definition of systemd timer units.";
}; };
systemd.paths = mkOption { paths = mkOption {
default = {}; default = {};
type = systemdUtils.types.paths; type = systemdUtils.types.paths;
description = lib.mdDoc "Definition of systemd path units."; description = "Definition of systemd path units.";
}; };
systemd.mounts = mkOption { mounts = mkOption {
default = []; default = [];
type = systemdUtils.types.mounts; type = systemdUtils.types.mounts;
description = lib.mdDoc '' description = ''
Definition of systemd mount units. Definition of systemd mount units.
This is a list instead of an attrSet, because systemd mandates the names to be derived from This is a list instead of an attrSet, because systemd mandates the names to be derived from
the 'where' attribute. the 'where' attribute.
''; '';
}; };
systemd.automounts = mkOption { automounts = mkOption {
default = []; default = [];
type = systemdUtils.types.automounts; type = systemdUtils.types.automounts;
description = lib.mdDoc '' description = ''
Definition of systemd automount units. Definition of systemd automount units.
This is a list instead of an attrSet, because systemd mandates the names to be derived from This is a list instead of an attrSet, because systemd mandates the names to be derived from
the 'where' attribute. the 'where' attribute.
''; '';
}; };
systemd.slices = mkOption { slices = mkOption {
default = {}; default = {};
type = systemdUtils.types.slices; type = systemdUtils.types.slices;
description = lib.mdDoc "Definition of slice configurations."; description = "Definition of slice configurations.";
}; };
systemd.generators = mkOption { generators = mkOption {
type = types.attrsOf types.path; type = types.attrsOf types.path;
default = {}; default = {};
example = { systemd-gpt-auto-generator = "/dev/null"; }; example = { systemd-gpt-auto-generator = "/dev/null"; };
description = lib.mdDoc '' description = ''
Definition of systemd generators. Definition of systemd generators.
For each `NAME = VALUE` pair of the attrSet, a link is generated from For each `NAME = VALUE` pair of the attrSet, a link is generated from
`/etc/systemd/system-generators/NAME` to `VALUE`. `/etc/systemd/system-generators/NAME` to `VALUE`.
''; '';
}; };
systemd.shutdown = mkOption { shutdown = mkOption {
type = types.attrsOf types.path; type = types.attrsOf types.path;
default = {}; default = {};
description = lib.mdDoc '' description = ''
Definition of systemd shutdown executables. Definition of systemd shutdown executables.
For each `NAME = VALUE` pair of the attrSet, a link is generated from For each `NAME = VALUE` pair of the attrSet, a link is generated from
`/etc/systemd/system-shutdown/NAME` to `VALUE`. `/etc/systemd/system-shutdown/NAME` to `VALUE`.
''; '';
}; };
systemd.defaultUnit = mkOption { defaultUnit = mkOption {
default = "multi-user.target"; default = "multi-user.target";
type = types.str; type = types.str;
description = lib.mdDoc "Default unit started when the system boots."; description = "Default unit started when the system boots.";
}; };
systemd.ctrlAltDelUnit = mkOption { ctrlAltDelUnit = mkOption {
default = "reboot.target"; default = "reboot.target";
type = types.str; type = types.str;
example = "poweroff.target"; example = "poweroff.target";
description = lib.mdDoc '' description = ''
Target that should be started when Ctrl-Alt-Delete is pressed. Target that should be started when Ctrl-Alt-Delete is pressed.
''; '';
}; };
systemd.globalEnvironment = mkOption { globalEnvironment = mkOption {
type = with types; attrsOf (nullOr (oneOf [ str path package ])); type = with types; attrsOf (nullOr (oneOf [ str path package ]));
default = {}; default = {};
example = { TZ = "CET"; }; example = { TZ = "CET"; };
description = lib.mdDoc '' description = ''
Environment variables passed to *all* systemd units. Environment variables passed to *all* systemd units.
''; '';
}; };
systemd.managerEnvironment = mkOption { managerEnvironment = mkOption {
type = with types; attrsOf (nullOr (oneOf [ str path package ])); type = with types; attrsOf (nullOr (oneOf [ str path package ]));
default = {}; default = {};
example = { SYSTEMD_LOG_LEVEL = "debug"; }; example = { SYSTEMD_LOG_LEVEL = "debug"; };
description = lib.mdDoc '' description = ''
Environment variables of PID 1. These variables are Environment variables of PID 1. These variables are
*not* passed to started units. *not* passed to started units.
''; '';
}; };
systemd.enableCgroupAccounting = mkOption { enableCgroupAccounting = mkOption {
default = true; default = true;
type = types.bool; type = types.bool;
description = lib.mdDoc '' description = ''
Whether to enable cgroup accounting. Whether to enable cgroup accounting.
''; '';
}; };
systemd.enableUnifiedCgroupHierarchy = mkOption { enableUnifiedCgroupHierarchy = mkOption {
default = true; default = true;
type = types.bool; type = types.bool;
description = lib.mdDoc '' description = ''
Whether to enable the unified cgroup hierarchy (cgroupsv2). Whether to enable the unified cgroup hierarchy (cgroupsv2).
''; '';
}; };
systemd.extraConfig = mkOption { extraConfig = mkOption {
default = ""; default = "";
type = types.lines; type = types.lines;
example = "DefaultLimitCORE=infinity"; example = "DefaultLimitCORE=infinity";
description = lib.mdDoc '' description = ''
Extra config options for systemd. See systemd-system.conf(5) man page Extra config options for systemd. See systemd-system.conf(5) man page
for available options. for available options.
''; '';
}; };
systemd.sleep.extraConfig = mkOption { sleep.extraConfig = mkOption {
default = ""; default = "";
type = types.lines; type = types.lines;
example = "HibernateDelaySec=1h"; example = "HibernateDelaySec=1h";
description = lib.mdDoc '' description = ''
Extra config options for systemd sleep state logic. Extra config options for systemd sleep state logic.
See sleep.conf.d(5) man page for available options. See sleep.conf.d(5) man page for available options.
''; '';
}; };
systemd.additionalUpstreamSystemUnits = mkOption { additionalUpstreamSystemUnits = mkOption {
default = [ ]; default = [ ];
type = types.listOf types.str; type = types.listOf types.str;
example = [ "debug-shell.service" "systemd-quotacheck.service" ]; example = [ "debug-shell.service" "systemd-quotacheck.service" ];
description = lib.mdDoc '' description = ''
Additional units shipped with systemd that shall be enabled. Additional units shipped with systemd that shall be enabled.
''; '';
}; };
systemd.suppressedSystemUnits = mkOption { suppressedSystemUnits = mkOption {
default = [ ]; default = [ ];
type = types.listOf types.str; type = types.listOf types.str;
example = [ "systemd-backlight@.service" ]; example = [ "systemd-backlight@.service" ];
description = lib.mdDoc '' description = ''
A list of units to skip when generating system systemd configuration directory. This has A list of units to skip when generating system systemd configuration directory. This has
priority over upstream units, {option}`systemd.units`, and priority over upstream units, {option}`systemd.units`, and
{option}`systemd.additionalUpstreamSystemUnits`. The main purpose of this is to {option}`systemd.additionalUpstreamSystemUnits`. The main purpose of this is to
@@ -368,32 +368,32 @@ in
''; '';
}; };
systemd.watchdog.device = mkOption { watchdog.device = mkOption {
type = types.nullOr types.path; type = types.nullOr types.path;
default = null; default = null;
example = "/dev/watchdog"; example = "/dev/watchdog";
description = lib.mdDoc '' description = ''
The path to a hardware watchdog device which will be managed by systemd. The path to a hardware watchdog device which will be managed by systemd.
If not specified, systemd will default to /dev/watchdog. If not specified, systemd will default to /dev/watchdog.
''; '';
}; };
systemd.watchdog.runtimeTime = mkOption { watchdog.runtimeTime = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
example = "30s"; example = "30s";
description = lib.mdDoc '' description = ''
The amount of time which can elapse before a watchdog hardware device The amount of time which can elapse before a watchdog hardware device
will automatically reboot the system. Valid time units include "ms", will automatically reboot the system. Valid time units include "ms",
"s", "min", "h", "d", and "w". "s", "min", "h", "d", and "w".
''; '';
}; };
systemd.watchdog.rebootTime = mkOption { watchdog.rebootTime = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
example = "10m"; example = "10m";
description = lib.mdDoc '' description = ''
The amount of time which can elapse after a reboot has been triggered The amount of time which can elapse after a reboot has been triggered
before a watchdog hardware device will automatically reboot the system. before a watchdog hardware device will automatically reboot the system.
Valid time units include "ms", "s", "min", "h", "d", and "w". If left Valid time units include "ms", "s", "min", "h", "d", and "w". If left
@@ -402,11 +402,11 @@ in
''; '';
}; };
systemd.watchdog.kexecTime = mkOption { watchdog.kexecTime = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
example = "10m"; example = "10m";
description = lib.mdDoc '' description = ''
The amount of time which can elapse when kexec is being executed before The amount of time which can elapse when kexec is being executed before
a watchdog hardware device will automatically reboot the system. This a watchdog hardware device will automatically reboot the system. This
option should only be enabled if reloadTime is also enabled. Valid option should only be enabled if reloadTime is also enabled. Valid