personal_infra/ansible/roles/forgejo_runner/templates/forgejo-dind.service.j2

53 lines
2.4 KiB
Text
Raw Permalink Normal View History

forgejo-runner: give CI jobs a Docker daemon of their own jar-lid-archive's CI needs `docker build` and `docker compose`, and job containers had no Docker at all: config.yml carried the stock `container.docker_host: "-"`, which is precisely "find a daemon for the runner and do not let jobs near it". A docker:dind sidecar now runs on forgejo-runner-box, published on 127.0.0.1 only, and jobs build against that instead of the host daemon. Following Forgejo's own admin docs, which make the point that this is THREE settings and not one: forgejo-dind.service a privileged docker:dind on the host daemon container.docker_host tcp://127.0.0.1:2376 - where the runner CREATES job containers runner.envs.DOCKER_HOST + tcp://forgejo-dind.docker.internal:2375 - container.options how a job, from INSIDE dind, reaches it The third is the one that is easy to miss and fails identically to having done nothing: for a tcp:// docker_host the runner mounts nothing into the job container, so the job still finds no daemon. The two addresses differ because they are used from different places - the runner is a process on the host; a job container is inside dind, where 127.0.0.1 is itself. `host-gateway` is expanded by the daemon creating the container, which is dind, so it lands on dind's own bridge gateway. Verified on the box, along the exact path a job takes - a container on a user-defined network, with the same --add-host and DOCKER_HOST the runner will set: the name resolves to 172.20.0.1, `docker version` returns the dind server, and `docker build` succeeds. The host daemon runs forgejo-dind and nothing else. config.yml had to become a template to do any of this. It was previously `generate-config` run once on first deploy and never touched again, so the repo had no say in its contents. Every value was transcribed from the live file and diffed against it key by key: with dind disabled, 30 of 30 identical. Two deliberate differences - runner.envs drops A_TEST_ENV_NAME_1/2, upstream's placeholders, which were being injected into every job here; and the upstream comment blob is gone. Because the file is managed now it also gets a restart handler, the absence of which has bitten this repo before. Things deliberately chosen rather than defaulted into: - the flag lives in the playbook, not the role defaults, so the role's default stays the configuration this host has always run and turning it off is one line. Disabling it also tears the units down rather than just skipping them. - dind is a hard Requires= of forgejo-runner, and its unit stays in "activating" until the daemon answers. A dead dind is then one red unit instead of a green runner failing every job it claims. - the healthcheck and monitored_services learned about dind for the same reason: runner up + dind down is the interesting failure and it was previously invisible. - /var/lib/docker is a named volume, or every image is re-pulled on each container recreation; a weekly prune keeps that from growing forever. - dind's network pool is pinned to 172.20.0.0/14. Docker's stock pool reaches into 192.168.x, and act_runner creates a network per job, so a job could eventually allocate this LAN's subnet and lose the route to every box on it. Note this runner is SHARED - arbret, arbret-biz, arbretdos and arbret-ops build here too, far more often, and docker_host is per-runner not per-repo. Their workflows are unchanged but their next run pulls images into a cold cache. Job images still need a docker client of their own: node:{20,22}-bookworm ship none. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-27 22:32:08 +02:00
# MANAGED BY ANSIBLE - roles/forgejo_runner
#
# The isolated Docker daemon that Forgejo Actions jobs use. It runs ON this
# host's daemon but is a separate daemon: nothing a workflow does here can see
# or touch the host's containers, images or volumes.
[Unit]
Description=Docker-in-Docker daemon for Forgejo Actions jobs
Documentation=https://forgejo.org/docs/latest/admin/actions/docker-access/
After=docker.service
Requires=docker.service
[Service]
Type=simple
Restart=always
RestartSec=10
# dind pulls its image on first start and initialises /var/lib/docker; neither
# is fast on a cold volume, and a deadline here would just flap it.
TimeoutStartSec=0
# A container left behind by a hard kill would make `docker run --name` fail.
# Leading "-" so a clean start is not an error.
ExecStartPre=-/usr/bin/docker rm -f {{ forgejo_runner_dind_container }}
ExecStart=/usr/bin/docker run --rm --name {{ forgejo_runner_dind_container }} \
--privileged \
--publish {{ forgejo_runner_dind_bind_address }}:{{ forgejo_runner_dind_host_port }}:{{ forgejo_runner_dind_container_port }} \
--volume {{ forgejo_runner_dind_volume }}:/var/lib/docker \
--env DOCKER_TLS_CERTDIR= \
{{ forgejo_runner_dind_image }} \
dockerd \
--host=tcp://0.0.0.0:{{ forgejo_runner_dind_container_port }} \
--host=unix:///var/run/docker.sock \
--default-address-pool base={{ forgejo_runner_dind_address_pool }},size={{ forgejo_runner_dind_address_pool_size }}
# Hold the unit in "activating" until the daemon actually answers, so that
# forgejo-runner.service - which Requires= and After= this one - is never
# started against a socket that is not up yet. The runner does not retry: with
# an explicit container.docker_host it fails the connection and the job with it.
#
# Bounded by `timeout` rather than a counting loop, so a dind that never comes
# up FAILS this unit instead of hanging the boot. That is also the thing that
# catches a bad dockerd flag: the container exits, this never answers, and the
# unit goes red rather than the runner quietly losing Docker.
ExecStartPost=/usr/bin/timeout {{ forgejo_runner_dind_ready_timeout }} /bin/sh -c 'until /usr/bin/docker -H tcp://{{ forgejo_runner_dind_bind_address }}:{{ forgejo_runner_dind_host_port }} version >/dev/null 2>&1; do sleep 1; done'
ExecStop=/usr/bin/docker stop --time 30 {{ forgejo_runner_dind_container }}
StandardOutput=journal
StandardError=journal
[Install]
WantedBy=multi-user.target