summaryrefslogtreecommitdiff
path: root/sys/fs/btrfs.nix
blob: f240b0d93da86fc0698c441429ccf9349335701d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
{ lib, config, pkgs, ... }:
with lib; let
  cfg = config.local;
in
{
  options.local = with lib.types; {
    snapperSubvols = mkOption {
      type = attrsOf str;
      default = { };
    };

    fs.btrfs = mkOption {
      default = [ ];

      type = attrsOf (submodule {
        options = {
          device = mkOption {
            type = str;
          };

          subvol = mkOption {
            type = str;
          };

          ssd = mkOption {
            type = bool;
          };

          snapper = mkOption {
            type = nullOr str;
            default = null;
          };
        };
      });
    };
  };

  config = {
    environment.systemPackages = optional (cfg.snapperSubvols != { }) pkgs.local.btclone;

    fileSystems =
      let
        inherit (cfg) fs;
        btrfs = { device, subvol, ssd, ... }: {
          inherit device;
          fsType = "btrfs";
          options = [ "noatime" "compress=zstd" "subvol=${subvol}" ] ++ optional ssd "ssd";
        };
      in
      mapAttrs (_: btrfs) cfg.fs.btrfs;

    local.snapperSubvols =
      let
        snapperEntry = path: opts: { name = opts.snapper; value = path; };
        validEntry = _: opts: opts.snapper != null;
      in
      mapAttrs' snapperEntry (filterAttrs validEntry cfg.fs.btrfs);

    services.snapper.configs =
      let
        snapperConfig = _: subvolume: {
          SUBVOLUME = subvolume;

          # btrfs qgroup for space aware cleanup algorithms
          QGROUP = "";

          # fraction of the filesystems space the snapshots may use
          SPACE_LIMIT = "0.5";

          # fraction of the filesystems space that should be free
          FREE_LIMIT = "0.2";

          # users and groups allowed to work with config
          ALLOW_USERS = [ ];
          ALLOW_GROUPS = [ ];

          # sync users and groups from ALLOW_USERS and ALLOW_GROUPS to .snapshots
          # directory
          SYNC_ACL = "no";

          # start comparing pre- and post-snapshot in background after creating
          # post-snapshot
          BACKGROUND_COMPARISON = "yes";

          # run daily number cleanup
          NUMBER_CLEANUP = "yes";

          # limit for number cleanup
          NUMBER_MIN_AGE = "1800";
          NUMBER_LIMIT = "100";
          NUMBER_LIMIT_IMPORTANT = "10";

          # create hourly snapshots
          TIMELINE_CREATE = true;

          # cleanup hourly snapshots after some time
          TIMELINE_CLEANUP = true;

          # limits for timeline cleanup
          TIMELINE_MIN_AGE = "1800";
          TIMELINE_LIMIT_HOURLY = "24";
          TIMELINE_LIMIT_DAILY = "7";
          TIMELINE_LIMIT_WEEKLY = "4";
          TIMELINE_LIMIT_MONTHLY = "12";
          TIMELINE_LIMIT_YEARLY = "10";

          # cleanup empty pre-post-pairs
          EMPTY_PRE_POST_CLEANUP = "yes";

          # limits for empty pre-post-pair cleanup
          EMPTY_PRE_POST_MIN_AGE = "1800";
        };
      in
      mapAttrs snapperConfig cfg.snapperSubvols;
  };
}