commit 872c89e5a754a04058b4531e54897db5ca734100 · pyrox.dev/nixpkgs

+20

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

···

       197
       197
        
       

     

       198
       198
        
       - `services.sourcehut.dispatch` and the corresponding package (`sourcehut.dispatchsrht`) have been removed due to [upstream deprecation](https://sourcehut.org/blog/2022-08-01-dispatch-deprecation-plans/).

     

       199
       199
        
       

     

       200
       200
       +
       - The attributes used by `services.snapper.configs.<name>` have changed. Migrate from this:

     

       201
       201
       +
       

     

       202
       202
       +
         ```nix

     

       203
       203
       +
         services.snapper.configs.example = {

     

       204
       204
       +
           subvolume = "/example";

     

       205
       205
       +
           extraConfig = ''

     

       206
       206
       +
             ALLOW_USERS="alice"

     

       207
       207
       +
           '';

     

       208
       208
       +
         };

     

       209
       209
       +
         ```

     

       210
       210
       +
       

     

       211
       211
       +
         to this:

     

       212
       212
       +
       

     

       213
       213
       +
         ```nix

     

       214
       214
       +
         services.snapper.configs.example = {

     

       215
       215
       +
           SUBVOLUME = "/example";

     

       216
       216
       +
           ALLOW_USERS = [ "alice" ];

     

       217
       217
       +
         };

     

       218
       218
       +
         ```

     

       219
       219
       +
       

     

       200
       220
        
       - The [services.snapserver.openFirewall](#opt-services.snapserver.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitly set this option to `true`, or configure your firewall.

     

       201
       221
        
       

     

       202
       222
        
       - The [services.tmate-ssh-server.openFirewall](#opt-services.tmate-ssh-server.openFirewall) module option default value has been changed from `true` to `false`. You will need to explicitly set this option to `true`, or configure your firewall.

+107 -39

nixos/modules/services/misc/snapper.nix

···

       4
       4
        
       

     

       5
       5
        
       let

     

       6
       6
        
         cfg = config.services.snapper;

     

       7
       7
       +
       

     

       8
       8
       +
         mkValue = v:

     

       9
       9
       +
           if isList v then "\"${concatMapStringsSep " " (escape [ "\\" " " ]) v}\""

     

       10
       10
       +
           else if v == true then "yes"

     

       11
       11
       +
           else if v == false then "no"

     

       12
       12
       +
           else if isString v then "\"${v}\""

     

       13
       13
       +
           else builtins.toJSON v;

     

       14
       14
       +
       

     

       15
       15
       +
         mkKeyValue = k: v: "${k}=${mkValue v}";

     

       16
       16
       +
       

     

       17
       17
       +
         # "it's recommended to always specify the filesystem type"  -- man snapper-configs

     

       18
       18
       +
         defaultOf = k: if k == "FSTYPE" then null else configOptions.${k}.default or null;

     

       19
       19
       +
       

     

       20
       20
       +
         safeStr = types.strMatching "[^\n\"]*" // {

     

       21
       21
       +
           description = "string without line breaks or quotes";

     

       22
       22
       +
           descriptionClass = "conjunction";

     

       23
       23
       +
         };

     

       24
       24
       +
       

     

       25
       25
       +
         configOptions = {

     

       26
       26
       +
           SUBVOLUME = mkOption {

     

       27
       27
       +
             type = types.path;

     

       28
       28
       +
             description = lib.mdDoc ''

     

       29
       29
       +
               Path of the subvolume or mount point.

     

       30
       30
       +
               This path is a subvolume and has to contain a subvolume named

     

       31
       31
       +
               .snapshots.

     

       32
       32
       +
               See also man:snapper(8) section PERMISSIONS.

     

       33
       33
       +
             '';

     

       34
       34
       +
           };

     

       35
       35
       +
       

     

       36
       36
       +
           FSTYPE = mkOption {

     

       37
       37
       +
             type = types.enum [ "btrfs" ];

     

       38
       38
       +
             default = "btrfs";

     

       39
       39
       +
             description = lib.mdDoc ''

     

       40
       40
       +
               Filesystem type. Only btrfs is stable and tested.

     

       41
       41
       +
             '';

     

       42
       42
       +
           };

     

       43
       43
       +
       

     

       44
       44
       +
           ALLOW_GROUPS = mkOption {

     

       45
       45
       +
             type = types.listOf safeStr;

     

       46
       46
       +
             default = [];

     

       47
       47
       +
             description = lib.mdDoc ''

     

       48
       48
       +
               List of groups allowed to operate with the config.

     

       49
       49
       +
       

     

       50
       50
       +
               Also see the PERMISSIONS section in man:snapper(8).

     

       51
       51
       +
             '';

     

       52
       52
       +
           };

     

       53
       53
       +
       

     

       54
       54
       +
           ALLOW_USERS = mkOption {

     

       55
       55
       +
             type = types.listOf safeStr;

     

       56
       56
       +
             default = [];

     

       57
       57
       +
             example = [ "alice" ];

     

       58
       58
       +
             description = lib.mdDoc ''

     

       59
       59
       +
               List of users allowed to operate with the config. "root" is always

     

       60
       60
       +
               implicitly included.

     

       61
       61
       +
       

     

       62
       62
       +
               Also see the PERMISSIONS section in man:snapper(8).

     

       63
       63
       +
             '';

     

       64
       64
       +
           };

     

       65
       65
       +
       

     

       66
       66
       +
           TIMELINE_CLEANUP = mkOption {

     

       67
       67
       +
             type = types.bool;

     

       68
       68
       +
             default = false;

     

       69
       69
       +
             description = lib.mdDoc ''

     

       70
       70
       +
               Defines whether the timeline cleanup algorithm should be run for the config.

     

       71
       71
       +
             '';

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
           TIMELINE_CREATE = mkOption {

     

       75
       75
       +
             type = types.bool;

     

       76
       76
       +
             default = false;

     

       77
       77
       +
             description = lib.mdDoc ''

     

       78
       78
       +
               Defines whether hourly snapshots should be created.

     

       79
       79
       +
             '';

     

       80
       80
       +
           };

     

       81
       81
       +
         };

     

       7
       82
        
       in

     

       8
       83
        
       

     

       9
       84
        
       {

     
···

       52
       127
        
             example = literalExpression ''

     

       53
       128
        
               {

     

       54
       129
        
                 home = {

     

       55
       55
       -
                   subvolume = "/home";

     

       56
       56
       -
                   extraConfig = '''

     

       57
       57
       -
                     ALLOW_USERS="alice"

     

       58
       58
       -
                     TIMELINE_CREATE=yes

     

       59
       59
       -
                     TIMELINE_CLEANUP=yes

     

       60
       60
       -
                   ''';

     

       130
       130
       +
                   SUBVOLUME = "/home";

     

       131
       131
       +
                   ALLOW_USERS = [ "alice" ];

     

       132
       132
       +
                   TIMELINE_CREATE = true;

     

       133
       133
       +
                   TIMELINE_CLEANUP = true;

     

       61
       134
        
                 };

     

       62
       135
        
               }

     

       63
       136
        
             '';

     

       64
       137
        
       

     

       65
       138
        
             description = lib.mdDoc ''

     

       66
       66
       -
               Subvolume configuration

     

       139
       139
       +
               Subvolume configuration. Any option mentioned in man:snapper-configs(5)

     

       140
       140
       +
               is valid here, even if NixOS doesn't document it.

     

       67
       141
        
             '';

     

       68
       142
        
       

     

       69
       143
        
             type = types.attrsOf (types.submodule {

     

       70
       70
       -
               options = {

     

       71
       71
       -
                 subvolume = mkOption {

     

       72
       72
       -
                   type = types.path;

     

       73
       73
       -
                   description = lib.mdDoc ''

     

       74
       74
       -
                     Path of the subvolume or mount point.

     

       75
       75
       -
                     This path is a subvolume and has to contain a subvolume named

     

       76
       76
       -
                     .snapshots.

     

       77
       77
       -
                     See also man:snapper(8) section PERMISSIONS.

     

       78
       78
       -
                   '';

     

       79
       79
       -
                 };

     

       144
       144
       +
               freeformType = types.attrsOf (types.oneOf [ (types.listOf safeStr) types.bool safeStr types.number ]);

     

       80
       145
        
       

     

       81
       81
       -
                 fstype = mkOption {

     

       82
       82
       -
                   type = types.enum [ "btrfs" ];

     

       83
       83
       -
                   default = "btrfs";

     

       84
       84
       -
                   description = lib.mdDoc ''

     

       85
       85
       -
                     Filesystem type. Only btrfs is stable and tested.

     

       86
       86
       -
                   '';

     

       87
       87
       -
                 };

     

       88
       88
       -
       

     

       89
       89
       -
                 extraConfig = mkOption {

     

       90
       90
       -
                   type = types.lines;

     

       91
       91
       -
                   default = "";

     

       92
       92
       -
                   description = lib.mdDoc ''

     

       93
       93
       -
                     Additional configuration next to SUBVOLUME and FSTYPE.

     

       94
       94
       -
                     See man:snapper-configs(5).

     

       95
       95
       -
                   '';

     

       96
       96
       -
                 };

     

       97
       97
       -
               };

     

       146
       146
       +
               options = configOptions;

     

       98
       147
        
             });

     

       99
       148
        
           };

     

       100
       149
        
         };

     
···

       117
       166
        
       

     

       118
       167
        
             }

     

       119
       168
        
             // (mapAttrs' (name: subvolume: nameValuePair "snapper/configs/${name}" ({

     

       120
       120
       -
               text = ''

     

       121
       121
       -
                 ${subvolume.extraConfig}

     

       122
       122
       -
                 FSTYPE="${subvolume.fstype}"

     

       123
       123
       -
                 SUBVOLUME="${subvolume.subvolume}"

     

       124
       124
       -
               '';

     

       169
       169
       +
               text = lib.generators.toKeyValue { inherit mkKeyValue; } (filterAttrs (k: v: v != defaultOf k) subvolume);

     

       125
       170
        
             })) cfg.configs)

     

       126
       171
        
             // (lib.optionalAttrs (cfg.filters != null) {

     

       127
       172
        
               "snapper/filters/default.txt".text = cfg.filters;

     
