modules/nixos/laminar.nix (view raw)
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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | { config , lib , pkgs , ... }: let cfg = config.services.laminar; inherit (lib) literalExpression optionalAttrs mapAttrs' mkEnableOption mkPackageOption mkOption mkIf types; in { options.services.laminar = { enable = mkEnableOption "Lightweight and modular Continuous Integration service for Linux."; user = mkOption { type = types.str; default = "laminar"; description = "User account under which laminar runs."; }; group = mkOption { type = types.str; default = "laminar"; description = "User account under which laminar runs."; }; package = mkPackageOption pkgs "laminar" { }; homeDir = mkOption { type = types.path; default = "/var/lib/laminar"; description = "Home directory for laminar user."; }; path = mkOption { type = types.listOf types.package; default = with pkgs; [ bash stdenv git nix config.programs.ssh.package config.services.laminar.package ]; defaultText = literalExpression "[ pkgs.stdenv pkgs.git pkgs.nix config.programs.ssh.package ]"; description = "Packages added to service PATH environment variable."; }; timers = mkOption { default = { }; description = '' Nightly jobs to run ''; type = with types; attrsOf (submodule { options = { name = mkOption { type = types.str; default = name; description = "Name of the timer."; }; reason = mkOption { type = with types; nullOr str; example = "Nightly build"; default = null; description = "optional human-readable string that will be displayed in the web UI as the cause of the build."; }; startAt = mkOption { type = with types; either str (listOf str); default = "daily"; description = '' How often this job is started. See {manpage}`systemd.time(7)` for more information about the format. ''; }; accuracy = mkOption { type = types.str; default = "10 min"; description = '' How close to `startAt` time the job is actually run. See {manpage}`systemd.time(7)` for more information about the format. ''; }; }; }); }; settings = mkOption { default = { }; description = '' Configuration for laminar. See https://laminar.ohwg.net/docs.html#Service-configuration-file ''; type = types.submodule { options = { bindHTTP = mkOption { type = types.str; default = "*:8080"; description = "The interface/port or unix socket on which laminard should listen for incoming connections to the web frontend."; }; bindRPC = mkOption { type = types.str; default = "unix-abstract:laminar"; description = "The interface/port or unix socket on which laminard should listen for incoming commands such as build triggers."; }; title = mkOption { type = types.str; default = ""; description = "The page title to show in the web frontend."; }; keepRundirs = mkOption { type = types.int; default = 0; description = "Set to an integer defining how many rundirs to keep per job. The lowest-numbered ones will be deleted."; }; baseURL = mkOption { type = types.str; default = "/"; description = "Base url for the frontend."; }; archiveURL = mkOption { type = with types; nullOr str; default = null; example = "http://localhost:8080"; description = "If set, the web frontend served by laminard will use this URL to form links to artefacts archived jobs."; }; }; }; }; }; config = mkIf cfg.enable { systemd.services = { laminar = { description = "Laminar continuous integration service"; wantedBy = [ "multi-user.target" ]; after = [ "network.target" ]; inherit (cfg) path; environment = { XDG_RUNTIME_DIR = "%t/laminar"; }; serviceConfig = { User = cfg.user; Group = cfg.group; ExecStart = "${cfg.package}/bin/laminard -v"; RuntimeDirectory = "laminar"; EnvironmentFile = pkgs.writeText "laminar.conf" '' LAMINAR_HOME=${cfg.homeDir} LAMINAR_BIND_HTTP=${cfg.settings.bindHTTP} LAMINAR_BIND_RPC=${cfg.settings.bindRPC} LAMINAR_TITLE=${cfg.settings.title} LAMINAR_KEEP_RUNDIRS=${toString cfg.settings.keepRundirs} LAMINAR_BASE_URL=${cfg.settings.baseURL} ${lib.optionalString (cfg.settings.archiveURL != null) "LAMINAR_ARCHIVE_URL=${cfg.settings.archiveURL}" } ''; }; unitConfig = { Documentation = [ "man:laminard(8)" "https://laminar.ohwg.net/docs.html" ]; }; }; } // (mapAttrs' (name: job: { name = "laminar-job-${name}"; value = { description = "Runs laminar CI job."; path = [ cfg.package "/run/wrappers" ] ++ cfg.path; environment = { LAMINAR_REASON = job.reason; }; serviceConfig = { User = cfg.user; Group = cfg.group; Type = "oneshot"; ExecStart = "${cfg.package}/bin/laminarc run ${name}"; }; }; }) cfg.timers); systemd.timers = (mapAttrs' (name: job: { name = "laminar-job-${name}"; value = { wantedBy = [ "timers.target" ]; timerConfig = { OnCalendar = job.startAt; AccuracySec = job.accuracy; Persistent = true; }; }; }) cfg.timers); environment.systemPackages = [ pkgs.laminar ]; users.users = optionalAttrs (cfg.user == "laminar") { laminar = { inherit (cfg) group; home = cfg.homeDir; createHome = true; isSystemUser = true; }; }; users.groups = optionalAttrs (cfg.group == "laminar") { laminar = { }; }; }; } |