commit c0d9f21f50a90a5706214c09760a3ae9abfcfcf0 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       696
       696
        
         ./services/monitoring/arbtt.nix

     

       697
       697
        
         ./services/monitoring/bosun.nix

     

       698
       698
        
         ./services/monitoring/cadvisor.nix

     

       699
       699
       +
         ./services/monitoring/cockpit.nix

     

       699
       700
        
         ./services/monitoring/collectd.nix

     

       700
       701
        
         ./services/monitoring/das_watchdog.nix

     

       701
       702
        
         ./services/monitoring/datadog-agent.nix

+231

nixos/modules/services/monitoring/cockpit.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
         cfg = config.services.cockpit;

     

       5
       5
       +
         inherit (lib) types mkEnableOption mkOption mkIf mdDoc literalMD mkPackageOptionMD;

     

       6
       6
       +
         settingsFormat = pkgs.formats.ini {};

     

       7
       7
       +
       in {

     

       8
       8
       +
         options = {

     

       9
       9
       +
           services.cockpit = {

     

       10
       10
       +
             enable = mkEnableOption (mdDoc "Cockpit");

     

       11
       11
       +
       

     

       12
       12
       +
             package = mkPackageOptionMD pkgs "Cockpit" {

     

       13
       13
       +
               default = [ "cockpit" ];

     

       14
       14
       +
             };

     

       15
       15
       +
       

     

       16
       16
       +
             settings = lib.mkOption {

     

       17
       17
       +
               type = settingsFormat.type;

     

       18
       18
       +
       

     

       19
       19
       +
               default = {};

     

       20
       20
       +
       

     

       21
       21
       +
               description = mdDoc ''

     

       22
       22
       +
                 Settings for cockpit that will be saved in /etc/cockpit/cockpit.conf.

     

       23
       23
       +
       

     

       24
       24
       +
                 See the [documentation](https://cockpit-project.org/guide/latest/cockpit.conf.5.html), that is also available with `man cockpit.conf.5` for details.

     

       25
       25
       +
               '';

     

       26
       26
       +
             };

     

       27
       27
       +
       

     

       28
       28
       +
             port = mkOption {

     

       29
       29
       +
               description = mdDoc "Port where cockpit will listen.";

     

       30
       30
       +
               type = types.port;

     

       31
       31
       +
               default = 9090;

     

       32
       32
       +
             };

     

       33
       33
       +
       

     

       34
       34
       +
             openFirewall = mkOption {

     

       35
       35
       +
               description = mdDoc "Open port for cockpit.";

     

       36
       36
       +
               type = types.bool;

     

       37
       37
       +
               default = false;

     

       38
       38
       +
             };

     

       39
       39
       +
           };

     

       40
       40
       +
         };

     

       41
       41
       +
         config = mkIf cfg.enable {

     

       42
       42
       +
       

     

       43
       43
       +
           # expose cockpit-bridge system-wide

     

       44
       44
       +
           environment.systemPackages = [ cfg.package ];

     

       45
       45
       +
       

     

       46
       46
       +
           # allow cockpit to find its plugins

     

       47
       47
       +
           environment.pathsToLink = [ "/share/cockpit" ];

     

       48
       48
       +
       

     

       49
       49
       +
           # generate cockpit settings

     

       50
       50
       +
           environment.etc."cockpit/cockpit.conf".source = settingsFormat.generate "cockpit.conf" cfg.settings;

     

       51
       51
       +
       

     

       52
       52
       +
           security.pam.services.cockpit = {};

     

       53
       53
       +
       

     

       54
       54
       +
           networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.port ];

     

       55
       55
       +
       

     

       56
       56
       +
           # units are in reverse sort order if you ls $out/lib/systemd/system

     

       57
       57
       +
           # all these units are basically verbatim translated from upstream

     

       58
       58
       +
       

     

       59
       59
       +
           # Translation from $out/lib/systemd/system/systemd-cockpithttps.slice

     

       60
       60
       +
           systemd.slices.system-cockpithttps = {

     

       61
       61
       +
             description = "Resource limits for all cockpit-ws-https@.service instances";

     

       62
       62
       +
             sliceConfig = {

     

       63
       63
       +
               TasksMax = 200;

     

       64
       64
       +
               MemoryHigh = "75%";

     

       65
       65
       +
               MemoryMax = "90%";

     

       66
       66
       +
             };

     

       67
       67
       +
           };

     

       68
       68
       +
       

     

       69
       69
       +
           # Translation from $out/lib/systemd/system/cockpit-wsinstance-https@.socket

     

       70
       70
       +
           systemd.sockets."cockpit-wsinstance-https@" = {

     

       71
       71
       +
             unitConfig = {

     

       72
       72
       +
               Description = "Socket for Cockpit Web Service https instance %I";

     

       73
       73
       +
               BindsTo = [ "cockpit.service" "cockpit-wsinstance-https@%i.service" ];

     

       74
       74
       +
               # clean up the socket after the service exits, to prevent fd leak

     

       75
       75
       +
               # this also effectively prevents a DoS by starting arbitrarily many sockets, as

     

       76
       76
       +
               # the services are resource-limited by system-cockpithttps.slice

     

       77
       77
       +
               Documentation = "man:cockpit-ws(8)";

     

       78
       78
       +
             };

     

       79
       79
       +
             socketConfig = {

     

       80
       80
       +
               ListenStream = "/run/cockpit/wsinstance/https@%i.sock";

     

       81
       81
       +
               SocketUser = "root";

     

       82
       82
       +
               SocketMode = "0600";

     

       83
       83
       +
             };

     

       84
       84
       +
           };

     

       85
       85
       +
       

     

       86
       86
       +
           # Translation from $out/lib/systemd/system/cockpit-wsinstance-https@.service

     

       87
       87
       +
           systemd.services."cockpit-wsinstance-https@" = {

     

       88
       88
       +
             description = "Cockpit Web Service https instance %I";

     

       89
       89
       +
             bindsTo = [ "cockpit.service"];

     

       90
       90
       +
             path = [ cfg.package ];

     

       91
       91
       +
             documentation = [ "man:cockpit-ws(8)" ];

     

       92
       92
       +
             serviceConfig = {

     

       93
       93
       +
               Slice = "system-cockpithttps.slice";

     

       94
       94
       +
               ExecStart = "${cfg.package}/libexec/cockpit-ws --for-tls-proxy --port=0";

     

       95
       95
       +
               User = "root";

     

       96
       96
       +
               Group = "";

     

       97
       97
       +
             };

     

       98
       98
       +
           };

     

       99
       99
       +
       

     

       100
       100
       +
           # Translation from $out/lib/systemd/system/cockpit-wsinstance-http.socket

     

       101
       101
       +
           systemd.sockets.cockpit-wsinstance-http = {

     

       102
       102
       +
             unitConfig = {

     

       103
       103
       +
               Description = "Socket for Cockpit Web Service http instance";

     

       104
       104
       +
               BindsTo = "cockpit.service";

     

       105
       105
       +
               Documentation = "man:cockpit-ws(8)";

     

       106
       106
       +
             };

     

       107
       107
       +
             socketConfig = {

     

       108
       108
       +
               ListenStream = "/run/cockpit/wsinstance/http.sock";

     

       109
       109
       +
               SocketUser = "root";

     

       110
       110
       +
               SocketMode = "0600";

     

       111
       111
       +
             };

     

       112
       112
       +
           };

     

       113
       113
       +
       

     

       114
       114
       +
           # Translation from $out/lib/systemd/system/cockpit-wsinstance-https-factory.socket

     

       115
       115
       +
           systemd.sockets.cockpit-wsinstance-https-factory = {

     

       116
       116
       +
             unitConfig = {

     

       117
       117
       +
               Description = "Socket for Cockpit Web Service https instance factory";

     

       118
       118
       +
               BindsTo = "cockpit.service";

     

       119
       119
       +
               Documentation = "man:cockpit-ws(8)";

     

       120
       120
       +
             };

     

       121
       121
       +
             socketConfig = {

     

       122
       122
       +
               ListenStream = "/run/cockpit/wsinstance/https-factory.sock";

     

       123
       123
       +
               Accept = true;

     

       124
       124
       +
               SocketUser = "root";

     

       125
       125
       +
               SocketMode = "0600";

     

       126
       126
       +
             };

     

       127
       127
       +
           };

     

       128
       128
       +
       

     

       129
       129
       +
           # Translation from $out/lib/systemd/system/cockpit-wsinstance-https-factory@.service

     

       130
       130
       +
           systemd.services."cockpit-wsinstance-https-factory@" = {

     

       131
       131
       +
             description = "Cockpit Web Service https instance factory";

     

       132
       132
       +
             documentation = [ "man:cockpit-ws(8)" ];

     

       133
       133
       +
             path = [ cfg.package ];

     

       134
       134
       +
             serviceConfig = {

     

       135
       135
       +
               ExecStart = "${cfg.package}/libexec/cockpit-wsinstance-factory";

     

       136
       136
       +
               User = "root";

     

       137
       137
       +
             };

     

       138
       138
       +
           };

     

       139
       139
       +
       

     

       140
       140
       +
           # Translation from $out/lib/systemd/system/cockpit-wsinstance-http.service

     

       141
       141
       +
           systemd.services."cockpit-wsinstance-http" = {

     

       142
       142
       +
             description = "Cockpit Web Service http instance";

     

       143
       143
       +
             bindsTo = [ "cockpit.service" ];

     

       144
       144
       +
             path = [ cfg.package ];

     

       145
       145
       +
             documentation = [ "man:cockpit-ws(8)" ];

     

       146
       146
       +
             serviceConfig = {

     

       147
       147
       +
               ExecStart = "${cfg.package}/libexec/cockpit-ws --no-tls --port=0";

     

       148
       148
       +
               User = "root";

     

       149
       149
       +
               Group = "";

     

       150
       150
       +
             };

     

       151
       151
       +
           };

     

       152
       152
       +
       

     

       153
       153
       +
           # Translation from $out/lib/systemd/system/cockpit.socket

     

       154
       154
       +
           systemd.sockets."cockpit" = {

     

       155
       155
       +
             unitConfig = {

     

       156
       156
       +
               Description = "Cockpit Web Service Socket";

     

       157
       157
       +
               Documentation = "man:cockpit-ws(8)";

     

       158
       158
       +
               Wants = "cockpit-motd.service";

     

       159
       159
       +
             };

     

       160
       160
       +
             socketConfig = {

     

       161
       161
       +
               ListenStream = cfg.port;

     

       162
       162
       +
               ExecStartPost = [

     

       163
       163
       +
                 "-${cfg.package}/share/cockpit/motd/update-motd \"\" localhost"

     

       164
       164
       +
                 "-${pkgs.coreutils}/bin/ln -snf active.motd /run/cockpit/motd"

     

       165
       165
       +
               ];

     

       166
       166
       +
               ExecStopPost = "-${pkgs.coreutils}/bin/ln -snf inactive.motd /run/cockpit/motd";

     

       167
       167
       +
             };

     

       168
       168
       +
             wantedBy = [ "sockets.target" ];

     

       169
       169
       +
           };

     

       170
       170
       +
       

     

       171
       171
       +
           # Translation from $out/lib/systemd/system/cockpit.service

     

       172
       172
       +
           systemd.services."cockpit" = {

     

       173
       173
       +
             description = "Cockpit Web Service";

     

       174
       174
       +
             documentation = [ "man:cockpit-ws(8)" ];

     

       175
       175
       +
             restartIfChanged = true;

     

       176
       176
       +
             path = with pkgs; [ coreutils cfg.package ];

     

       177
       177
       +
             requires = [ "cockpit.socket" "cockpit-wsinstance-http.socket" "cockpit-wsinstance-https-factory.socket" ];

     

       178
       178
       +
             after = [ "cockpit-wsinstance-http.socket" "cockpit-wsinstance-https-factory.socket" ];

     

       179
       179
       +
             environment = {

     

       180
       180
       +
               G_MESSAGES_DEBUG = "cockpit-ws,cockpit-bridge";

     

       181
       181
       +
             };

     

       182
       182
       +
             serviceConfig = {

     

       183
       183
       +
               RuntimeDirectory="cockpit/tls";

     

       184
       184
       +
               ExecStartPre = [

     

       185
       185
       +
                 # cockpit-tls runs in a more constrained environment, these + means that these commands

     

       186
       186
       +
                 # will run with full privilege instead of inside that constrained environment

     

       187
       187
       +
                 # See https://www.freedesktop.org/software/systemd/man/systemd.service.html#ExecStart= for details

     

       188
       188
       +
                 "+${cfg.package}/libexec/cockpit-certificate-ensure --for-cockpit-tls"

     

       189
       189
       +
               ];

     

       190
       190
       +
               ExecStart = "${cfg.package}/libexec/cockpit-tls";

     

       191
       191
       +
               User = "root";

     

       192
       192
       +
               Group = "";

     

       193
       193
       +
               NoNewPrivileges = true;

     

       194
       194
       +
               ProtectSystem = "strict";

     

       195
       195
       +
               ProtectHome = true;

     

       196
       196
       +
               PrivateTmp = true;

     

       197
       197
       +
               PrivateDevices = true;

     

       198
       198
       +
               ProtectKernelTunables = true;

     

       199
       199
       +
               RestrictAddressFamilies = [ "AF_UNIX" "AF_INET" "AF_INET6" ];

     

       200
       200
       +
               MemoryDenyWriteExecute = true;

     

       201
       201
       +
             };

     

       202
       202
       +
           };

     

       203
       203
       +
       

     

       204
       204
       +
           # Translation from $out/lib/systemd/system/cockpit-motd.service

     

       205
       205
       +
           # This part basically implements a motd state machine:

     

       206
       206
       +
           # - If cockpit.socket is enabled then /run/cockpit/motd points to /run/cockpit/active.motd

     

       207
       207
       +
           # - If cockpit.socket is disabled then /run/cockpit/motd points to /run/cockpit/inactive.motd

     

       208
       208
       +
           # - As cockpit.socket is disabled by default, /run/cockpit/motd points to /run/cockpit/inactive.motd

     

       209
       209
       +
           # /run/cockpit/active.motd is generated dynamically by cockpit-motd.service

     

       210
       210
       +
           systemd.services."cockpit-motd" = {

     

       211
       211
       +
             path = with pkgs; [ nettools ];

     

       212
       212
       +
             serviceConfig = {

     

       213
       213
       +
               Type = "oneshot";

     

       214
       214
       +
               ExecStart = "${cfg.package}/share/cockpit/motd/update-motd";

     

       215
       215
       +
             };

     

       216
       216
       +
             description = "Cockpit motd updater service";

     

       217
       217
       +
             documentation = [ "man:cockpit-ws(8)" ];

     

       218
       218
       +
             wants = [ "network.target" ];

     

       219
       219
       +
             after = [ "network.target" "cockpit.socket" ];

     

       220
       220
       +
           };

     

       221
       221
       +
       

     

       222
       222
       +
           systemd.tmpfiles.rules = [ # From $out/lib/tmpfiles.d/cockpit-tmpfiles.conf

     

       223
       223
       +
             "C /run/cockpit/inactive.motd 0640 root root - ${cfg.package}/share/cockpit/motd/inactive.motd"

     

       224
       224
       +
             "f /run/cockpit/active.motd   0640 root root -"

     

       225
       225
       +
             "L+ /run/cockpit/motd - - - - inactive.motd"

     

       226
       226
       +
             "d /etc/cockpit/ws-certs.d 0600 root root 0"

     

       227
       227
       +
           ];

     

       228
       228
       +
         };

     

       229
       229
       +
       

     

       230
       230
       +
         meta.maintainers = pkgs.cockpit.meta.maintainers;

     

       231
       231
       +
       }