329 lines
11 KiB
Nix
329 lines
11 KiB
Nix
{ config, pkgs, ... }:
|
|
|
|
with pkgs.lib;
|
|
|
|
let
|
|
|
|
inherit (config.environment) nix;
|
|
|
|
makeNixBuildUser = nr:
|
|
{ name = "nixbld${toString nr}";
|
|
description = "Nix build user ${toString nr}";
|
|
|
|
/* For consistency with the setgid(2), setuid(2), and setgroups(2)
|
|
calls in `libstore/build.cc', don't add any supplementary group
|
|
here except "nixbld". */
|
|
uid = builtins.add config.ids.uids.nixbld nr;
|
|
group = "nixbld";
|
|
extraGroups = [ "nixbld" ];
|
|
};
|
|
|
|
in
|
|
|
|
{
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
environment.nix = mkOption {
|
|
default = pkgs.nixUnstable;
|
|
merge = mergeOneOption;
|
|
description = ''
|
|
This option specifies the Nix package instance to use throughout the system.
|
|
'';
|
|
};
|
|
|
|
nix = {
|
|
|
|
maxJobs = mkOption {
|
|
default = 1;
|
|
example = 2;
|
|
description = "
|
|
This option defines the maximum number of jobs that Nix will try
|
|
to build in parallel. The default is 1. You should generally
|
|
set it to the number of CPUs in your system (e.g., 2 on a Athlon
|
|
64 X2).
|
|
";
|
|
};
|
|
|
|
useChroot = mkOption {
|
|
default = false;
|
|
example = true;
|
|
description = "
|
|
If set, Nix will perform builds in a chroot-environment that it
|
|
will set up automatically for each build. This prevents
|
|
impurities in builds by disallowing access to dependencies
|
|
outside of the Nix store.
|
|
";
|
|
};
|
|
|
|
chrootDirs = mkOption {
|
|
default = [];
|
|
example = [ "/dev" "/proc" ];
|
|
description =
|
|
''
|
|
Directories from the host filesystem to be included
|
|
in the chroot.
|
|
'';
|
|
};
|
|
|
|
extraOptions = mkOption {
|
|
default = "";
|
|
example = "
|
|
gc-keep-outputs = true
|
|
gc-keep-derivations = true
|
|
";
|
|
description = "
|
|
This option allows to append lines to nix.conf.
|
|
";
|
|
};
|
|
|
|
distributedBuilds = mkOption {
|
|
default = false;
|
|
description = "
|
|
Whether to distribute builds to the machines listed in
|
|
<option>nix.buildMachines</option>.
|
|
If you know that the <option>buildMachines</option> are not
|
|
always available either use nixos
|
|
<command>nixos-rebuild --no-build-hook</command>
|
|
or consider managing <filename>/etc/nix.machines</filename> manually
|
|
by setting <option>manualNixMachines</option>. Then you can comment
|
|
unavailable buildmachines.
|
|
";
|
|
};
|
|
|
|
manualNixMachines = mkOption {
|
|
default = false;
|
|
description = "
|
|
Whether to manually manage the list of buildmachines used in distributed
|
|
builds in /etc/nix.machines.
|
|
";
|
|
};
|
|
|
|
daemonNiceLevel = mkOption {
|
|
default = 10;
|
|
description = "
|
|
Nix daemon process priority. This priority propagates to build processes.
|
|
0 is the default Unix process priority, 20 is the lowest.
|
|
";
|
|
};
|
|
|
|
daemonIONiceLevel = mkOption {
|
|
default = 7;
|
|
description = "
|
|
Nix daemon process I/O priority. This priority propagates to build processes.
|
|
0 is the default Unix process I/O priority, 7 is the lowest.
|
|
";
|
|
};
|
|
|
|
buildMachines = mkOption {
|
|
example = [
|
|
{ hostName = "voila.labs.cs.uu.nl";
|
|
sshUser = "nix";
|
|
sshKey = "/root/.ssh/id_buildfarm";
|
|
system = "powerpc-darwin";
|
|
maxJobs = 1;
|
|
}
|
|
{ hostName = "linux64.example.org";
|
|
sshUser = "buildfarm";
|
|
sshKey = "/root/.ssh/id_buildfarm";
|
|
system = "x86_64-linux";
|
|
maxJobs = 2;
|
|
}
|
|
];
|
|
description = "
|
|
This option lists the machines to be used if distributed
|
|
builds are enabled (see
|
|
<option>nix.distributedBuilds</option>). Nix will perform
|
|
derivations on those machines via SSh by copying the inputs to
|
|
the Nix store on the remote machine, starting the build, then
|
|
copying the output back to the local Nix store. Each element
|
|
of the list should be an attribute set containing the
|
|
machine's host name (<varname>hostname</varname>), the user
|
|
name to be used for the SSH connection
|
|
(<varname>sshUser</varname>), the Nix system type
|
|
(<varname>system</varname>, e.g.,
|
|
<literal>\"i686-linux\"</literal>), the maximum number of jobs
|
|
to be run in parallel on that machine
|
|
(<varname>maxJobs</varname>), and the path to the SSH private
|
|
key to be used to connect (<varname>sshKey</varname>). The
|
|
SSH private key should not have a passphrase, and the
|
|
corresponding public key should be added to
|
|
<filename>~<replaceable>sshUser</replaceable>/authorized_keys</filename>
|
|
on the remote machine.
|
|
";
|
|
};
|
|
|
|
proxy = mkOption {
|
|
default = "";
|
|
description = "
|
|
This option specifies the proxy to use for fetchurl. The real effect
|
|
is just exporting http_proxy, https_proxy and ftp_proxy with that
|
|
value.
|
|
";
|
|
example = "http://127.0.0.1:3128";
|
|
};
|
|
|
|
# Environment variables for running Nix. !!! Misnomer - it's
|
|
# actually a shell script.
|
|
envVars = mkOption {
|
|
internal = true;
|
|
default = "";
|
|
type = types.string;
|
|
description = "
|
|
Environment variables used by Nix.
|
|
";
|
|
};
|
|
|
|
nrBuildUsers = mkOption {
|
|
default = 10;
|
|
description = ''
|
|
Number of <literal>nixbld</literal> user accounts created to
|
|
perform secure concurrent builds. If you receive an error
|
|
message saying that “all build users are currently in use”,
|
|
you should increase this value.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
|
|
###### implementation
|
|
|
|
config = {
|
|
|
|
nix.chrootDirs = [ "/dev" "/dev/pts" "/proc" "/bin" ];
|
|
|
|
environment.etc =
|
|
[ { # Nix configuration.
|
|
source =
|
|
let
|
|
# Tricky: if we're using a chroot for builds, then we need
|
|
# /bin/sh in the chroot (our own compromise to purity).
|
|
# However, since /bin/sh is a symlink to some path in the
|
|
# Nix store, which furthermore has runtime dependencies on
|
|
# other paths in the store, we need the closure of /bin/sh
|
|
# in `build-chroot-dirs' - otherwise any builder that uses
|
|
# /bin/sh won't work.
|
|
binshDeps = pkgs.writeReferencesToFile config.system.build.binsh;
|
|
in
|
|
pkgs.runCommand "nix.conf" {extraOptions = config.nix.extraOptions; } ''
|
|
extraPaths=$(for i in $(cat ${binshDeps}); do if test -d $i; then echo $i; fi; done)
|
|
cat > $out <<END
|
|
# WARNING: this file is generated.
|
|
build-users-group = nixbld
|
|
build-max-jobs = ${toString (config.nix.maxJobs)}
|
|
build-use-chroot = ${if config.nix.useChroot then "true" else "false"}
|
|
build-chroot-dirs = ${toString config.nix.chrootDirs} $(echo $extraPaths)
|
|
$extraOptions
|
|
END
|
|
'';
|
|
target = "nix/nix.conf";
|
|
}
|
|
]
|
|
|
|
++ optional (config.nix.distributedBuilds && !config.nix.manualNixMachines)
|
|
{ # List of machines for distributed Nix builds in the format expected
|
|
# by build-remote.pl.
|
|
source = pkgs.writeText "nix.machines"
|
|
(concatStrings (map (machine:
|
|
"${machine.sshUser}@${machine.hostName} "
|
|
+ (if machine ? system then machine.system else concatStringsSep "," machine.systems)
|
|
+ " ${machine.sshKey} ${toString machine.maxJobs} "
|
|
+ (if machine ? speedFactor then toString machine.speedFactor else "1" )
|
|
+ "\n"
|
|
) config.nix.buildMachines));
|
|
target = "nix.machines";
|
|
};
|
|
|
|
jobs.nixDaemon =
|
|
{ name = "nix-daemon";
|
|
|
|
startOn = "startup";
|
|
|
|
path = [ nix pkgs.openssl pkgs.utillinux ]
|
|
++ optionals config.nix.distributedBuilds [ pkgs.openssh pkgs.gzip ];
|
|
|
|
script =
|
|
''
|
|
${config.nix.envVars}
|
|
exec \
|
|
nice -n ${builtins.toString config.nix.daemonNiceLevel} \
|
|
ionice -n ${builtins.toString config.nix.daemonIONiceLevel} \
|
|
nix-worker --daemon > /dev/null 2>&1
|
|
'';
|
|
|
|
extraConfig =
|
|
''
|
|
limit nofile 4096 4096
|
|
'';
|
|
};
|
|
|
|
environment.shellInit =
|
|
''
|
|
# Set up the environment variables for running Nix.
|
|
${config.nix.envVars}
|
|
|
|
# Set up secure multi-user builds: non-root users build through the
|
|
# Nix daemon.
|
|
if test "$USER" != root; then
|
|
export NIX_REMOTE=daemon
|
|
else
|
|
export NIX_REMOTE=
|
|
fi
|
|
'';
|
|
|
|
nix.envVars =
|
|
''
|
|
export NIX_CONF_DIR=/etc/nix
|
|
|
|
# Enable the copy-from-other-stores substituter, which allows builds
|
|
# to be sped up by copying build results from remote Nix stores. To
|
|
# do this, mount the remote file system on a subdirectory of
|
|
# /var/run/nix/remote-stores.
|
|
export NIX_OTHER_STORES=/var/run/nix/remote-stores/*/nix
|
|
'' # */
|
|
+ optionalString config.nix.distributedBuilds ''
|
|
export NIX_BUILD_HOOK=${config.environment.nix}/libexec/nix/build-remote.pl
|
|
export NIX_REMOTE_SYSTEMS=/etc/nix.machines
|
|
export NIX_CURRENT_LOAD=/var/run/nix/current-load
|
|
''
|
|
# !!! These should not be defined here, but in some general proxy configuration module!
|
|
+ optionalString (config.nix.proxy != "") ''
|
|
export http_proxy=${config.nix.proxy}
|
|
export https_proxy=${config.nix.proxy}
|
|
export ftp_proxy=${config.nix.proxy}
|
|
'';
|
|
|
|
users.extraUsers = map makeNixBuildUser (range 1 config.nix.nrBuildUsers);
|
|
|
|
system.activationScripts.nix = stringAfter [ "etc" "users" ]
|
|
''
|
|
# Set up Nix.
|
|
chown root.nixbld /nix/store
|
|
chmod 1775 /nix/store
|
|
|
|
# Nix initialisation.
|
|
mkdir -m 0755 -p \
|
|
/nix/var/nix/gcroots \
|
|
/nix/var/nix/temproots \
|
|
/nix/var/nix/manifests \
|
|
/nix/var/nix/userpool \
|
|
/nix/var/nix/profiles \
|
|
/nix/var/nix/db \
|
|
/nix/var/log/nix/drvs \
|
|
/nix/var/nix/channel-cache \
|
|
/nix/var/nix/chroots
|
|
mkdir -m 1777 -p /nix/var/nix/gcroots/per-user
|
|
mkdir -m 1777 -p /nix/var/nix/profiles/per-user
|
|
mkdir -m 1777 -p /nix/var/nix/gcroots/tmp
|
|
|
|
ln -sf /nix/var/nix/profiles /nix/var/nix/gcroots/
|
|
ln -sf /nix/var/nix/manifests /nix/var/nix/gcroots/
|
|
'';
|
|
|
|
};
|
|
|
|
}
|