mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-11-18 05:33:56 +01:00
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
156 lines
4.2 KiB
Nix
156 lines
4.2 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.icecream.daemon;
|
|
in {
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
services.icecream.daemon = {
|
|
|
|
enable = mkEnableOption "Icecream Daemon";
|
|
|
|
openFirewall = mkOption {
|
|
type = types.bool;
|
|
description = lib.mdDoc ''
|
|
Whether to automatically open receive port in the firewall.
|
|
'';
|
|
};
|
|
|
|
openBroadcast = mkOption {
|
|
type = types.bool;
|
|
description = lib.mdDoc ''
|
|
Whether to automatically open the firewall for scheduler discovery.
|
|
'';
|
|
};
|
|
|
|
cacheLimit = mkOption {
|
|
type = types.ints.u16;
|
|
default = 256;
|
|
description = lib.mdDoc ''
|
|
Maximum size in Megabytes of cache used to store compile environments of compile clients.
|
|
'';
|
|
};
|
|
|
|
netName = mkOption {
|
|
type = types.str;
|
|
default = "ICECREAM";
|
|
description = lib.mdDoc ''
|
|
Network name to connect to. A scheduler with the same name needs to be running.
|
|
'';
|
|
};
|
|
|
|
noRemote = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Prevent jobs from other nodes being scheduled on this daemon.
|
|
'';
|
|
};
|
|
|
|
schedulerHost = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Explicit scheduler hostname, useful in firewalled environments.
|
|
|
|
Uses scheduler autodiscovery via broadcast if set to null.
|
|
'';
|
|
};
|
|
|
|
maxProcesses = mkOption {
|
|
type = types.nullOr types.ints.u16;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Maximum number of compile jobs started in parallel for this daemon.
|
|
|
|
Uses the number of CPUs if set to null.
|
|
'';
|
|
};
|
|
|
|
nice = mkOption {
|
|
type = types.int;
|
|
default = 5;
|
|
description = lib.mdDoc ''
|
|
The level of niceness to use.
|
|
'';
|
|
};
|
|
|
|
hostname = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Hostname of the daemon in the icecream infrastructure.
|
|
|
|
Uses the hostname retrieved via uname if set to null.
|
|
'';
|
|
};
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "icecc";
|
|
description = lib.mdDoc ''
|
|
User to run the icecream daemon as. Set to root to enable receive of
|
|
remote compile environments.
|
|
'';
|
|
};
|
|
|
|
package = mkOption {
|
|
default = pkgs.icecream;
|
|
defaultText = literalExpression "pkgs.icecream";
|
|
type = types.package;
|
|
description = lib.mdDoc "Icecream package to use.";
|
|
};
|
|
|
|
extraArgs = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [];
|
|
description = lib.mdDoc "Additional command line parameters.";
|
|
example = [ "-v" ];
|
|
};
|
|
};
|
|
};
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ 10245 ];
|
|
networking.firewall.allowedUDPPorts = mkIf cfg.openBroadcast [ 8765 ];
|
|
|
|
systemd.services.icecc-daemon = {
|
|
description = "Icecream compile daemon";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
serviceConfig = {
|
|
ExecStart = escapeShellArgs ([
|
|
"${getBin cfg.package}/bin/iceccd"
|
|
"-b" "$STATE_DIRECTORY"
|
|
"-u" "icecc"
|
|
(toString cfg.nice)
|
|
]
|
|
++ optionals (cfg.schedulerHost != null) ["-s" cfg.schedulerHost]
|
|
++ optionals (cfg.netName != null) [ "-n" cfg.netName ]
|
|
++ optionals (cfg.cacheLimit != null) [ "--cache-limit" (toString cfg.cacheLimit) ]
|
|
++ optionals (cfg.maxProcesses != null) [ "-m" (toString cfg.maxProcesses) ]
|
|
++ optionals (cfg.hostname != null) [ "-N" (cfg.hostname) ]
|
|
++ optional cfg.noRemote "--no-remote"
|
|
++ cfg.extraArgs);
|
|
DynamicUser = true;
|
|
User = "icecc";
|
|
Group = "icecc";
|
|
StateDirectory = "icecc";
|
|
RuntimeDirectory = "icecc";
|
|
AmbientCapabilities = "CAP_SYS_CHROOT";
|
|
CapabilityBoundingSet = "CAP_SYS_CHROOT";
|
|
};
|
|
};
|
|
};
|
|
|
|
meta.maintainers = with lib.maintainers; [ emantor ];
|
|
}
|