Skip to content

Commit

Permalink
Merge pull request #11 from fribyte-code/guffen
Browse files Browse the repository at this point in the history
Added guffen documentation and updated network overview
  • Loading branch information
simsine authored May 9, 2024
2 parents ad2efa6 + 6a7de78 commit 4383b15
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 2 deletions.
4 changes: 2 additions & 2 deletions content/docs/nettverk/nettverk-oversikt.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ draft = false
| | 2001:700:201:1:5001::101 | lille-hjelper-1.fribyte.no | | Kubernetes agent node |
| | 2001:700:201:1:5001::102 | lille-hjelper-2.fribyte.no | | Kubernetes agent node |
| | 2001:700:201:1:5001::103 | lille-hjelper-3.fribyte.no | | Kubernetes agent node |
| 158.37.6.1 | | | | (ledig) |
| 158.37.6.1 | | guffen | | guffen self hosted actions runner |
| 158.37.6.2 | | | | (ledig) |
| 158.37.6.3 | | | | (ledig) |
| 158.37.6.4 | | wiki.fribyte.no | | Zola wiki (konrad) |
Expand All @@ -44,7 +44,7 @@ draft = false
| 158.37.6.10 | | dole.ss.uib.no | carp1 | Felles addresse |
| 158.37.6.11 | | klient.kvarteret.no | carp1 | Felles addresse |
| 158.37.6.12 | | Skaftetrynet.fribyte.no | | Proxmox node |
| 158.37.6.13 | | | | (ledig) |
| 158.37.6.13 | | rootlinjeforening.no | | (kunde) |
| 158.37.6.14 | | SUB-BSI.fribyte.no | | (kunde) |
| 158.37.6.15 | | geo.uib.no, geo.fribyte.no | | (ledig) |
| 158.37.6.16 | | srib-minecraft | | (kunde) (konrad) |
Expand Down
60 changes: 60 additions & 0 deletions content/docs/tjenester/guffen.md
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).

0 comments on commit 4383b15

Please sign in to comment.