commit ef12e14cb706c780ed55b177576588c4a757fd81 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       1361
       1361
        
         ./services/scheduling/atd.nix

     

       1362
       1362
        
         ./services/scheduling/cron.nix

     

       1363
       1363
        
         ./services/scheduling/fcron.nix

     

       1364
       1364
       +
         ./services/scheduling/prefect.nix

     

       1364
       1365
        
         ./services/scheduling/scx.nix

     

       1365
       1366
        
         ./services/search/elasticsearch-curator.nix

     

       1366
       1367
        
         ./services/search/elasticsearch.nix

+232

nixos/modules/services/scheduling/prefect.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.services.prefect;

     

       10
       10
       +
         inherit (lib.types)

     

       11
       11
       +
           bool

     

       12
       12
       +
           str

     

       13
       13
       +
           enum

     

       14
       14
       +
           path

     

       15
       15
       +
           attrsOf

     

       16
       16
       +
           nullOr

     

       17
       17
       +
           submodule

     

       18
       18
       +
           port

     

       19
       19
       +
           ;

     

       20
       20
       +
       

     

       21
       21
       +
       in

     

       22
       22
       +
       {

     

       23
       23
       +
         options.services.prefect = {

     

       24
       24
       +
           enable = lib.mkOption {

     

       25
       25
       +
             type = bool;

     

       26
       26
       +
             default = false;

     

       27
       27
       +
             description = "enable prefect server and worker services";

     

       28
       28
       +
           };

     

       29
       29
       +
       

     

       30
       30
       +
           package = lib.mkPackageOption pkgs "prefect" { };

     

       31
       31
       +
       

     

       32
       32
       +
           host = lib.mkOption {

     

       33
       33
       +
             type = str;

     

       34
       34
       +
             default = "127.0.0.1";

     

       35
       35
       +
             example = "0.0.0.0";

     

       36
       36
       +
             description = "Prefect server host";

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
           port = lib.mkOption {

     

       40
       40
       +
             type = port;

     

       41
       41
       +
             default = 4200;

     

       42
       42
       +
             description = "Prefect server port";

     

       43
       43
       +
           };

     

       44
       44
       +
       

     

       45
       45
       +
           dataDir = lib.mkOption {

     

       46
       46
       +
             type = path;

     

       47
       47
       +
             default = "/var/lib/prefect-server";

     

       48
       48
       +
             description = ''

     

       49
       49
       +
               Specify the directory for Prefect.

     

       50
       50
       +
             '';

     

       51
       51
       +
           };

     

       52
       52
       +
       

     

       53
       53
       +
           database = lib.mkOption {

     

       54
       54
       +
             type = enum [

     

       55
       55
       +
               "sqlite"

     

       56
       56
       +
               "postgres"

     

       57
       57
       +
             ];

     

       58
       58
       +
             default = "sqlite";

     

       59
       59
       +
             description = "which database to use for prefect server: sqlite or postgres";

     

       60
       60
       +
           };

     

       61
       61
       +
       

     

       62
       62
       +
           databaseHost = lib.mkOption {

     

       63
       63
       +
             type = str;

     

       64
       64
       +
             default = "localhost";

     

       65
       65
       +
             description = "database host for postgres only";

     

       66
       66
       +
           };

     

       67
       67
       +
       

     

       68
       68
       +
           databasePort = lib.mkOption {

     

       69
       69
       +
             type = str;

     

       70
       70
       +
             default = "5432";

     

       71
       71
       +
             description = "database port for postgres only";

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
           databaseName = lib.mkOption {

     

       75
       75
       +
             type = str;

     

       76
       76
       +
             default = "prefect";

     

       77
       77
       +
             description = "database name for postgres only";

     

       78
       78
       +
           };

     

       79
       79
       +
       

     

       80
       80
       +
           databaseUser = lib.mkOption {

     

       81
       81
       +
             type = str;

     

       82
       82
       +
             default = "postgres";

     

       83
       83
       +
             description = "database user for postgres only";

     

       84
       84
       +
           };

     

       85
       85
       +
       

     

       86
       86
       +
           databasePasswordFile = lib.mkOption {

     

       87
       87
       +
             type = nullOr str;

     

       88
       88
       +
             default = null;

     

       89
       89
       +
             description = ''

     

       90
       90
       +
               path to a file containing e.g.:

     

       91
       91
       +
                 DBPASSWORD=supersecret

     

       92
       92
       +
       

     

       93
       93
       +
               stored outside the nix store, read by systemd as EnvironmentFile.

     

       94
       94
       +
             '';

     

       95
       95
       +
           };

     

       96
       96
       +
       

     

       97
       97
       +
           # now define workerPools as an attribute set of submodules,

     

       98
       98
       +
           # each key is the pool name, and the submodule has an installPolicy

     

       99
       99
       +
           workerPools = lib.mkOption {

     

       100
       100
       +
             type = attrsOf (submodule {

     

       101
       101
       +
               options = {

     

       102
       102
       +
                 installPolicy = lib.mkOption {

     

       103
       103
       +
                   type = enum [

     

       104
       104
       +
                     "always"

     

       105
       105
       +
                     "if-not-present"

     

       106
       106
       +
                     "never"

     

       107
       107
       +
                     "prompt"

     

       108
       108
       +
                   ];

     

       109
       109
       +
                   default = "always";

     

       110
       110
       +
                   description = "install policy for the worker (always, if-not-present, never, prompt)";

     

       111
       111
       +
                 };

     

       112
       112
       +
               };

     

       113
       113
       +
             });

     

       114
       114
       +
             default = { };

     

       115
       115
       +
             description = ''

     

       116
       116
       +
               define a set of worker pools with submodule config. example:

     

       117
       117
       +
               workerPools.my-pool = {

     

       118
       118
       +
                 installPolicy = "never";

     

       119
       119
       +
               };

     

       120
       120
       +
             '';

     

       121
       121
       +
           };

     

       122
       122
       +
       

     

       123
       123
       +
           baseUrl = lib.mkOption {

     

       124
       124
       +
             type = nullOr str;

     

       125
       125
       +
             default = null;

     

       126
       126
       +
             description = "external url when served by a reverse proxy, e.g. https://example.com/prefect";

     

       127
       127
       +
           };

     

       128
       128
       +
         };

     

       129
       129
       +
       

     

       130
       130
       +
         config = lib.mkIf cfg.enable {

     

       131
       131
       +
           # define systemd.services as the server plus any worker definitions

     

       132
       132
       +
           systemd.services =

     

       133
       133
       +
             {

     

       134
       134
       +
               "prefect-server" = {

     

       135
       135
       +
                 description = "prefect server";

     

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

     

       137
       137
       +
                 after = [ "network.target" ];

     

       138
       138
       +
       

     

       139
       139
       +
                 serviceConfig = {

     

       140
       140
       +
                   DynamicUser = true;

     

       141
       141
       +
                   StateDirectory = "prefect-server";

     

       142
       142
       +
                   # TODO all my efforts to setup the database url

     

       143
       143
       +
                   # have failed with some unable to open file

     

       144
       144
       +
                   Environment = [

     

       145
       145
       +
                     "PREFECT_HOME=%S/prefect-server"

     

       146
       146
       +
                     "PREFECT_UI_STATIC_DIRECTORY=%S/prefect-server"

     

       147
       147
       +
                     "PREFECT_SERVER_ANALYTICS_ENABLED=off"

     

       148
       148
       +
                     "PREFECT_UI_API_URL=${cfg.baseUrl}/api"

     

       149
       149
       +
                     "PREFECT_UI_URL=${cfg.baseUrl}"

     

       150
       150
       +
                   ];

     

       151
       151
       +
                   EnvironmentFile =

     

       152
       152
       +
                     if cfg.database == "postgres" && cfg.databasePasswordFile != null then

     

       153
       153
       +
                       [ cfg.databasePasswordFile ]

     

       154
       154
       +
                     else

     

       155
       155
       +
                       [ ];

     

       156
       156
       +
       

     

       157
       157
       +
                   # ReadWritePaths = [ cfg.dataDir ];

     

       158
       158
       +
                   ProtectSystem = "strict";

     

       159
       159
       +
                   ProtectHome = true;

     

       160
       160
       +
                   PrivateTmp = true;

     

       161
       161
       +
                   NoNewPrivileges = true;

     

       162
       162
       +
                   MemoryDenyWriteExecute = true;

     

       163
       163
       +
                   LockPersonality = true;

     

       164
       164
       +
                   CapabilityBoundingSet = [ ];

     

       165
       165
       +
                   AmbientCapabilities = [ ];

     

       166
       166
       +
                   RestrictSUIDSGID = true;

     

       167
       167
       +
                   RestrictAddressFamilies = [

     

       168
       168
       +
                     "AF_INET"

     

       169
       169
       +
                     "AF_INET6"

     

       170
       170
       +
                     "AF_UNIX"

     

       171
       171
       +
                   ];

     

       172
       172
       +
                   ProtectKernelTunables = true;

     

       173
       173
       +
                   ProtectKernelModules = true;

     

       174
       174
       +
                   ProtectKernelLogs = true;

     

       175
       175
       +
                   ProtectControlGroups = true;

     

       176
       176
       +
                   MemoryAccounting = true;

     

       177
       177
       +
                   CPUAccounting = true;

     

       178
       178
       +
       

     

       179
       179
       +
                   ExecStart = "${pkgs.prefect}/bin/prefect server start --host ${cfg.host} --port ${toString cfg.port}";

     

       180
       180
       +
                   Restart = "always";

     

       181
       181
       +
                   WorkingDirectory = cfg.dataDir;

     

       182
       182
       +
                 };

     

       183
       183
       +
               };

     

       184
       184
       +
             }

     

       185
       185
       +
             // lib.concatMapAttrs (poolName: poolCfg: {

     

       186
       186
       +
               # return a partial attr set with one key: "prefect-worker-..."

     

       187
       187
       +
               "prefect-worker-${poolName}" = {

     

       188
       188
       +
                 description = "prefect worker for pool '${poolName}'";

     

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

     

       190
       190
       +
                 after = [ "network.target" ];

     

       191
       191
       +
       

     

       192
       192
       +
                 environment.systemPackages = cfg.package;

     

       193
       193
       +
       

     

       194
       194
       +
                 serviceConfig = {

     

       195
       195
       +
                   DynamicUser = true;

     

       196
       196
       +
                   StateDirectory = "prefect-worker-${poolName}";

     

       197
       197
       +
                   Environment = [

     

       198
       198
       +
                     "PREFECT_HOME=%S/prefect-worker-${poolName}"

     

       199
       199
       +
                     "PREFECT_API_URL=${cfg.baseUrl}/api"

     

       200
       200
       +
                   ];

     

       201
       201
       +
                   ProtectSystem = "strict";

     

       202
       202
       +
                   ProtectHome = true;

     

       203
       203
       +
                   PrivateTmp = true;

     

       204
       204
       +
                   NoNewPrivileges = true;

     

       205
       205
       +
                   MemoryDenyWriteExecute = true;

     

       206
       206
       +
                   LockPersonality = true;

     

       207
       207
       +
                   CapabilityBoundingSet = [ ];

     

       208
       208
       +
                   AmbientCapabilities = [ ];

     

       209
       209
       +
                   RestrictSUIDSGID = true;

     

       210
       210
       +
                   RestrictAddressFamilies = [

     

       211
       211
       +
                     "AF_INET"

     

       212
       212
       +
                     "AF_INET6"

     

       213
       213
       +
                     "AF_UNIX"

     

       214
       214
       +
                   ];

     

       215
       215
       +
                   ProtectKernelTunables = true;

     

       216
       216
       +
                   ProtectKernelModules = true;

     

       217
       217
       +
                   ProtectKernelLogs = true;

     

       218
       218
       +
                   ProtectControlGroups = true;

     

       219
       219
       +
                   MemoryAccounting = true;

     

       220
       220
       +
                   CPUAccounting = true;

     

       221
       221
       +
                   ExecStart = ''

     

       222
       222
       +
                     ${pkgs.prefect}/bin/prefect worker start \

     

       223
       223
       +
                       --pool ${poolName} \

     

       224
       224
       +
                       --type process \

     

       225
       225
       +
                       --install-policy ${poolCfg.installPolicy}

     

       226
       226
       +
                   '';

     

       227
       227
       +
                   Restart = "always";

     

       228
       228
       +
                 };

     

       229
       229
       +
               };

     

       230
       230
       +
             }) cfg.workerPools;

     

       231
       231
       +
         };

     

       232
       232
       +
       }

