diff --git a/forgejo-runner/README.adoc b/forgejo-runner/README.adoc index f999f7c..63b420d 100644 --- a/forgejo-runner/README.adoc +++ b/forgejo-runner/README.adoc @@ -16,6 +16,36 @@ image::https://img.shields.io/badge/AppVersion-3.4.1-informational?style=flat-sq | |=== +== Accessing docker socket inside job containers + +To access the docker socket inside the job containers, the following example +values may be used: + +[source,yaml] +---- +runner: + config: + create: true + existingSecret: "" + file: + log: + level: "info" + runner: + file: ".runner" + capacity: 1 + envs: + DOCKER_HOST: tcp://127.0.0.1:2376 + DOCKER_TLS_VERIFY: 1 + DOCKER_CERT_PATH: /certs/client + container: + network: host + enable_ipv6: false + privileged: false + options: -v /certs/client:/certs/client + valid_volumes: + - /certs/client +---- + == Usage Helm must be installed and setup to your kubernetes cluster to use the charts. @@ -43,7 +73,41 @@ helm uninstall forgejo-runner-release == Values -.Values +.Values Configuration yaml of runner (see: https://code.forgejo.org/forgejo/runner/src/branch/main/internal/pkg/config/config.example.yaml) +|=== +| Key | Type | Default | Description + +| runner.config.file.container.enable_ipv6 +| bool +| `false` +| Whether to create networks with IPv6 enabled. Requires the Docker daemon to be set up accordingly. Only takes effect if "network" is set to "". + +| runner.config.file.container.network +| string +| `"host"` +| Specifies the network to which the container will connect. Could be host, bridge or the name of a custom network. If it's empty, create a network automatically. + +| runner.config.file.log.level +| string +| `"info"` +| The level of logging, can be trace, debug, info, warn, error, fatal + +| runner.config.file.runner.capacity +| int +| `1` +| Execute how many tasks concurrently at the same time. + +| runner.config.file.runner.envs +| object +| `{"DOCKER_CERT_PATH":"/certs/client","DOCKER_HOST":"tcp://127.0.0.1:2376","DOCKER_TLS_VERIFY":1}` +| Extra environment variables to run jobs. + +| runner.config.file.runner.file +| string +| `".runner"` +| Runner config which contains id and token of this runner (autogenerate with create) +|=== +.Values Other Values |=== | Key | Type | Default | Description @@ -187,6 +251,21 @@ helm uninstall forgejo-runner-release | `""` | use existingSecret instatt +| runner.config.file.container.options +| string +| `"-v /certs/client:/certs/client"` +| + +| runner.config.file.container.privileged +| bool +| `false` +| + +| runner.config.file.container.valid_volumes[0] +| string +| `"/certs/client"` +| + | runner.config.instance | string | `"https://codeberg.org"` diff --git a/forgejo-runner/_docs.gotmpl b/forgejo-runner/_docs.gotmpl index e69de29..4650004 100644 --- a/forgejo-runner/_docs.gotmpl +++ b/forgejo-runner/_docs.gotmpl @@ -0,0 +1,14 @@ +{{ define "chart.prerequirements" -}} += Accessing docker socket inside job containers + +To access the docker socket inside the job containers, the following example +values may be used: + +[source,yaml] +---- +{{ .Files.Get "values-dind-bypass.yaml" }} +---- + +==== +{{ end }} +