Github runners

Docker image pro self-hosted github runnery. Kód převzat a upraven odtud.

Spuštění

• Před samotným spuštěním je potřeba získat ACCESS_TOKEN, který umožní se přihlásit přes API na Github a tím vytvořit registrační token, kterým se následně přidá do repozitáře samotný runner. Tento token potřebuje mít read & write administration role, aby se dostal k /actions/runners/registration-token
• Zkopírujte env.env.sample do env.env a doplňte jméno repozitáře, ke kterému se runner připojí (ve formátu <organizace>/<repo>, např. fykosak/fksdb).
• Spusťte build přes docker compose build.
• Spusťte runner přes docker compose up. Runner se automaticky spustí, zaregistruje se na github a připojí runnera do repozitáře.

Produkce

Každý runner může najednou zpracovávat pouze jeden task. Proto pokud chceme spouštět více úkolů paralelně, je potřeba vytvořit více runnerů. Kolik runnerů poběží lze nastavit přímo v docker-compose.yml přes sekci deploy, ve které je možné nastavit, kolik replikovaných kontejnerů poběží, případně jim lze nastavit limity na použité prostředky serveru.

Pokud je v úmyslu self-hosted runnera použít, je potřeba změnit v daném workflow runs-on na selfhosted, případně je možné použít různé labels.

Instalace potřebných nástrojů

Většina nástrojů by nejlépe měla být nainstalovaná v rámci samotného workflow, například přes actions/setup-* pro lepší management použitých verzí a reprodukovatelnost. To ovšem přináší tu nevýhodu, že pokud není nástroj dostupný na dané instanci runnera, je potřeba jej nejdřív nainstalovat, což může prodloužit čas potřebný na spuštění workflow. Jakmile se daný nástroj na dané instanci nainstaluje, je obvykle dostupný při dalších spuštěních a tedy potřebný čas na spuštění není tak zásadní. Bohužel ale není možnost, jak nainstalované věci spolehlivě cachovat, protože některé programy (například php) se nenainstalují do _work/_tool složky, ale přímo do souborového systému.

Možnost, jak tento problém obejít, je mít potřebné programy nainstalované již v runneru, bohužel se tím komplikuje správa potřebných programů a verzí a je potřeba aktualizovat seznam doinstalovaných nástrojů.