Sign in

Search issue titles and bodies, change requests and comments. Private repositories you cannot read are not included.

vole
Clone

Read only, no credentials:

https://rodent.software/git/vole.git

Write over SSH with a registered key:

git clone ssh://git@0.0.0.0:2222/vole.git

A free and open-source forge that lives in your Git repo.

Bound the runner's containers and keep its disk free

4e3759da08a603ede50107e89a23ff6d5432b7ac · Keenan Nemetz · 1h ago · parent c4ad0d5a

Bound the runner's containers and keep its disk free

The container boundary was good and the resource the job consumes was not. A job
could fork without a bound, write /tmp until the machine's RAM was gone, and fill
the disk its workspace sits on — and the runner would only notice when a build
died. The isolation protects the forge's data; this protects the machine that runs
the code.

- `--container-pids` now defaults to 2048 and zero means the default, not "no
  limit": a bound nobody set is the easiest one to be missing, and a job that can
  fork without one is a fork bomb away from taking the machine.
- `--container-tmpfs` is new and defaults to 1G. /tmp is a tmpfs, so its size is
  memory, and an unsized one is a build that fills RAM without writing a byte to
  the workspace. It is passed to service containers too.
- `--container-memory` stays the operator's setting rather than a default, because
  the right number is the machine's size and a wrong default would show up as an
  OOM kill in someone's build. All three places a runner is configured now set it:
  the packaged runner.env example, the manual steps in the deploy guide, and the
  cloud-init template (RUNNER_MEMORY, default 4G, alongside RUNNER_PIDS,
  RUNNER_TMPFS and RUNNER_DISK_RESERVE).
- `--disk-reserve` (default 2G) is how the job tree is bounded. It is a host bind
  mount, so the runtime cannot quota it and a filesystem quota needs root; a walker
  over the tree would cost more than it protects. What the runner can promise is
  that it notices: one statfs per second while a command runs, and the job is
  stopped below the reserve with the numbers in its log. `--dir` on its own sized
  filesystem is the hard bound, and the docs say so.
- The runner unit gets `MemoryMax=90%` as the backstop under all of it, for a job
  that gets past its own cgroup. It is a percentage so the unit does not have to
  know the machine. TasksMax is deliberately not set: the container's own
  --container-pids already applies, and a unit value would have to track --jobs and
  --container-pids and would fail builds, looking like the workflow's fault, when
  they drifted apart.

A workflow still cannot raise or remove any of this: the limits are flags on the
runner and the unit, never fields a job can set.

scripts/check-deploy.py now fails when the rendered runner arguments stop carrying
the memory, pids, tmpfs or disk limits, so the first-boot file cannot quietly lose
them.

Closes 01M6S798BH0BK00R2B5N1KDJYM

scripts/check-deploy.py +11

@@ -46,6 +46,10 @@ SAMPLE = {
46 46 "runner_network": "bridge",
47 47 "runner_dir": "/var/lib/vole-runner",
48 48 "runner_jobs": "--jobs 2",
49 "runner_memory": "4G",
50 "runner_pids": "2048",
51 "runner_tmpfs": "1G",
52 "runner_disk_reserve": "2G",
49 53 "runner_labels": "--label linux --label amd64",
50 54 }
51 55
@@ -210,6 +214,13 @@ def check_runner_template(names):
210 214 bad |= fail("VOLE_RUNNER_ARGS does not carry the labels", where)
211 215 if SAMPLE["runner_jobs"] not in args[0]:
212 216 bad |= fail("VOLE_RUNNER_ARGS does not carry the job count", where)
217 # A runner built from this file must come up with finite limits. The container
218 # limits are the operator's settings, and a machine with none is one job away from
219 # being out of service for every repository it serves (#211).
220 for flag, value in (("--container-memory", "4G"), ("--container-pids", "2048"),
221 ("--container-tmpfs", "1G"), ("--disk-reserve", "2G")):
222 if f"{flag} {value}" not in args[0]:
223 bad |= fail(f"VOLE_RUNNER_ARGS does not set {flag}", where)
213 224
214 225 script = files.get("/usr/local/sbin/vole-runner-first-boot", {}).get("content", "")
215 226 for needed in ("install -m 0640 /opt/vole-runner/runner.env /etc/vole/runner.env",