···

       
25
       
 
       
    escapeShellArg

     

       
26
       
 
       
    concatMapStringsSep

     

       
27
       
 
       
    sourceFilesBySuffices

     

       
0
       
 
       

     

       
28
       
 
       
    ;

     

       
29
       
 
       


     

       
30
       
 
       
  common = import ./common.nix;

     
···

       
129
       
 
       
  '';

     

       
130
       
 
       


     

       
131
       
 
       
  portableServiceOptions = buildPackages.nixosOptionsDoc {

     

       
132
       
-
       
    inherit (evalModules { modules = [ ../../modules/system/service/portable/service.nix ]; }) options;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
133
       
 
       
    inherit revision warningsAreErrors;

     

       
134
       
 
       
    transformOptions =

     

       
135
       
 
       
      opt:

     

···

       
25
       
 
       
    escapeShellArg

     

       
26
       
 
       
    concatMapStringsSep

     

       
27
       
 
       
    sourceFilesBySuffices

     

       
28
       
+
       
    modules

     

       
29
       
 
       
    ;

     

       
30
       
 
       


     

       
31
       
 
       
  common = import ./common.nix;

     
···

       
130
       
 
       
  '';

     

       
131
       
 
       


     

       
132
       
 
       
  portableServiceOptions = buildPackages.nixosOptionsDoc {

     

       
133
       
+
       
    inherit

     

       
134
       
+
       
      (evalModules {

     

       
135
       
+
       
        modules = [

     

       
136
       
+
       
          (modules.importApply ../../modules/system/service/portable/service.nix {

     

       
137
       
+
       
            pkgs = throw "nixos docs / portableServiceOptions: Do not reference pkgs in docs";

     

       
138
       
+
       
          })

     

       
139
       
+
       
        ];

     

       
140
       
+
       
      })

     

       
141
       
+
       
      options

     

       
142
       
+
       
      ;

     

       
143
       
 
       
    inherit revision warningsAreErrors;

     

       
144
       
 
       
    transformOptions =

     

       
145
       
 
       
      opt:

     

···

       
1
       
 
       
{ lib, ... }:

     

       
2
       
 
       
let

     

       
3
       
-
       
  inherit (lib) concatLists mapAttrsToList showOption;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
4
       
 
       
in

     

       
5
       
 
       
rec {

     

       
6
       
 
       
  flattenMapServicesConfigToList =

     
···

       
30
       
 
       
      assertion = ass.assertion;

     

       
31
       
 
       
    }) config.assertions

     

       
32
       
 
       
  );

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
33
       
 
       
}

     

···

       
1
       
 
       
{ lib, ... }:

     

       
2
       
 
       
let

     

       
3
       
+
       
  inherit (lib)

     

       
4
       
+
       
    concatLists

     

       
5
       
+
       
    mapAttrsToList

     

       
6
       
+
       
    showOption

     

       
7
       
+
       
    types

     

       
8
       
+
       
    ;

     

       
9
       
 
       
in

     

       
10
       
 
       
rec {

     

       
11
       
 
       
  flattenMapServicesConfigToList =

     
···

       
35
       
 
       
      assertion = ass.assertion;

     

       
36
       
 
       
    }) config.assertions

     

       
37
       
 
       
  );

     

       
38
       
+
       


     

       
39
       
+
       
  /**

     

       
40
       
+
       
    This is the entrypoint for the portable part of modular services.

     

       
41
       
+
       


     

       
42
       
+
       
    It provides the various options that are consumed by service manager implementations.

     

       
43
       
+
       


     

       
44
       
+
       
    # Inputs

     

       
45
       
+
       


     

       
46
       
+
       
    `serviceManagerPkgs`: A Nixpkgs instance which will be used for built-in logic such as converting `configData.<path>.text` to a store path.

     

       
47
       
+
       


     

       
48
       
+
       
    `extraRootModules`: Modules to be loaded into the "root" service submodule, but not into its sub-`services`. That's the modules' own responsibility.

     

       
49
       
+
       


     

       
50
       
+
       
    `extraRootSpecialArgs`: Fixed module arguments that are provided in a similar manner to `extraRootModules`.

     

       
51
       
+
       


     

       
52
       
+
       
    # Output

     

       
53
       
+
       


     

       
54
       
+
       
    An attribute set.

     

       
55
       
+
       


     

       
56
       
+
       
    `serviceSubmodule`: a Module System option type which is a `submodule` with the portable modules and this function's inputs loaded into it.

     

       
57
       
+
       
  */

     

       
