commit 8b4ce06e63eb6e52a2fcfd655db46226dc364c0e · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       547
       547
        
         ./services/network-filesystems/nfsd.nix

     

       548
       548
        
         ./services/network-filesystems/openafs/client.nix

     

       549
       549
        
         ./services/network-filesystems/openafs/server.nix

     

       550
       550
       +
         ./services/network-filesystems/orangefs/server.nix

     

       551
       551
       +
         ./services/network-filesystems/orangefs/client.nix

     

       550
       552
        
         ./services/network-filesystems/rsyncd.nix

     

       551
       553
        
         ./services/network-filesystems/samba.nix

     

       552
       554
        
         ./services/network-filesystems/tahoe.nix

+97

nixos/modules/services/network-filesystems/orangefs/client.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.orangefs.client;

     

       7
       7
       +
       

     

       8
       8
       +
       in {

     

       9
       9
       +
         ###### interface

     

       10
       10
       +
       

     

       11
       11
       +
         options = {

     

       12
       12
       +
           services.orangefs.client = {

     

       13
       13
       +
             enable = mkEnableOption "OrangeFS client daemon";

     

       14
       14
       +
       

     

       15
       15
       +
             extraOptions = mkOption {

     

       16
       16
       +
               type = with types; listOf str;

     

       17
       17
       +
               default = [];

     

       18
       18
       +
               description = "Extra command line options for pvfs2-client.";

     

       19
       19
       +
             };

     

       20
       20
       +
       

     

       21
       21
       +
             fileSystems = mkOption {

     

       22
       22
       +
               description = ''

     

       23
       23
       +
                 The orangefs file systems to be mounted.

     

       24
       24
       +
                 This option is prefered over using <option>fileSystems</option> directly since

     

       25
       25
       +
                 the pvfs client service needs to be running for it to be mounted.

     

       26
       26
       +
               '';

     

       27
       27
       +
       

     

       28
       28
       +
               example = [{

     

       29
       29
       +
                 mountPoint = "/orangefs";

     

       30
       30
       +
                 target = "tcp://server:3334/orangefs";

     

       31
       31
       +
               }];

     

       32
       32
       +
       

     

       33
       33
       +
               type = with types; listOf (submodule ({ ... } : {

     

       34
       34
       +
                 options = {

     

       35
       35
       +
       

     

       36
       36
       +
                   mountPoint = mkOption {

     

       37
       37
       +
                     type = types.str;

     

       38
       38
       +
                     default = "/orangefs";

     

       39
       39
       +
                     description = "Mount point.";

     

       40
       40
       +
                   };

     

       41
       41
       +
       

     

       42
       42
       +
                   options = mkOption {

     

       43
       43
       +
                     type = with types; listOf str;

     

       44
       44
       +
                     default = [];

     

       45
       45
       +
                     description = "Mount options";

     

       46
       46
       +
                   };

     

       47
       47
       +
       

     

       48
       48
       +
                   target = mkOption {

     

       49
       49
       +
                     type = types.str;

     

       50
       50
       +
                     default = null;

     

       51
       51
       +
                     example = "tcp://server:3334/orangefs";

     

       52
       52
       +
                     description = "Target URL";

     

       53
       53
       +
                   };

     

       54
       54
       +
                 };

     

       55
       55
       +
               }));

     

       56
       56
       +
             };

     

       57
       57
       +
           };

     

       58
       58
       +
         };

     

       59
       59
       +
       

     

       60
       60
       +
       

     

       61
       61
       +
         ###### implementation

     

       62
       62
       +
       

     

       63
       63
       +
         config = mkIf cfg.enable {

     

       64
       64
       +
           environment.systemPackages = [ pkgs.orangefs ];

     

       65
       65
       +
       

     

       66
       66
       +
           boot.supportedFilesystems = [ "pvfs2" ];

     

       67
       67
       +
           boot.kernelModules = [ "orangefs" ];

     

       68
       68
       +
       

     

       69
       69
       +
           systemd.services.orangefs-client = {

     

       70
       70
       +
             requires = [ "network-online.target" ];

     

       71
       71
       +
             after = [ "network-online.target" ];

     

       72
       72
       +
       

     

       73
       73
       +
             serviceConfig = {

     

       74
       74
       +
               Type = "simple";

     

       75
       75
       +
       

     

       76
       76
       +
                ExecStart = ''

     

       77
       77
       +
                  ${pkgs.orangefs}/bin/pvfs2-client-core \

     

       78
       78
       +
                     --logtype=syslog ${concatStringsSep " " cfg.extraOptions}

     

       79
       79
       +
               '';

     

       80
       80
       +
       

     

       81
       81
       +
               TimeoutStopSec = "120";

     

       82
       82
       +
             };

     

       83
       83
       +
           };

     

       84
       84
       +
       

     

       85
       85
       +
           systemd.mounts = map (fs: {

     

       86
       86
       +
             requires = [ "orangefs-client.service" ];

     

       87
       87
       +
             after = [ "orangefs-client.service" ];

     

       88
       88
       +
             bindsTo = [ "orangefs-client.service" ];

     

       89
       89
       +
             wantedBy = [ "remote-fs.target" ];

     

       90
       90
       +
             type = "pvfs2";

     

       91
       91
       +
             options = concatStringsSep "," fs.options;

     

       92
       92
       +
             what = fs.target;

     

       93
       93
       +
             where = fs.mountPoint;

     

       94
       94
       +
           }) cfg.fileSystems;

     

       95
       95
       +
         };

     

       96
       96
       +
       }

     

       97
       97
       +