nixos/tests/all-tests.nix

···

       950
       950
        
         pppd = handleTest ./pppd.nix {};

     

       951
       951
        
         predictable-interface-names = handleTest ./predictable-interface-names.nix {};

     

       952
       952
        
         pretalx = runTest ./web-apps/pretalx.nix;

     

       953
       953
       +
         prefect = runTest ./prefect.nix;

     

       953
       954
        
         pretix = runTest ./web-apps/pretix.nix;

     

       954
       955
        
         printing-socket = handleTest ./printing.nix { socket = true; listenTcp = true; };

     

       955
       956
        
         printing-service = handleTest ./printing.nix { socket = false; listenTcp = true; };

+27

nixos/tests/prefect.nix

···

       1
       1
       +
       { lib, ... }:

     

       2
       2
       +
       let

     

       3
       3
       +
         mainPort = "4200";

     

       4
       4
       +
       in

     

       5
       5
       +
       {

     

       6
       6
       +
         name = "prefect";

     

       7
       7
       +
       

     

       8
       8
       +
         nodes = {

     

       9
       9
       +
           machine =

     

       10
       10
       +
             { ... }:

     

       11
       11
       +
             {

     

       12
       12
       +
               services.prefect = {

     

       13
       13
       +
                 enable = true;

     

       14
       14
       +
               };

     

       15
       15
       +
             };

     

       16
       16
       +
         };

     

       17
       17
       +
       

     

       18
       18
       +
         testScript = ''

     

       19
       19
       +
           machine.start()

     

       20
       20
       +
           machine.wait_for_unit("prefect-server.service")

     

       21
       21
       +
           machine.wait_for_open_port("${mainPort}")

     

       22
       22
       +
         '';

     

       23
       23
       +
       

     

       24
       24
       +
         meta = with lib.maintainers; {

     

       25
       25
       +
           maintainers = [ happysalada ];

     

       26
       26
       +
         };

     

       27
       27
       +
       }

pkgs/by-name/pr/prefect/package.nix

···

       2
       2
        
         lib,

     

       3
       3
        
         python3Packages,

     

       4
       4
        
         fetchPypi,

     

       5
       5
       +
         nixosTests,

     

       5
       6
        
       }:

     

       6
       7
        
       

     

       7
       8
        
       python3Packages.buildPythonApplication rec {

     
···

       156
       157
        
           "--prefix PYTHONPATH : ${python3Packages.makePythonPath dependencies}"

     

       157
       158
        
           "--prefix PYTHONPATH : $out/${python3Packages.python.sitePackages}"

     

       158
       159
        
         ];

     

       160
       160
       +
       

     

       161
       161
       +
         passthru.tests = {

     

       162
       162
       +
           inherit (nixosTests) prefect;

     

       163
       163
       +
         };

     

       159
       164
        
       

     

       160
       165
        
         # Tests are not included in the pypi source

     

       161
       166
        
         doCheck = false;