summaryrefslogtreecommitdiffstats
path: root/nixos/modules/virtualisation/containers.nix
blob: 4b0c59846d2c90f3637ed87b2b775f4c42c94e53 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
{
  config,
  lib,
  pkgs,
  ...
}:
let
  cfg = config.virtualisation.containers;

  inherit (lib) literalExpression mkOption types;

  oldRegistriesOptionsUsed = lib.any (x: x != [ ]) (
    with cfg.registries;
    [
      search
      insecure
      block
    ]
  );

  toml = pkgs.formats.toml { };
in
{
  meta = {
    teams = [ lib.teams.podman ];
  };

  options.virtualisation.containers = {

    enable = mkOption {
      type = types.bool;
      default = false;
      description = ''
        This option enables the common /etc/containers configuration module.
      '';
    };

    ociSeccompBpfHook.enable = mkOption {
      type = types.bool;
      default = false;
      description = "Enable the OCI seccomp BPF hook";
    };

    containersConf.settings = mkOption {
      type = toml.type;
      default = { };
      description = "containers.conf configuration";
    };

    containersConf.cniPlugins = mkOption {
      type = types.listOf types.package;
      defaultText = literalExpression ''
        [
          pkgs.cni-plugins
        ]
      '';
      example = literalExpression ''
        [
          pkgs.cniPlugins.dnsname
        ]
      '';
      description = ''
        CNI plugins to install on the system.
      '';
    };

    storage.settings = mkOption {
      type = toml.type;
      description = "storage.conf configuration";
    };

    registries = {
      # TODO: remove those options in 26.11
      search = mkOption {
        visible = false;
        type = types.listOf types.str;
        default = [ ];
        description = ''
          List of repositories to search.

          Deprecated, examine {option}`virtualisation.containers.registries.settings` instead.
        '';
      };

      insecure = mkOption {
        default = [ ];
        visible = false;
        type = types.listOf types.str;
        description = ''
          List of insecure repositories.

          Deprecated, examine {option}`virtualisation.containers.registries.settings` instead.
        '';
      };

      block = mkOption {
        default = [ ];
        visible = false;
        type = types.listOf types.str;
        description = ''
          List of blocked repositories.

          Deprecated, examine {option}`virtualisation.containers.registries.settings` instead.
        '';
      };

      settings = mkOption {
        type = toml.type;
        default = {
          registry = [
            { location = "docker.io"; }
            { location = "quay.io"; }
          ];
        };
        description = ''
          repositories.conf configuration.

          Examine [containers-registries.conf(5)] for more information about the format.

            [containers-registries.conf(5)]: https://github.com/containers/image/blob/main/docs/containers-registries.conf.5.md
        '';
      };
    };

    policy = mkOption {
      default = { };
      type = types.attrs;
      example = literalExpression ''
        {
          default = [ { type = "insecureAcceptAnything"; } ];
          transports = {
            docker-daemon = {
              "" = [ { type = "insecureAcceptAnything"; } ];
            };
          };
        }
      '';
      description = ''
        Signature verification policy file.
        If this option is empty the default policy file from
        `skopeo` will be used.
      '';
    };

  };

  config = lib.mkIf cfg.enable {
    warnings = lib.optional oldRegistriesOptionsUsed "the options virtualisation.containers.registries.search / insecure / block are deprecated. See virtualisation.containers.registries.settings instead.";

    virtualisation.containers.registries.settings = lib.mkIf oldRegistriesOptionsUsed {
      registries = {
        block.registries = cfg.registries.block;
        insecure.registries = cfg.registries.insecure;
        search.registries = cfg.registries.search;
      };
    };

    virtualisation.containers.containersConf.cniPlugins = [ pkgs.cni-plugins ];

    virtualisation.containers.containersConf.settings = {
      network.cni_plugin_dirs = map (p: "${lib.getBin p}/bin") cfg.containersConf.cniPlugins;
      engine = {
        init_path = "${pkgs.catatonit}/bin/catatonit";
      }
      // lib.optionalAttrs cfg.ociSeccompBpfHook.enable {
        hooks_dir = [ config.boot.kernelPackages.oci-seccomp-bpf-hook ];
      };
    };

    virtualisation.containers.storage.settings.storage = {
      driver = lib.mkDefault "overlay";
      graphroot = lib.mkDefault "/var/lib/containers/storage";
      runroot = lib.mkDefault "/run/containers/storage";
    };

    environment.etc = {
      "containers/containers.conf".source = toml.generate "containers.conf" cfg.containersConf.settings;

      "containers/storage.conf".source = toml.generate "storage.conf" cfg.storage.settings;

      "containers/registries.conf".source = toml.generate "registries.conf" cfg.registries.settings;

      "containers/policy.json".source =
        if cfg.policy != { } then
          pkgs.writeText "policy.json" (builtins.toJSON cfg.policy)
        else
          "${pkgs.skopeo.policy}/default-policy.json";
    };

  };

}