nixpkgs-suyu/modules/services/network-filesystems/nfs-kernel.nix

169 lines
4.5 KiB
Nix
Raw Normal View History

{ config, pkgs, ... }:
with pkgs.lib;
let
inherit (pkgs) writeText openssh;
cfg = config.services.nfsKernel;
in
{
###### interface
options = {
services.nfsKernel = {
client.enable = mkOption {
default = false;
description = ''
Whether to enable the kernel's NFS client daemons.
'';
};
server = {
enable = mkOption {
default = false;
description = ''
Whether to enable the kernel's NFS server.
'';
};
exports = mkOption {
default = "";
description = ''
Contents of the /etc/exports file. See
<citerefentry><refentrytitle>exports</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for the format.
'';
};
hostName = mkOption {
default = null;
description = ''
Hostname or address on which NFS requests will be accepted.
Default is all. See the <option>-H</option> option in
<citerefentry><refentrytitle>nfsd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>.
'';
};
nproc = mkOption {
default = 8;
description = ''
Number of NFS server threads. Defaults to the recommended value of 8.
'';
};
createMountPoints = mkOption {
default = false;
description = "Whether to create the mount points in the exports file at startup time.";
};
};
};
};
###### implementation
config = {
services.portmap.enable = cfg.client.enable || cfg.server.enable;
assertions = mkIf (cfg.client.enable || cfg.server.enable) (singleton
{ assertion = cfg.client.enable || cfg.server.enable;
message = "Please enable portmap (services.portmap.enable) to use nfs-kernel.";
});
environment.etc = mkIf cfg.server.enable (singleton
{ source = cfg.server.exports;
target = "exports";
});
jobs =
optionalAttrs cfg.server.enable
{ nfs_kernel_exports =
{ name = "nfs-kernel-exports";
description = "Kernel NFS server";
startOn = "started network-interfaces";
stopOn = "stopping network-interfaces";
preStart =
''
export PATH=${pkgs.nfsUtils}/sbin:$PATH
mkdir -p /var/lib/nfs
${config.system.sbin.modprobe}/sbin/modprobe nfsd || true
${optionalString cfg.server.createMountPoints
''
# create export directories:
# skip comments, take first col which may either be a quoted
# "foo bar" or just foo (-> man export)
sed '/^#.*/d;s/^"\([^"]*\)".*/\1/;t;s/[ ].*//' ${cfg.server.exports} \
| xargs -d '\n' mkdir -p
''
}
# exports file is ${cfg.server.exports}
# keep this comment so that this job is restarted whenever exports changes!
exportfs -ra
'';
};
}
// optionalAttrs cfg.server.enable
{ nfs_kernel_nfsd =
{ name = "nfs-kernel-nfsd";
description = "Kernel NFS server";
startOn = "started nfs-kernel-exports and started portmap";
stopOn = "stopping nfs-kernel-exports";
exec = "${pkgs.nfsUtils}/sbin/rpc.nfsd ${if cfg.server.hostName != null then "-H ${cfg.server.hostName}" else ""} ${builtins.toString cfg.server.nproc}";
};
}
// optionalAttrs cfg.server.enable
{ nfs_kernel_mountd =
{ name = "nfs-kernel-mountd";
description = "Kernel NFS server - mount daemon";
startOn = "started nfs-kernel-nfsd and started portmap";
stopOn = "stopping nfs-kernel-exports";
exec = "${pkgs.nfsUtils}/sbin/rpc.mountd -F -f ${cfg.server.exports}";
};
}
// optionalAttrs (cfg.client.enable || cfg.server.enable)
{ nfs_kernel_statd =
{ name = "nfs-kernel-statd";
description = "Kernel NFS server - Network Status Monitor";
startOn = "started nfs-kernel-nfsd and started portmap";
stopOn = "stopping nfs-kernel-exports";
preStart =
''
mkdir -p /var/lib/nfs
'';
exec = "${pkgs.nfsUtils}/sbin/rpc.statd -F";
};
};
};
}