58
       
+
       
  configure =

     

       
59
       
+
       
    {

     

       
60
       
+
       
      serviceManagerPkgs,

     

       
61
       
+
       
      extraRootModules ? [ ],

     

       
62
       
+
       
      extraRootSpecialArgs ? { },

     

       
63
       
+
       
    }:

     

       
64
       
+
       
    let

     

       
65
       
+
       
      modules = [

     

       
66
       
+
       
        (lib.modules.importApply ./service.nix { pkgs = serviceManagerPkgs; })

     

       
67
       
+
       
      ];

     

       
68
       
+
       
      serviceSubmodule = types.submoduleWith {

     

       
69
       
+
       
        class = "service";

     

       
70
       
+
       
        modules = modules ++ extraRootModules;

     

       
71
       
+
       
        specialArgs = extraRootSpecialArgs;

     

       
72
       
+
       
      };

     

       
73
       
+
       
    in

     

       
74
       
+
       
    {

     

       
75
       
+
       
      inherit serviceSubmodule;

     

       
76
       
+
       
    };

     

       
77
       
 
       
}

     

···

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
1
       
 
       
{

     

       
2
       
 
       
  lib,

     

       
3
       
 
       
  ...

     
···

       
11
       
 
       
  _class = "service";

     

       
12
       
 
       
  imports = [

     

       
13
       
 
       
    ../../../misc/assertions.nix

     

       
0
       
 
       

     

       
14
       
 
       
  ];

     

       
15
       
 
       
  options = {

     

       
16
       
 
       
    services = mkOption {

     

       
17
       
 
       
      type = types.attrsOf (

     

       
18
       
 
       
        types.submoduleWith {

     

       
19
       
 
       
          modules = [

     

       
20
       
-
       
            ./service.nix

     

       
21
       
 
       
          ];

     

       
22
       
 
       
        }

     

       
23
       
 
       
      );

     

···

       
1
       
+
       
# Non-module arguments

     

       
2
       
+
       
# These are separate from the module arguments to avoid implicit dependencies.

     

       
3
       
+
       
# This makes service modules self-contains, allowing mixing of Nixpkgs versions.

     

       
4
       
+
       
{ pkgs }:

     

       
5
       
+
       


     

       
6
       
+
       
# The module

     

       
7
       
 
       
{

     

       
8
       
 
       
  lib,

     

       
9
       
 
       
  ...

     
···

       
17
       
 
       
  _class = "service";

     

       
18
       
 
       
  imports = [

     

       
19
       
 
       
    ../../../misc/assertions.nix

     

       
20
       
+
       
    (lib.modules.importApply ./config-data.nix { inherit pkgs; })

     

       
21
       
 
       
  ];

     

       
22
       
 
       
  options = {

     

       
23
       
 
       
    services = mkOption {

     

       
24
       
 
       
      type = types.attrsOf (

     

       
25
       
 
       
        types.submoduleWith {

     

       
26
       
 
       
          modules = [

     

       
27
       
+
       
            (lib.modules.importApply ./service.nix { inherit pkgs; })

     

       
28
       
 
       
          ];

     

       
29
       
 
       
        }

     

       
30
       
 
       
      );

     

···

       
52
       
 
       


     

       
53
       
 
       
in

     

       
54
       
 
       
{

     

       
0
       
 
       

     

       
55
       
 
       
  imports = [

     

       
56
       
-
       
    ../portable/service.nix

     

       
57
       
 
       
    (lib.mkAliasOptionModule [ "systemd" "service" ] [ "systemd" "services" "" ])

     

       
58
       
 
       
    (lib.mkAliasOptionModule [ "systemd" "socket" ] [ "systemd" "sockets" "" ])

     

       
59
       
 
       
  ];

     
···

       
101
       
 
       
          };

     

       
102
       
 
       
        }

     

       
103
       
 
       
      );

     

       
0
       
 
       

     

       
0
       
 
       

     

       
104
       
 
       
    };

     

       
105
       
 
       
  };

     

       
106
       
 
       
  config = {

     

···

       
52
       
 
       


     

       
53
       
 
       
in

     

       
54
       
 
       
{

     

       
55
       
+
       
  _class = "service";

     

       
56
       
 
       
  imports = [

     

       
0
       
 
       

     

       
57
       
 
       
    (lib.mkAliasOptionModule [ "systemd" "service" ] [ "systemd" "services" "" ])

     

       
58
       
 
       
    (lib.mkAliasOptionModule [ "systemd" "socket" ] [ "systemd" "sockets" "" ])

     

       
59
       
 
       
  ];

     
···

       
101
       
 
       
          };

     

       
102
       
 
       
        }

     

       
103
       
 
       
      );

     

       
104
       
+
       
      # Rendered by the portable docs instead.

     

       
105
       
+
       
      visible = false;

     

       
106
       
 
       
    };

     

       
