helm-charts/forgejo-runner/README.adoc

= forgejo-runner

image::https://img.shields.io/badge/Version-0.1.19-informational?style=flat-square[Version: 0.1.19]
image::https://img.shields.io/badge/Version-application-informational?style=flat-square[Type: application]
image::https://img.shields.io/badge/AppVersion-3.4.1-informational?style=flat-square[AppVersion: 3.4.1]
== Maintainers

.Maintainers
|===
| Name | Email | Url

| WrenIX
|
| <https://wrenix.eu>
|===

== 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.
Refer to Helm's https://helm.sh/docs[documentation] to get started.
Once Helm has been set up correctly, fetch the charts as follows:

[source,bash]
----
helm pull oci://codeberg.org/wrenix/helm-charts/forgejo-runner
----

You can install a chart release using the following command:

[source,bash]
----
helm install forgejo-runner-release oci://codeberg.org/wrenix/helm-charts/forgejo-runner --values values.yaml
----

To uninstall a chart release use `helm`'s delete command:

[source,bash]
----
helm uninstall forgejo-runner-release
----

== 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

| affinity
| object
| `{}`
|

| autoscaling.enabled
| bool
| `false`
|

| autoscaling.maxReplicas
| int
| `100`
|

| autoscaling.minReplicas
| int
| `1`
|

| autoscaling.targetCPUUtilizationPercentage
| int
| `80`
|

| dind.image.pullPolicy
| string
| `"IfNotPresent"`
|

| dind.image.registry
| string
| `"docker.io"`
|

| dind.image.repository
| string
| `"library/docker"`
|

| dind.image.tag
| string
| `"26.1.3-dind"`
|

| fullnameOverride
| string
| `""`
|

| image.pullPolicy
| string
| `"IfNotPresent"`
|

| image.registry
| string
| `"code.forgejo.org"`
|

| image.repository
| string
| `"forgejo/runner"`
|

| image.tag
| string
| `""`
|

| imagePullSecrets
| list
| `[]`
|

| kubectl.image.pullPolicy
| string
| `"IfNotPresent"`
|

| kubectl.image.registry
| string
| `"docker.io"`
|

| kubectl.image.repository
| string
| `"bitnami/kubectl"`
|

| kubectl.image.tag
| string
| `"1.30.1"`
|

| nameOverride
| string
| `""`
|

| nodeSelector
| object
| `{}`
|

| podAnnotations
| object
| `{}`
|

| podLabels
| object
| `{}`
|

| podSecurityContext
| object
| `{}`
|

| replicaCount
| int
| `1`
|

| resources
| object
| `{}`
|

| runner.config.create
| bool
| `true`
|

| runner.config.existingSecret
| string
| `""`
| 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"`
|

| runner.config.name
| string
| `nil`
|

| runner.config.token
| string
| `nil`
|

| securityContext.privileged
| bool
| `true`
|

| serviceAccount.annotations
| object
| `{}`
|

| serviceAccount.automount
| bool
| `true`
|

| serviceAccount.create
| bool
| `true`
|

| serviceAccount.name
| string
| `""`
|

| tolerations
| list
| `[]`
|

| volumeMounts
| list
| `[]`
|

| volumes
| list
| `[]`
|
|===

Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs]