diff --git a/nixos/doc/manual/release-notes/rl-2103.xml b/nixos/doc/manual/release-notes/rl-2103.xml
index 9bff9a74507..62dcbd6184e 100644
--- a/nixos/doc/manual/release-notes/rl-2103.xml
+++ b/nixos/doc/manual/release-notes/rl-2103.xml
@@ -151,6 +151,15 @@
vim switched to Python 3, dropping all Python 2 support.
+
+
+ boot.zfs.forceImportAll
+ previously did nothing, but has been fixed. However its default has been
+ changed to false to preserve the existing default
+ behaviour. If you have this explicitly set to true,
+ please note that your non-root pools will now be forcibly imported.
+
+
diff --git a/nixos/modules/tasks/filesystems/zfs.nix b/nixos/modules/tasks/filesystems/zfs.nix
index 9ca7c6fb343..7b6c2277741 100644
--- a/nixos/modules/tasks/filesystems/zfs.nix
+++ b/nixos/modules/tasks/filesystems/zfs.nix
@@ -175,14 +175,10 @@ in
forceImportAll = mkOption {
type = types.bool;
- default = true;
+ default = false;
description = ''
Forcibly import all ZFS pool(s).
- This is enabled by default for backwards compatibility purposes, but it is highly
- recommended to disable this option, as it bypasses some of the safeguards ZFS uses
- to protect your ZFS pools.
-
If you set this option to false and NixOS subsequently fails to
import your non-root ZFS pool(s), you should manually import each pool with
"zpool import -f <pool-name>", and then reboot. You should only need to do
@@ -507,6 +503,7 @@ in
Type = "oneshot";
RemainAfterExit = true;
};
+ environment.ZFS_FORCE = optionalString cfgZfs.forceImportAll "-f";
script = (importLib {
# See comments at importLib definition.
zpoolCmd="${packages.zfsUser}/sbin/zpool";
diff --git a/nixos/tests/zfs.nix b/nixos/tests/zfs.nix
index 87e6c900c98..e05cd540227 100644
--- a/nixos/tests/zfs.nix
+++ b/nixos/tests/zfs.nix
@@ -18,7 +18,7 @@ let
maintainers = [ adisbladis ];
};
- machine = { pkgs, ... }: {
+ machine = { pkgs, lib, ... }: {
virtualisation.emptyDiskImages = [ 4096 ];
networking.hostId = "deadbeef";
boot.kernelPackages = kernelPackage;
@@ -26,6 +26,24 @@ let
boot.zfs.enableUnstable = enableUnstable;
environment.systemPackages = [ pkgs.parted ];
+
+ # Setup regular fileSystems machinery to ensure forceImportAll can be
+ # tested via the regular service units.
+ fileSystems = lib.mkVMOverride {
+ "/forcepool" = {
+ device = "forcepool";
+ fsType = "zfs";
+ options = [ "noauto" ];
+ };
+ };
+
+ # forcepool doesn't exist at first boot, and we need to manually test
+ # the import after tweaking the hostId.
+ systemd.services.zfs-import-forcepool.wantedBy = lib.mkVMOverride [];
+ systemd.targets.zfs.wantedBy = lib.mkVMOverride [];
+ boot.zfs.forceImportAll = true;
+ # /dev/disk/by-id doesn't get populated in the NixOS test framework
+ boot.zfs.devNodes = "/dev/disk/by-uuid";
};
testScript = ''
@@ -57,6 +75,21 @@ let
"zpool destroy rpool",
"udevadm settle",
)
+
+ with subtest("boot.zfs.forceImportAll works"):
+ machine.succeed(
+ "rm /etc/hostid",
+ "zgenhostid deadcafe",
+ "zpool create forcepool /dev/vdb1 -O mountpoint=legacy",
+ )
+ machine.shutdown()
+ machine.start()
+ machine.succeed("udevadm settle")
+ machine.fail("zpool import forcepool")
+ machine.succeed(
+ "systemctl start zfs-import-forcepool.service",
+ "mount -t zfs forcepool /tmp/mnt",
+ )
'' + extraTest;
};