107
       
 
       
  };

     

       
108
       
 
       
  config = {

     

···

       
59
       
 
       
    // concatMapAttrs (

     

       
60
       
 
       
      subServiceName: subService: makeUnits unitType (dash prefix subServiceName) subService

     

       
61
       
 
       
    ) service.services;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
62
       
 
       
in

     

       
63
       
 
       
{

     

       
0
       
 
       

     

       
0
       
 
       

     

       
64
       
 
       
  # First half of the magic: mix systemd logic into the otherwise abstract services

     

       
65
       
 
       
  options = {

     

       
66
       
 
       
    system.services = mkOption {

     

       
67
       
 
       
      description = ''

     

       
68
       
 
       
        A collection of NixOS [modular services](https://nixos.org/manual/nixos/unstable/#modular-services) that are configured as systemd services.

     

       
69
       
 
       
      '';

     

       
70
       
-
       
      type = types.attrsOf (

     

       
71
       
-
       
        types.submoduleWith {

     

       
72
       
-
       
          class = "service";

     

       
73
       
-
       
          modules = [

     

       
74
       
-
       
            ./service.nix

     

       
75
       
-
       
            ./config-data-path.nix

     

       
76
       
-
       
            (lib.modules.importApply ../portable/config-data.nix { inherit pkgs; })

     

       
77
       
-
       


     

       
78
       
-
       
            {

     

       
79
       
-
       
              # Extend portable services option

     

       
80
       
-
       
              options.services = lib.mkOption {

     

       
81
       
-
       
                type = types.attrsOf (

     

       
82
       
-
       
                  types.submoduleWith {

     

       
83
       
-
       
                    modules = [

     

       
84
       
-
       
                      (lib.modules.importApply ../portable/config-data.nix { inherit pkgs; })

     

       
85
       
-
       
                    ];

     

       
86
       
-
       
                  }

     

       
87
       
-
       
                );

     

       
88
       
-
       
              };

     

       
89
       
-
       
            }

     

       
90
       
-
       
          ];

     

       
91
       
-
       
          specialArgs = {

     

       
92
       
-
       
            # perhaps: features."systemd" = { };

     

       
93
       
-
       
            systemdPackage = config.systemd.package;

     

       
94
       
-
       
          };

     

       
95
       
-
       
        }

     

       
96
       
-
       
      );

     

       
97
       
 
       
      default = { };

     

       
98
       
 
       
      visible = "shallow";

     

       
99
       
 
       
    };

     

···

       
59
       
 
       
    // concatMapAttrs (

     

       
60
       
 
       
      subServiceName: subService: makeUnits unitType (dash prefix subServiceName) subService

     

       
61
       
 
       
    ) service.services;

     

       
62
       
+
       


     

       
63
       
+
       
  modularServiceConfiguration = portable-lib.configure {

     

       
64
       
+
       
    serviceManagerPkgs = pkgs;

     

       
65
       
+
       
    extraRootModules = [

     

       
66
       
+
       
      ./service.nix

     

       
67
       
+
       
      ./config-data-path.nix

     

       
68
       
+
       
    ];

     

       
69
       
+
       
    extraRootSpecialArgs = {

     

       
70
       
+
       
      systemdPackage = config.systemd.package;

     

       
71
       
+
       
    };

     

       
72
       
+
       
  };

     

       
73
       
 
       
in

     

       
74
       
 
       
{

     

       
75
       
+
       
  _class = "nixos";

     

       
76
       
+
       


     

       
77
       
 
       
  # First half of the magic: mix systemd logic into the otherwise abstract services

     

       
78
       
 
       
  options = {

     

       
79
       
 
       
    system.services = mkOption {

     

       
80
       
 
       
      description = ''

     

       
81
       
 
       
        A collection of NixOS [modular services](https://nixos.org/manual/nixos/unstable/#modular-services) that are configured as systemd services.

     

       
82
       
 
       
      '';

     

       
83
       
+
       
      type = types.attrsOf modularServiceConfiguration.serviceSubmodule;

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
84
       
 
       
      default = { };

     

       
85
       
 
       
      visible = "shallow";

     

       
86
       
 
       
    };