-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from fribyte-code/guffen
Added guffen documentation and updated network overview
- Loading branch information
Showing
2 changed files
with
62 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
+++ | ||
title = "Github runner" | ||
description = "Guffen self-hosted github actions runner" | ||
date = 2024-05-07 | ||
updated = 2024-05-07 | ||
template = "docs/page.html" | ||
sort_by = "weight" | ||
weight = 3 | ||
+++ | ||
|
||
Guffen er en VM på gjertrud satt opp til å kjøre github actions tasks. | ||
|
||
## Oppsett | ||
Runneren er satt opp på [metoden oppgitt av GitHub](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository) | ||
|
||
Startskriptet for programmet ligger i `/home/fribyte/actions-runner/run.sh` | ||
|
||
### Systemd service | ||
For at programmet skal kjøre i bakgrunnen og starte av seg selv er det opprettet en systemd service som ligger i `/home/fribyte/.config/systemd/user/actions-runner.service`: | ||
|
||
``` | ||
[Unit] | ||
Description=Github actions runner | ||
After=network.target | ||
[Service] | ||
ExecStart=/bin/bash /home/fribyte/actions-runner/run.sh | ||
Type=notify-reload | ||
Restart=always | ||
[Install] | ||
WantedBy=default.target | ||
``` | ||
|
||
Følgende kommando kan brukes for *enable/start/stop* av servicen: | ||
```bash | ||
systemctl --user enable actions-runner.service | ||
``` | ||
|
||
## Bruk | ||
For at runneren skal brukes for å kjøre actions må man sette *runs-on* til self-hosted i actions filen. | ||
|
||
f.eks: | ||
```yaml | ||
jobs: | ||
push_to_registry: | ||
name: Push Docker image to Docker Hub | ||
runs-on: self-hosted | ||
``` | ||
Hvis actions scriptet inneholder et docker build step kreves ogsa følgende som et step før byggingen i filen. | ||
```yaml | ||
- name: Set up Docker Buildx | ||
uses: docker/setup-buildx-action@v3 | ||
``` | ||
## Sikkerhet | ||
Med bruken av en self hosted runner inngår det også visse regler man burde opprettholde for å unngå brudd på sikkerheten. Dette er fordi runneren kjører arbitrær kode som i teorien kan unnslippe sandbox miljøet. For å unngå slike situasjoner anbefales det å kun tillate actions scripts i offentlige repositories å kjøre på en godkjent merge med main branch. | ||
For fremtidig referanse se [GitHub runner sikkerhets dokumentasjon](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security). |