commit 8b598ff3d600f53983add98d556e9ab827874fb8 · pyrox.dev/nixpkgs

+12

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

···

       211
       211
        
             </listitem>

     

       212
       212
        
             <listitem>

     

       213
       213
        
               <para>

     

       214
       214
       +
                 The <literal>services.kubo.settings</literal> option is now no

     

       215
       215
       +
                 longer stateful. If you changed any of the options in

     

       216
       216
       +
                 <literal>services.kubo.settings</literal> in the past and then

     

       217
       217
       +
                 removed them from your NixOS configuration again, those

     

       218
       218
       +
                 changes are still in your Kubo configuration file but will now

     

       219
       219
       +
                 be reset to the default. If you’re unsure, you may want to

     

       220
       220
       +
                 make a backup of your configuration file (probably

     

       221
       221
       +
                 /var/lib/ipfs/config) and compare after the update.

     

       222
       222
       +
               </para>

     

       223
       223
       +
             </listitem>

     

       224
       224
       +
             <listitem>

     

       225
       225
       +
               <para>

     

       214
       226
        
                 The EC2 image module no longer fetches instance metadata in

     

       215
       227
        
                 stage-1. This results in a significantly smaller initramfs,

     

       216
       228
        
                 since network drivers no longer need to be included, and

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

···

       60
       60
        
       

     

       61
       61
        
       - `git-bug` has been updated to at least version 0.8.0, which includes backwards incompatible changes. The `git-bug-migration` package can be used to upgrade existing repositories.

     

       62
       62
        
       

     

       63
       63
       +
       - The `services.kubo.settings` option is now no longer stateful. If you changed any of the options in `services.kubo.settings` in the past and then removed them from your NixOS configuration again, those changes are still in your Kubo configuration file but will now be reset to the default. If you're unsure, you may want to make a backup of your configuration file (probably /var/lib/ipfs/config) and compare after the update.

     

       64
       64
       +
       

     

       63
       65
        
       - The EC2 image module no longer fetches instance metadata in stage-1. This results in a significantly smaller initramfs, since network drivers no longer need to be included, and faster boots, since metadata fetching can happen in parallel with startup of other services.

     

       64
       66
        
         This breaks services which rely on metadata being present by the time stage-2 is entered. Anything which reads EC2 metadata from `/etc/ec2-metadata` should now have an `after` dependency on `fetch-ec2-metadata.service`

     

       65
       67

+47 -10

nixos/modules/services/network-filesystems/kubo.nix

