deploy/gitbay-runner.override.conf

  1# Drop-in for gitbay-runner.service, installed by `make deploy-runner` to
  2# /etc/systemd/system/gitbay-runner.service.d/override.conf.
  3#
  4# A build must never starve the host: the e2e suite alone starts sixty
  5# daemon instances, and with nothing holding it back a deploy's scp on
  6# the admin sshd stalled at 1%. Lower CPU and IO weight keep sshd,
  7# gitbayd and the backup timers responsive while a build runs.
  8#
  9# These weights are for the service, not per build, so `-jobs N` divides
 10# them among N builds rather than taking N times as much. Raising -jobs
 11# does not need them raised; it makes each build slower, not the host
 12# busier.
 13#
 14# A build runs whatever the repository's ci.yml says, as the runner's
 15# own user. Keep that user unprivileged: its key is added with
 16# `keys add --scope runner`, which confines it to the runner protocol
 17# and read-only git, and the sandboxing below keeps a step from
 18# touching the system outside its workspace.
 19#
 20# Delegate=yes and the storage path below are what rootless podman needs
 21# (#144): it manages its own cgroups for a container, and its image and
 22# container store lives under the runner's home, which ProtectSystem
 23# would otherwise make read-only. Prepare the host with
 24# deploy/runner-podman-setup.sh before deploying a runner that isolates.
 25[Unit]
 26# The host egress rule (#260, gitbay-runner-egress.nft) limits what this
 27# unit's user reaches on the host: 127.0.0.1:22 for the runner, the
 28# forge's public 22, 80 and 443 for builds, nothing else. Required, so
 29# the runner does not start without it: a table that failed to load must
 30# not mean builds reach the admin sshd.
 31Requires=gitbay-runner-egress.service
 32After=gitbay-runner-egress.service
 33
 34[Service]
 35# The runner polls as a non-admin account with a runner-scoped key, and
 36# claims only the repositories that key is attached to (`repo runner
 37# add`): krz/gitbay, krz/hutch, krz/keycask, krz/orgo, krz/skunky-art
 38# and cmc/cleberg.net. The attachments are the boundary, so ExecStart
 39# names no -repos. To validate a runner change, create a scratch
 40# repository, attach this key to it, and run with -repos naming only
 41# that repository until the change is proven (Admin wiki, CI runner).
 42#
 43# Two layers of resource caps. MemoryMax and CPUQuota bound the unit —
 44# the runner and every build together — which is what keeps the forge
 45# alive when a build allocates without bound. -memory and -cpus on
 46# ExecStart cap each build's own cgroup, which the runner creates under
 47# this unit's delegated cgroup (Delegate=yes below); podman's own --memory
 48# and --cpus never applied here, since under rootless cgroupfs the
 49# container ran in the service cgroup itself (#188).
 50#
 51# 6G of the host's 7.7GB, no swap: the e2e suite peaks past 5GB, so the
 52# cap sits above that rather than at a fair share. CPUQuota=300% and
 53# -cpus 3 are three of the four cores, leaving one for gitbayd and sshd
 54# (#144, #184). OOMPolicy=continue: systemd's default stops the whole
 55# service when any process in it is OOM-killed, which would end the
 56# runner mid-build; the build fails and the runner carries on.
 57MemoryMax=6G
 58CPUQuota=300%
 59OOMPolicy=continue
 60#
 61# ExecStart is overridden here rather than left in the unit so the flags
 62# and the sandboxing that has to match them live in one file: -isolation
 63# podman needs NoNewPrivileges=no below, and -image needs an image the
 64# host has been given (deploy/runner-podman-setup.sh, Containerfile.ci).
 65# podman's run root is pinned under the runner's home by storage.conf
 66# (runner-podman-setup.sh), not taken from XDG_RUNTIME_DIR or /tmp: this
 67# unit has PrivateTmp, so a /tmp run root is a per-instance tmpfs.
 68#
 69# The cgroupfs manager puts podman's pause process under the user slice,
 70# outside this unit's cgroup, so a stop does not end it and the next
 71# start joins its namespaces — including a /tmp that no longer exists.
 72# End it with the service.
 73ExecStopPost=-/usr/bin/pkill -u ci-runner -x catatonit
 74# On stop the runner drains: it claims nothing more and finishes the
 75# build in flight, then exits. Give it long enough — the per-build limit
 76# is 45m plus half a minute of report retries — before systemd kills it.
 77# `make deploy-runner` therefore waits for a running build (#179).
 78TimeoutStopSec=50min
 79# The drain only works if the stop signal reaches the runner alone. The
 80# default control-group mode sends SIGTERM to every process in the
 81# cgroup at once — the ssh session streaming the log and the build's
 82# container with it — so the runner drained a build whose steps were
 83# already dead. mixed signals the main process only; whatever is left
 84# when it exits is killed.
 85KillMode=mixed
 86# -untrusted: this runner isolates in podman, so it takes merge request
 87# heads from forks; a runner without a container must not.
 88ExecStart=
 89ExecStart=/usr/local/bin/gitbay-runner -remote git@127.0.0.1 -workdir /var/lib/gitbay-runner/work -poll 5s -timeout 45m -isolation podman -image localhost/gitbay-ci:2 -cpus 3 -memory 6g -untrusted
 90Nice=10
 91CPUWeight=30
 92IOWeight=30
 93# NoNewPrivileges is off, and that is a deliberate trade (#144).
 94#
 95# Rootless podman sets up its user namespace with newuidmap, a setuid
 96# helper; NoNewPrivileges=yes blocks it and podman fails with
 97# "newuidmap: write to uid_map failed: Operation not permitted", so the
 98# runner refuses to start. The choice is between this flag and running
 99# builds in containers at all.