···

       181
       226
        
             unitConfig.ConditionPathExists = "/etc/snapper/configs/root";

     

       182
       227
        
           };

     

       183
       228
        
       

     

       229
       229
       +
           assertions =

     

       230
       230
       +
             concatMap

     

       231
       231
       +
               (name:

     

       232
       232
       +
                 let

     

       233
       233
       +
                   sub = cfg.configs.${name};

     

       234
       234
       +
                 in

     

       235
       235
       +
                 [ { assertion = !(sub ? extraConfig);

     

       236
       236
       +
                     message = ''

     

       237
       237
       +
                       The option definition `services.snapper.configs.${name}.extraConfig' no longer has any effect; please remove it.

     

       238
       238
       +
                       The contents of this option should be migrated to attributes on `services.snapper.configs.${name}'.

     

       239
       239
       +
                     '';

     

       240
       240
       +
                   }

     

       241
       241
       +
                 ] ++

     

       242
       242
       +
                 map

     

       243
       243
       +
                   (attr: {

     

       244
       244
       +
                     assertion = !(hasAttr attr sub);

     

       245
       245
       +
                     message = ''

     

       246
       246
       +
                       The option definition `services.snapper.configs.${name}.${attr}' has been renamed to `services.snapper.configs.${name}.${toUpper attr}'.

     

       247
       247
       +
                     '';

     

       248
       248
       +
                   })

     

       249
       249
       +
                   [ "fstype" "subvolume" ]

     

       250
       250
       +
               )

     

       251
       251
       +
               (attrNames cfg.configs);

     

       184
       252
        
         });

     

       185
       253
        
       }