···

       5
       5
        
       

     

       6
       6
        
         settingsFormat = pkgs.formats.json {};

     

       7
       7
        
       

     

       8
       8
       +
         rawDefaultConfig = lib.importJSON (pkgs.runCommand "kubo-default-config" {

     

       9
       9
       +
           nativeBuildInputs = [ cfg.package ];

     

       10
       10
       +
         } ''

     

       11
       11
       +
           export IPFS_PATH="$TMPDIR"

     

       12
       12
       +
           ipfs init --empty-repo --profile=${profile}

     

       13
       13
       +
           ipfs --offline config show > "$out"

     

       14
       14
       +
         '');

     

       15
       15
       +
       

     

       16
       16
       +
         # Remove the PeerID (an attribute of "Identity") of the temporary Kubo repo.

     

       17
       17
       +
         # The "Pinning" section contains the "RemoteServices" section, which would prevent

     

       18
       18
       +
         # the daemon from starting as that setting can't be changed via ipfs config replace.

     

       19
       19
       +
         defaultConfig = builtins.removeAttrs rawDefaultConfig [ "Identity" "Pinning" ];

     

       20
       20
       +
       

     

       21
       21
       +
         customizedConfig = lib.recursiveUpdate defaultConfig cfg.settings;

     

       22
       22
       +
       

     

       23
       23
       +
         configFile = settingsFormat.generate "kubo-config.json" customizedConfig;

     

       24
       24
       +
       

     

       8
       25
        
         kuboFlags = utils.escapeSystemdExecArgs (

     

       9
       26
        
           optional cfg.autoMount "--mount" ++

     

       10
       27
        
           optional cfg.enableGC "--enable-gc" ++

     
···

       161
       178
        
                 };

     

       162
       179
        
               };

     

       163
       180
        
               description = lib.mdDoc ''

     

       164
       164
       -
                 Attrset of daemon configuration to set using {command}`ipfs config`, every time the daemon starts.

     

       181
       181
       +
                 Attrset of daemon configuration.

     

       165
       182
        
                 See [https://github.com/ipfs/kubo/blob/master/docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md) for reference.

     

       166
       166
       -
                 Keep in mind that this configuration is stateful; i.e., unsetting anything in here does not reset the value to the default!

     

       183
       183
       +
                 You can't set `Identity` or `Pinning`.

     

       167
       184
        
               '';

     

       168
       185
        
               default = { };

     

       169
       186
        
               example = {

     
···

       211
       228
        
         ###### implementation

     

       212
       229
        
       

     

       213
       230
        
         config = mkIf cfg.enable {

     

       231
       231
       +
           assertions = [

     

       232
       232
       +
             {

     

       233
       233
       +
               assertion = !builtins.hasAttr "Identity" cfg.settings;

     

       234
       234
       +
               message = ''

     

       235
       235
       +
                 You can't set services.kubo.settings.Identity because the ``config replace`` subcommand used at startup does not support modifying any of the Identity settings.

     

       236
       236
       +
               '';

     

       237
       237
       +
             }

     

       238
       238
       +
             {

     

       239
       239
       +
               assertion = !((builtins.hasAttr "Pinning" cfg.settings) && (builtins.hasAttr "RemoteServices" cfg.settings.Pinning));

     

       240
       240
       +
               message = ''

     

       241
       241
       +
                 You can't set services.kubo.settings.Pinning.RemoteServices because the ``config replace`` subcommand used at startup does not work with it.

     

       242
       242
       +
               '';

     

       243
       243
       +
             }

     

       244
       244
       +
           ];

     

       245
       245
       +
       

     

       214
       246
        
           environment.systemPackages = [ cfg.package ];

     

       215
       247
        
           environment.variables.IPFS_PATH = cfg.dataDir;

     

       216
       248
        
       

     
···

       262
       294
        
       

     

       263
       295
        
             preStart = ''

     

       264
       296
        
               if [[ ! -f "$IPFS_PATH/config" ]]; then

     

       265
       265
       -
                 ipfs init ${optionalString cfg.emptyRepo "-e"} --profile=${profile}

     

       297
       297
       +
                 ipfs init ${optionalString cfg.emptyRepo "-e"}

     

       266
       298
        
               else

     

       267
       299
        
                 # After an unclean shutdown this file may exist which will cause the config command to attempt to talk to the daemon. This will hang forever if systemd is holding our sockets open.

     

       268
       300
        
                 rm -vf "$IPFS_PATH/api"

     

       269
       301
        
             '' + optionalString cfg.autoMigrate ''

     

       270
       302
        
               ${pkgs.kubo-migrator}/bin/fs-repo-migrations -to '${cfg.package.repoVersion}' -y

     

       271
       303
        
             '' + ''

     

       272
       272
       -
                 ipfs --offline config profile apply ${profile} >/dev/null

     

       273
       304
        
               fi

     

       274
       274
       -
             '' + ''

     

       275
       275
       -
               ipfs --offline config show \

     

       276
       276
       -
                 | ${pkgs.jq}/bin/jq '. * $settings' --argjson settings ${

     

       277
       277
       -
                     escapeShellArg (builtins.toJSON cfg.settings)

     

       278
       278
       -
                   } \

     

       279
       279
       -
                 | ipfs --offline config replace -

     

       305
       305
       +
               ipfs --offline config show |

     

       306
       306
       +
                 ${pkgs.jq}/bin/jq -s '.[0].Pinning as $Pinning | .[0].Identity as $Identity | .[1] + {$Identity,$Pinning}' - '${configFile}' |

     

       307
       307
       +
       

     

       308
       308
       +
                 # This command automatically injects the private key and other secrets from

     

       309
       309
       +
                 # the old config file back into the new config file.

     

       310
       310
       +
                 # Unfortunately, it doesn't keep the original `Identity.PeerID`,

     

       311
       311
       +
                 # so we need `ipfs config show` and jq above.

     

       312
       312
       +
                 # See https://github.com/ipfs/kubo/issues/8993 for progress on fixing this problem.

     

       313
       313
       +
                 # Kubo also wants a specific version of the original "Pinning.RemoteServices"

     

       314
       314
       +
                 # section (redacted by `ipfs config show`), such that that section doesn't

     

       315
       315
       +
                 # change when the changes are applied. Whyyyyyy.....

     

       316
       316
       +
                 ipfs --offline config replace -

     

       280
       317
        
             '';

     

       281
       318
        
             serviceConfig = {

     

       282
       319
        
               ExecStart = [ "" "${cfg.package}/bin/ipfs daemon ${kuboFlags}" ];