+225

nixos/modules/services/network-filesystems/orangefs/server.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.orangefs.server;

     

       7
       7
       +
       

     

       8
       8
       +
         aliases = mapAttrsToList (alias: url: alias) cfg.servers;

     

       9
       9
       +
       

     

       10
       10
       +
         # Maximum handle number is 2^63

     

       11
       11
       +
         maxHandle = 9223372036854775806;

     

       12
       12
       +
       

     

       13
       13
       +
         # One range of handles for each meta/data instance

     

       14
       14
       +
         handleStep = maxHandle / (length aliases) / 2;

     

       15
       15
       +
       

     

       16
       16
       +
         fileSystems = mapAttrsToList (name: fs: ''

     

       17
       17
       +
           <FileSystem>

     

       18
       18
       +
             Name ${name}

     

       19
       19
       +
             ID ${toString fs.id}

     

       20
       20
       +
             RootHandle ${toString fs.rootHandle}

     

       21
       21
       +
       

     

       22
       22
       +
             ${fs.extraConfig}

     

       23
       23
       +
       

     

       24
       24
       +
             <MetaHandleRanges>

     

       25
       25
       +
             ${concatStringsSep "\n" (

     

       26
       26
       +
                 imap0 (i: alias:

     

       27
       27
       +
                   let

     

       28
       28
       +
                     begin = i * handleStep + 3;

     

       29
       29
       +
                     end = begin + handleStep - 1;

     

       30
       30
       +
                   in "Range ${alias} ${toString begin}-${toString end}") aliases

     

       31
       31
       +
              )}

     

       32
       32
       +
             </MetaHandleRanges>

     

       33
       33
       +
       

     

       34
       34
       +
             <DataHandleRanges>

     

       35
       35
       +
             ${concatStringsSep "\n" (

     

       36
       36
       +
                 imap0 (i: alias:

     

       37
       37
       +
                   let

     

       38
       38
       +
                     begin = i * handleStep + 3 + (length aliases) * handleStep;

     

       39
       39
       +
                     end = begin + handleStep - 1;

     

       40
       40
       +
                   in "Range ${alias} ${toString begin}-${toString end}") aliases

     

       41
       41
       +
              )}

     

       42
       42
       +
             </DataHandleRanges>

     

       43
       43
       +
       

     

       44
       44
       +
             <StorageHints>

     

       45
       45
       +
             TroveSyncMeta ${if fs.troveSyncMeta then "yes" else "no"}

     

       46
       46
       +
             TroveSyncData ${if fs.troveSyncData then "yes" else "no"}

     

       47
       47
       +
             ${fs.extraStorageHints}

     

       48
       48
       +
             </StorageHints>

     

       49
       49
       +
       

     

       50
       50
       +
           </FileSystem>

     

       51
       51
       +
         '') cfg.fileSystems;

     

       52
       52
       +
       

     

       53
       53
       +
         configFile = ''

     

       54
       54
       +
           <Defaults>

     

       55
       55
       +
           LogType ${cfg.logType}

     

       56
       56
       +
           DataStorageSpace ${cfg.dataStorageSpace}

     

       57
       57
       +
           MetaDataStorageSpace ${cfg.metadataStorageSpace}

     

       58
       58
       +
       

     

       59
       59
       +
           BMIModules ${concatStringsSep "," cfg.BMIModules}

     

       60
       60
       +
           ${cfg.extraDefaults}

     

       61
       61
       +
           </Defaults>

     

       62
       62
       +
       

     

       63
       63
       +
           ${cfg.extraConfig}

     

       64
       64
       +
       

     

       65
       65
       +
           <Aliases>

     

       66
       66
       +
           ${concatStringsSep "\n" (mapAttrsToList (alias: url: "Alias ${alias} ${url}") cfg.servers)}

     

       67
       67
       +
           </Aliases>

     

       68
       68
       +
       

     

       69
       69
       +
           ${concatStringsSep "\n" fileSystems}

     

       70
       70
       +
         '';

     

       71
       71
       +
       

     

       72
       72
       +
       in {

     

       73
       73
       +
         ###### interface

     

       74
       74
       +
       

     

       75
       75
       +
         options = {

     

       76
       76
       +
           services.orangefs.server = {

     

       77
       77
       +
             enable = mkEnableOption "OrangeFS server";

     

       78
       78
       +
       

     

       79
       79
       +
             logType = mkOption {

     

       80
       80
       +
               type = with types; enum [ "file" "syslog" ];

     

       81
       81
       +
               default = "syslog";

     

       82
       82
       +
               description = "Destination for log messages.";

     

       83
       83
       +
             };

     

       84
       84
       +
       

     

       85
       85
       +
             dataStorageSpace = mkOption {

     

       86
       86
       +
               type = types.str;

     

       87
       87
       +
               default = null;

     

       88
       88
       +
               example = "/data/storage";

     

       89
       89
       +
               description = "Directory for data storage.";

     

       90
       90
       +
             };

     

       91
       91
       +
       

     

       92
       92
       +
             metadataStorageSpace = mkOption {

     

       93
       93
       +
               type = types.str;

     

       94
       94
       +
               default = null;

     

       95
       95
       +
               example = "/data/meta";

     

       96
       96
       +
               description = "Directory for meta data storage.";

     

       97
       97
       +
             };

     

       98
       98
       +
       

     

       99
       99
       +
             BMIModules = mkOption {

     

       100
       100
       +
               type = with types; listOf str;

     

       101
       101
       +
               default = [ "bmi_tcp" ];

     

       102
       102
       +
               example = [ "bmi_tcp" "bmi_ib"];

     

       103
       103
       +
               description = "List of BMI modules to load.";

     

       104
       104
       +
             };

     

       105
       105
       +
       

     

       106
       106
       +
             extraDefaults = mkOption {

     

       107
       107
       +
               type = types.lines;

     

       108
       108
       +
               default = "";

     

       109
       109
       +
               description = "Extra config for <literal>&lt;Defaults&gt;</literal> section.";

     

       110
       110
       +
             };

     

       111
       111
       +
       

     

       112
       112
       +
             extraConfig = mkOption {

     

       113
       113
       +
               type = types.lines;

     

       114
       114
       +
               default = "";

     

       115
       115
       +
               description = "Extra config for the global section.";

     

       116
       116
       +
             };

     

       117
       117
       +
       

     

       118
       118
       +
             servers = mkOption {

     

       119
       119
       +
               type = with types; attrsOf types.str;

     

       120
       120
       +
               default = {};

     

       121
       121
       +
               example = ''

     

       122
       122
       +
                 {

     

       123
       123
       +
                   node1="tcp://node1:3334";

     

       124
       124
       +
                   node2="tcp://node2:3334";

     

       125
       125
       +
                 }

     

       126
       126
       +
               '';

     

       127
       127
       +
               description = "URLs for storage server including port. The attribute names define the server alias.";

     

       128
       128
       +
             };

     

       129
       129
       +
       

     

       130
       130
       +
             fileSystems = mkOption {

     

       131
       131
       +
               description = ''

     

       132
       132
       +
                 These options will create the <literal>&lt;FileSystem&gt;</literal> sections of config file.

     

       133
       133
       +
               '';

     

       134
       134
       +
               default = { orangefs = {}; };

     

       135
       135
       +
               defaultText = literalExample "{ orangefs = {}; }";

     

       136
       136
       +
               example = literalExample ''

     

       137
       137
       +
                 {

     

       138
       138
       +
                   fs1 = {

     

       139
       139
       +
                     id = 101;

     

       140
       140
       +
                   };

     

       141
       141
       +
       

     

       142
       142
       +
                   fs2 = {

     

       143
       143
       +
                     id = 102;

     

       144
       144
       +
                   };

     

       145
       145
       +
                 }

     

       146
       146
       +
               '';

     

       147
       147
       +
               type = with types; attrsOf (submodule ({ ... } : {

     

       148
       148
       +
                 options = {

     

       149
       149
       +
                   id = mkOption {

     

       150
       150
       +
                     type = types.int;

     

       151
       151
       +
                     default = 1;

     

       152
       152
       +
                     description = "File system ID (must be unique within configuration).";

     

       153
       153
       +
                   };

     

       154
       154
       +
       

     

       155
       155
       +
                   rootHandle = mkOption {

     

       156
       156
       +
                     type = types.int;

     

       157
       157
       +
                     default = 3;

     

       158
       158
       +
                     description = "File system root ID.";

     

       159
       159
       +
                   };

     

       160
       160
       +
       

     

       161
       161
       +
                   extraConfig = mkOption {

     

       162
       162
       +
                     type = types.lines;

     

       163
       163
       +
                     default = "";

     

       164
       164
       +
                     description = "Extra config for <literal>&lt;FileSystem&gt;</literal> section.";

     

       165
       165
       +
                   };

     

       166
       166
       +
       

     

       167
       167
       +
                   troveSyncMeta = mkOption {

     

       168
       168
       +
                     type = types.bool;

     

       169
       169
       +
                     default = true;

     

       170
       170
       +
                     description = "Sync meta data.";

     

       171
       171
       +
                   };

     

       172
       172
       +
       

     

       173
       173
       +
                   troveSyncData = mkOption {

     

       174
       174
       +
                     type = types.bool;

     

       175
       175
       +
                     default = false;

     

       176
       176
       +
                     description = "Sync data.";

     

       177
       177
       +
                   };

     

       178
       178
       +
       

     

       179
       179
       +
                   extraStorageHints = mkOption {

     

       180
       180
       +
                     type = types.lines;

     

       181
       181
       +
                     default = "";

     

       182
       182
       +
                     description = "Extra config for <literal>&lt;StorageHints&gt;</literal> section.";

     

       183
       183
       +
                   };

     

       184
       184
       +
                 };

     

       185
       185
       +
               }));

     

       186
       186
       +
             };

     

       187
       187
       +
           };

     

       188
       188
       +
         };

     

       189
       189
       +
       

     

       190
       190
       +
         ###### implementation

     

       191
       191
       +
       

     

       192
       192
       +
         config = mkIf cfg.enable {

     

       193
       193
       +
           environment.systemPackages = [ pkgs.orangefs ];

     

       194
       194
       +
       

     

       195
       195
       +
           # orangefs daemon will run as user

     

       196
       196
       +
           users.users.orangefs.isSystemUser = true;

     

       197
       197
       +
           users.groups.orangefs = {};

     

       198
       198
       +
       

     

       199
       199
       +
           # To format the file system the config file is needed.

     

       200
       200
       +
           environment.etc."orangefs/server.conf" = {

     

       201
       201
       +
             text = configFile;

     

       202
       202
       +
             user = "orangefs";

     

       203
       203
       +
             group = "orangefs";

     

       204
       204
       +
           };

     

       205
       205
       +
       

     

       206
       206
       +
           systemd.services.orangefs-server = {

     

       207
       207
       +
             wantedBy = [ "multi-user.target" ];

     

       208
       208
       +
             requires = [ "network-online.target" ];

     

       209
       209
       +
             after = [ "network-online.target" ];

     

       210
       210
       +
       

     

       211
       211
       +
             serviceConfig = {

     

       212
       212
       +
               # Run as "simple" in forground mode.

     

       213
       213
       +
               # This is more reliable

     

       214
       214
       +
               ExecStart = ''

     

       215
       215
       +
                 ${pkgs.orangefs}/bin/pvfs2-server -d \

     

       216
       216
       +
                   /etc/orangefs/server.conf

     

       217
       217
       +
               '';

     

       218
       218
       +
               TimeoutStopSec = "120";

     

       219
       219
       +
               User = "orangefs";

     

       220
       220
       +
               Group = "orangefs";

     

       221
       221
       +
             };

     

       222
       222
       +
           };

     

       223
       223
       +
         };

     

       224
       224
       +
       

     

       225
       225
       +
       }