Containerize github runners (#41)

This commit is contained in:
Sridhar Ratnakumar 2024-01-27 07:17:39 -05:00 committed by GitHub
parent c04849f9f1
commit 56c8d3120f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 82 additions and 36 deletions

View file

@ -2,7 +2,9 @@
TODOs
- [ ] Run runners in containers
- [x] Run runners in containers
- [ ] Unbreak cachix? https://github.com/cachix/cachix-action/issues/169
- [ ] Or switch to nix-serve or attic
- [ ] Write a token creation script:
```sh
$ gh api \
@ -14,12 +16,9 @@
- [ ] Can we automate that to write directly to secrets.json?
*/
{ pkgs, lib, config, ... }:
top@{ pkgs, lib, config, ... }:
let
inherit (lib) types;
getRunnerUser = name:
# systemd DynamicUser
"github-runner-${name}";
in
{
options = {
@ -27,20 +26,37 @@ in
default = { };
type = types.submodule {
options = {
localAddress = lib.mkOption {
type = types.str;
default =
(builtins.head (builtins.head (lib.attrValues config.networking.interfaces)).ipv4.addresses).address;
};
runnerUid = lib.mkOption {
type = types.int;
default = 1234;
description = ''
Shared UID between host and containers, so guest nix can access /nix/store of host.
'';
};
owner = lib.mkOption {
type = types.str;
default = "srid";
};
repositories = lib.mkOption {
type = types.listOf types.str;
default = [
# My repositories configured to use self-hosted runners
#
# For each entry, make sure the token exists in secrets.json (use
# the `gh` command above to create this token from CLI)
"emanote"
"haskell-flake"
];
type = types.attrsOf types.str;
description = ''
My repositories configured to use self-hosted runners
*Before* adding an entry, make sure the token exists in
secrets.json (use the `gh` command above to create this token
from CLI)
Maps to container IP address to assign.
'';
default = {
"emanote" = "192.168.100.20";
"haskell-flake" = "192.168.100.21";
};
};
sopsPrefix = lib.mkOption {
type = types.str;
@ -54,6 +70,7 @@ in
nixci
which
coreutils
docker
];
extraLabels = [ "nixos" ];
};
@ -67,27 +84,56 @@ in
cfg = config.services.personal-github-runners;
in
{
sops.secrets = lib.listToAttrs (builtins.map
(name: lib.nameValuePair "${cfg.sopsPrefix}/${name}" {
sops.secrets = lib.mapAttrs'
(name: _: lib.nameValuePair "${cfg.sopsPrefix}/${name}" {
mode = "0440";
})
cfg.repositories);
cfg.repositories;
# TODO: Run inside container
services.github-runners = lib.listToAttrs (builtins.map
(name: lib.nameValuePair name (cfg.runnerConfig // {
enable = true;
tokenFile = config.sops.secrets."${cfg.sopsPrefix}/${name}".path;
url = "https://github.com/${cfg.owner}/${name}";
}))
cfg.repositories);
containers =
lib.mapAttrs'
(name: hostAddress:
let tokenFile = top.config.sops.secrets."${cfg.sopsPrefix}/${name}".path;
in lib.nameValuePair "github-runner-${name}" {
inherit (cfg) localAddress;
inherit hostAddress;
autoStart = true;
bindMounts."${tokenFile}" = {
hostPath = tokenFile;
isReadOnly = true;
};
config = { config, pkgs, ... }: {
system.stateVersion = "23.11";
users.users."github-runner-${name}" = {
uid = cfg.runnerUid;
isSystemUser = true;
group = "github-runner-${name}";
};
users.groups."github-runner-${name}" = { };
nix.settings = {
trusted-users = [ "github-runner-${name}" ]; # for cachix
experimental-features = "nix-command flakes repl-flake";
max-jobs = "auto";
};
services.github-runners."${name}" = cfg.runnerConfig // {
enable = true;
inherit tokenFile;
url = "https://github.com/${cfg.owner}/${name}";
};
};
})
cfg.repositories;
nix.settings.trusted-users =
lib.mapAttrsToList
(name: runner:
if runner.user == null
then getRunnerUser name
else runner.user)
config.services.github-runners;
users.users."github-runner" = {
uid = cfg.runnerUid;
isSystemUser = true;
group = "github-runner";
};
users.groups.github-runner = { };
nix.settings = {
trusted-users = [ "github-runner" ];
allowed-users = [ "github-runner" ];
};
};
}

View file

@ -1,7 +1,7 @@
{
"gh-selfhosted-tokens": {
"emanote": "ENC[AES256_GCM,data:NijPIoBgcRrp5zFsT48NthT6CjJUofv1aYv+3HA=,iv:W2e5y3vqMFL/rBKQ79fV89f+piUY4HI8GrETbj2NPq8=,tag:geiipLY0dmrMQJyRy2zidg==,type:str]",
"haskell-flake": "ENC[AES256_GCM,data:v3vTEuu7F8z3BmxGzjlMa/T6RSAtSyObDSDZIes=,iv:Z5NKQm3lGQw2hVVViPYKs9F2pYIw30sY9DZjws2odDg=,tag:oMPX0R3Yjsb7/19gznDmvA==,type:str]"
"emanote": "ENC[AES256_GCM,data:JFLQza/PPi38VSnNlD0/5WfrmoXX2vqOltcznfY=,iv:4+8ylhOC+oByQgKBAMARdcGDbuI5yDukdQuGnrJsUSc=,tag:w6GgKobvzVrvRMHAAr0a2w==,type:str]",
"haskell-flake": "ENC[AES256_GCM,data:MOYfcz1DUE5ioibm8F8kklSEwGrmQhIYaUA1OyQ=,iv:ZJyjx5VHFrcPznJF4W3wC0laM2LSzhpxXNGJH/iVELY=,tag:gcYUO5ZKMWIAGHPIWAcnKQ==,type:str]"
},
"jenkins-nix-ci": {
"ssh-key": {
@ -46,8 +46,8 @@
"enc": "-----BEGIN AGE ENCRYPTED FILE-----\nYWdlLWVuY3J5cHRpb24ub3JnL3YxCi0+IFgyNTUxOSBZdnowOWgwcjd1VXg4SGhW\nWjZMNG81Rmg5Z01xSjN0a0NGLzFOUGVnWkN3CmoydzJuNDNnSzllVlg1L0wya0Uv\nZHJBY1RJQ0FyaXQ2bXpnMkNoTGxEQ1kKLS0tIExEcDhUc3hoaWhtdm43OExXWlNI\nTWFzSVJmQzRod2x5Y2wySXZ1S2xzclUKVLrGlm0z8MXZh5PVoXuyZDDF0D4qTtVx\nMF+ELQOsxosHq9fOqxvZq8lCxP3btvZbvR5yuDVzzlOsybAYZOwoPw==\n-----END AGE ENCRYPTED FILE-----\n"
}
],
"lastmodified": "2024-01-27T06:54:58Z",
"mac": "ENC[AES256_GCM,data:uF7Ap2COmE8UuKabF7+mF9t6cmC/d5MVWP9WYtFAiWHFWYpOrZAylpDczfF0msNhJM81t762e/14YRufLgYWfamQzEGvarl2lTTwSBJ1S5CX6w3L7UjaktvjetjQCeKd4RDp1j8YohJgCEtbWOG5pGsPeMFkKYzC6UqUcdgkpZM=,iv:fo8samIchi9skamqzDyXYMOyJzowFcPyCojAsTHj5OY=,tag:I+MC/Zbi9zYqkJEjdXHaiQ==,type:str]",
"lastmodified": "2024-01-27T11:48:19Z",
"mac": "ENC[AES256_GCM,data:K19KDxlAnYU3eXhRjLYeB+gBAn/8xR7UfW9KWFBWJOKEIXLOxXF5m8wgSeAdziWYl+felBmNS3CeJ24RakvZ7Awxmvgbu9K+kamkAOzZVlJSREAUy1Ga1Rq0eoGNWCO58FOcPtrPe+l0/+fUDgAbQywlrECuu6OQoTZhBOlT6as=,iv:oiSfIxUCQxUrm2pCdwJooxj5oZugcnKcj30ztAklMGg=,tag:bxMPNu/+ZFj2TvQaPejggg==,type:str]",
"pgp": null,
"unencrypted_suffix": "_unencrypted",
"version": "3.8.1"