100#
101# Containers are the stronger boundary by a wide margin. NoNewPrivileges
102# constrained a process that was already executing arbitrary repository
103# code as this user; a container confines that code to an image and a
104# bind-mounted workspace. What is lost is one hardening layer on the
105# runner process itself, which is ours rather than a build's — a build no
106# longer runs in this process's context at all.
107#
108# Under -isolation none there is no container, and this flag should be
109# yes. Set it back if you run that way.
110NoNewPrivileges=no
111ProtectSystem=full
112# ProtectKernelTunables is off, for the same reason NoNewPrivileges is
113# (#144). It overmounts /proc/sys and friends in this unit's namespace,
114# and the kernel then refuses a fresh proc mount in any child user
115# namespace ("mount too revealing"): crun fails with "mount `proc` to
116# `proc`: Operation not permitted". There is no podman setting for it.
117# What the flag protected — /proc/sys from a build running on the host
118# as this user — the container now covers: a build gets its own proc,
119# with those paths masked by the runtime. Under -isolation none, set it
120# back to yes.
121# ProtectControlGroups is off because the runner writes cgroups: it
122# creates one per build under this unit's delegated cgroup to carry
123# -memory and -cpus (#188). The flag mounts /sys/fs/cgroup read-only in
124# the unit's namespace, which makes even a delegated cgroup unwritable,
125# and the runner then refuses to start when a limit is set. Delegate=yes
126# already hands this unit its subtree; what the flag protected beyond
127# that is other units' cgroups, which are root-owned and not writable
128# by this user regardless.
129ProtectControlGroups=no
130RestrictSUIDSGID=yes
131Delegate=yes
132# The runner's home is /var/lib/gitbay-runner (see the Admin page), and
133# the leading - makes a missing path ignored rather than fatal: this
134# drop-in installs on hosts that have not been prepared for podman yet,
135# and a unit that refuses to start would stop every build on the
136# instance.
137ReadWritePaths=-/var/lib/gitbay-runner/.local/share/containers -/var/lib/gitbay-runner/.config/containers