commit 145a3d084af985c7c39d4de8fc5630f8c0b9da1c · pyrox.dev/nixpkgs

nixos/doc/manual/from_md/release-notes/rl-2111.section.xml

···

       78
       78
        
                 <link linkend="opt-services.vikunja.enable">services.vikunja</link>.

     

       79
       79
        
               </para>

     

       80
       80
        
             </listitem>

     

       81
       81
       +
             <listitem>

     

       82
       82
       +
               <para>

     

       83
       83
       +
                 <link xlink:href="https://www.snapraid.it/">snapraid</link>, a

     

       84
       84
       +
                 backup program for disk arrays. Available as

     

       85
       85
       +
                 <link linkend="opt-snapraid.enable">snapraid</link>.

     

       86
       86
       +
               </para>

     

       87
       87
       +
             </listitem>

     

       81
       88
        
           </itemizedlist>

     

       82
       89
        
         </section>

     

       83
       90
        
         <section xml:id="sec-release-21.11-incompatibilities">

nixos/doc/manual/release-notes/rl-2111.section.md

···

       23
       23
        
       

     

       24
       24
        
       - [vikunja](https://vikunja.io), a to-do list app. Available as [services.vikunja](#opt-services.vikunja.enable).

     

       25
       25
        
       

     

       26
       26
       +
       - [snapraid](https://www.snapraid.it/), a backup program for disk arrays.

     

       27
       27
       +
         Available as [snapraid](#opt-snapraid.enable).

     

       28
       28
       +
       

     

       29
       29
       +
       

     

       26
       30
        
       ## Backward Incompatibilities {#sec-release-21.11-incompatibilities}

     

       27
       31
        
       

     

       28
       32
        
       - The `staticjinja` package has been upgraded from 1.0.4 to 3.0.1

nixos/modules/module-list.nix

···

       1104
       1104
        
         ./tasks/network-interfaces-systemd.nix

     

       1105
       1105
        
         ./tasks/network-interfaces-scripted.nix

     

       1106
       1106
        
         ./tasks/scsi-link-power-management.nix

     

       1107
       1107
       +
         ./tasks/snapraid.nix

     

       1107
       1108
        
         ./tasks/swraid.nix

     

       1108
       1109
        
         ./tasks/trackpoint.nix

     

       1109
       1110
        
         ./tasks/powertop.nix

+230

nixos/modules/tasks/snapraid.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let cfg = config.snapraid;

     

       6
       6
       +
       in

     

       7
       7
       +
       {

     

       8
       8
       +
         options.snapraid = with types; {

     

       9
       9
       +
           enable = mkEnableOption "SnapRAID";

     

       10
       10
       +
           dataDisks = mkOption {

     

       11
       11
       +
             default = { };

     

       12
       12
       +
             example = {

     

       13
       13
       +
               d1 = "/mnt/disk1/";

     

       14
       14
       +
               d2 = "/mnt/disk2/";

     

       15
       15
       +
               d3 = "/mnt/disk3/";

     

       16
       16
       +
             };

     

       17
       17
       +
             description = "SnapRAID data disks.";

     

       18
       18
       +
             type = attrsOf str;

     

       19
       19
       +
           };

     

       20
       20
       +
           parityFiles = mkOption {

     

       21
       21
       +
             default = [ ];

     

       22
       22
       +
             example = [

     

       23
       23
       +
               "/mnt/diskp/snapraid.parity"

     

       24
       24
       +
               "/mnt/diskq/snapraid.2-parity"

     

       25
       25
       +
               "/mnt/diskr/snapraid.3-parity"

     

       26
       26
       +
               "/mnt/disks/snapraid.4-parity"

     

       27
       27
       +
               "/mnt/diskt/snapraid.5-parity"

     

       28
       28
       +
               "/mnt/disku/snapraid.6-parity"

     

       29
       29
       +
             ];

     

       30
       30
       +
             description = "SnapRAID parity files.";

     

       31
       31
       +
             type = listOf str;

     

       32
       32
       +
           };

     

       33
       33
       +
           contentFiles = mkOption {

     

       34
       34
       +
             default = [ ];

     

       35
       35
       +
             example = [

     

       36
       36
       +
               "/var/snapraid.content"

     

       37
       37
       +
               "/mnt/disk1/snapraid.content"

     

       38
       38
       +
               "/mnt/disk2/snapraid.content"

     

       39
       39
       +
             ];

     

       40
       40
       +
             description = "SnapRAID content list files.";

     

       41
       41
       +
             type = listOf str;

     

       42
       42
       +
           };

     

       43
       43
       +
           exclude = mkOption {

     

       44
       44
       +
             default = [ ];

     

       45
       45
       +
             example = [ "*.unrecoverable" "/tmp/" "/lost+found/" ];

     

       46
       46
       +
             description = "SnapRAID exclude directives.";

     

       47
       47
       +
             type = listOf str;

     

       48
       48
       +
           };

     

       49
       49
       +
           touchBeforeSync = mkOption {

     

       50
       50
       +
             default = true;

     

       51
       51
       +
             example = false;

     

       52
       52
       +
             description =

     

       53
       53
       +
               "Whether <command>snapraid touch</command> should be run before <command>snapraid sync</command>.";

     

       54
       54
       +
             type = bool;

     

       55
       55
       +
           };

     

       56
       56
       +
           sync.interval = mkOption {

     

       57
       57
       +
             default = "01:00";

     

       58
       58
       +
             example = "daily";

     

       59
       59
       +
             description = "How often to run <command>snapraid sync</command>.";

     

       60
       60
       +
             type = str;

     

       61
       61
       +
           };

     

       62
       62
       +
           scrub = {

     

       63
       63
       +
             interval = mkOption {

     

       64
       64
       +
               default = "Mon *-*-* 02:00:00";

     

       65
       65
       +
               example = "weekly";

     

       66
       66
       +
               description = "How often to run <command>snapraid scrub</command>.";

     

       67
       67
       +
               type = str;

     

       68
       68
       +
             };

     

       69
       69
       +
             plan = mkOption {

     

       70
       70
       +
               default = 8;

     

       71
       71
       +
               example = 5;

     

       72
       72
       +
               description =

     

       73
       73
       +
                 "Percent of the array that should be checked by <command>snapraid scrub</command>.";

     

       74
       74
       +
               type = int;

     

       75
       75
       +
             };

     

       76
       76
       +
             olderThan = mkOption {

     

       77
       77
       +
               default = 10;

     

       78
       78
       +
               example = 20;

     

       79
       79
       +
               description =

     

       80
       80
       +
                 "Number of days since data was last scrubbed before it can be scrubbed again.";

     

       81
       81
       +
               type = int;

     

       82
       82
       +
             };

     

       83
       83
       +
           };

     

       84
       84
       +
           extraConfig = mkOption {

     

       85
       85
       +
             default = "";

     

       86
       86
       +
             example = ''

     

       87
       87
       +
               nohidden

     

       88
       88
       +
               blocksize 256

     

       89
       89
       +
               hashsize 16

     

       90
       90
       +
               autosave 500

     

       91
       91
       +
               pool /pool

     

       92
       92
       +
             '';

     

       93
       93
       +
             description = "Extra config options for SnapRAID.";

     

       94
       94
       +
             type = lines;

     

       95
       95
       +
           };

     

       96
       96
       +
         };

     

       97
       97
       +
       

     

       98
       98
       +
         config =

     

       99
       99
       +
           let

     

       100
       100
       +
             nParity = builtins.length cfg.parityFiles;

     

       101
       101
       +
             mkPrepend = pre: s: pre + s;

     

       102
       102
       +
           in

     

       103
       103
       +
           mkIf cfg.enable {

     

       104
       104
       +
             assertions = [

     

       105
       105
       +
               {

     

       106
       106
       +
                 assertion = nParity <= 6;

     

       107
       107
       +
                 message = "You can have no more than six SnapRAID parity files.";

     

       108
       108
       +
               }

     

       109
       109
       +
               {

     

       110
       110
       +
                 assertion = builtins.length cfg.contentFiles >= nParity + 1;

     

       111
       111
       +
                 message =

     

       112
       112
       +
                   "There must be at least one SnapRAID content file for each SnapRAID parity file plus one.";

     

       113
       113
       +
               }

     

       114
       114
       +
             ];

     

       115
       115
       +
       

     

       116
       116
       +
             environment = {

     

       117
       117
       +
               systemPackages = with pkgs; [ snapraid ];

     

       118
       118
       +
       

     

       119
       119
       +
               etc."snapraid.conf" = {

     

       120
       120
       +
                 text = with cfg;

     

       121
       121
       +
                   let

     

       122
       122
       +
                     prependData = mkPrepend "data ";

     

       123
       123
       +
                     prependContent = mkPrepend "content ";

     

       124
       124
       +
                     prependExclude = mkPrepend "exclude ";

     

       125
       125
       +
                   in

     

       126
       126
       +
                   concatStringsSep "\n"

     

       127
       127
       +
                     (map prependData

     

       128
       128
       +
                       ((mapAttrsToList (name: value: name + " " + value)) dataDisks)

     

       129
       129
       +
                     ++ zipListsWith (a: b: a + b)

     

       130
       130
       +
                       ([ "parity " ] ++ map (i: toString i + "-parity ") (range 2 6))

     

       131
       131
       +
                       parityFiles ++ map prependContent contentFiles

     

       132
       132
       +
                     ++ map prependExclude exclude) + "\n" + extraConfig;

     

       133
       133
       +
               };

     

       134
       134
       +
             };

     

       135
       135
       +
       

     

       136
       136
       +
             systemd.services = with cfg; {

     

       137
       137
       +
               snapraid-scrub = {

     

       138
       138
       +
                 description = "Scrub the SnapRAID array";

     

       139
       139
       +
                 startAt = scrub.interval;

     

       140
       140
       +
                 serviceConfig = {

     

       141
       141
       +
                   Type = "oneshot";

     

       142
       142
       +
                   ExecStart = "${pkgs.snapraid}/bin/snapraid scrub -p ${

     

       143
       143
       +
                     toString scrub.plan

     

       144
       144
       +
                   } -o ${toString scrub.olderThan}";

     

       145
       145
       +
                   Nice = 19;

     

       146
       146
       +
                   IOSchedulingPriority = 7;

     

       147
       147
       +
                   CPUSchedulingPolicy = "batch";

     

       148
       148
       +
       

     

       149
       149
       +
                   LockPersonality = true;

     

       150
       150
       +
                   MemoryDenyWriteExecute = true;

     

       151
       151
       +
                   NoNewPrivileges = true;

     

       152
       152
       +
                   PrivateDevices = true;

     

       153
       153
       +
                   PrivateTmp = true;

     

       154
       154
       +
                   ProtectClock = true;

     

       155
       155
       +
                   ProtectControlGroups = true;

     

       156
       156
       +
                   ProtectHostname = true;

     

       157
       157
       +
                   ProtectKernelLogs = true;

     

       158
       158
       +
                   ProtectKernelModules = true;

     

       159
       159
       +
                   ProtectKernelTunables = true;

     

       160
       160
       +
                   RestrictAddressFamilies = "none";

     

       161
       161
       +
                   RestrictNamespaces = true;

     

       162
       162
       +
                   RestrictRealtime = true;

     

       163
       163
       +
                   RestrictSUIDSGID = true;

     

       164
       164
       +
                   SystemCallArchitectures = "native";

     

       165
       165
       +
                   SystemCallFilter = "@system-service";

     

       166
       166
       +
                   SystemCallErrorNumber = "EPERM";

     

       167
       167
       +
                   CapabilityBoundingSet = "CAP_DAC_OVERRIDE";

     

       168
       168
       +
       

     

       169
       169
       +
                   ProtectSystem = "strict";

     

       170
       170
       +
                   ProtectHome = "read-only";

     

       171
       171
       +
                   ReadWritePaths =

     

       172
       172
       +
                     # scrub requires access to directories containing content files

     

       173
       173
       +
                     # to remove them if they are stale

     

       174
       174
       +
                     let

     

       175
       175
       +
                       contentDirs = map dirOf contentFiles;

     

       176
       176
       +
                     in

     

       177
       177
       +
                     unique (

     

       178
       178
       +
                       attrValues dataDisks ++ contentDirs

     

       179
       179
       +
                     );

     

       180
       180
       +
                 };

     

       181
       181
       +
                 unitConfig.After = "snapraid-sync.service";

     

       182
       182
       +
               };

     

       183
       183
       +
               snapraid-sync = {

     

       184
       184
       +
                 description = "Synchronize the state of the SnapRAID array";

     

       185
       185
       +
                 startAt = sync.interval;

     

       186
       186
       +
                 serviceConfig = {

     

       187
       187
       +
                   Type = "oneshot";

     

       188
       188
       +
                   ExecStart = "${pkgs.snapraid}/bin/snapraid sync";

     

       189
       189
       +
                   Nice = 19;

     

       190
       190
       +
                   IOSchedulingPriority = 7;

     

       191
       191
       +
                   CPUSchedulingPolicy = "batch";

     

       192
       192
       +
       

     

       193
       193
       +
                   LockPersonality = true;

     

       194
       194
       +
                   MemoryDenyWriteExecute = true;

     

       195
       195
       +
                   NoNewPrivileges = true;

     

       196
       196
       +
                   PrivateDevices = true;

     

       197
       197
       +
                   PrivateTmp = true;

     

       198
       198
       +
                   ProtectClock = true;

     

       199
       199
       +
                   ProtectControlGroups = true;

     

       200
       200
       +
                   ProtectHostname = true;

     

       201
       201
       +
                   ProtectKernelLogs = true;

     

       202
       202
       +
                   ProtectKernelModules = true;

     

       203
       203
       +
                   ProtectKernelTunables = true;

     

       204
       204
       +
                   RestrictAddressFamilies = "none";

     

       205
       205
       +
                   RestrictNamespaces = true;

     

       206
       206
       +
                   RestrictRealtime = true;

     

       207
       207
       +
                   RestrictSUIDSGID = true;

     

       208
       208
       +
                   SystemCallArchitectures = "native";

     

       209
       209
       +
                   SystemCallFilter = "@system-service";

     

       210
       210
       +
                   SystemCallErrorNumber = "EPERM";

     

       211
       211
       +
                   CapabilityBoundingSet = "CAP_DAC_OVERRIDE";

     

       212
       212
       +
       

     

       213
       213
       +
                   ProtectSystem = "strict";

     

       214
       214
       +
                   ProtectHome = "read-only";

     

       215
       215
       +
                   ReadWritePaths =

     

       216
       216
       +
                     # sync requires access to directories containing content files

     

       217
       217
       +
                     # to remove them if they are stale

     

       218
       218
       +
                     let

     

       219
       219
       +
                       contentDirs = map dirOf contentFiles;

     

       220
       220
       +
                     in

     

       221
       221
       +
                     unique (

     

       222
       222
       +
                       attrValues dataDisks ++ parityFiles ++ contentDirs

     

       223
       223
       +
                     );

     

       224
       224
       +
                 } // optionalAttrs touchBeforeSync {

     

       225
       225
       +
                   ExecStartPre = "${pkgs.snapraid}/bin/snapraid touch";

     

       226
       226
       +
                 };

     

       227
       227
       +
               };

     

       228
       228
       +
             };

     

       229
       229
       +
           };

     

       230
       230
       +
       }