forked from Gitea/helm-actions
bd2fcb14be
### Description of the change
Allow to insert the act_runner config as yaml into the chart values.
### Benefits
Yaml editor will report yaml errors, instead of the deployed runner.
### Possible drawbacks
No limitations, string config works like before.
### Applicable issues
N/A
### Additional information
Usage like this, just omit the block scalar token
```yaml
enabled: true
statefulset:
actRunner:
# See full example here: https://gitea.com/gitea/act_runner/src/branch/main/internal/pkg/config/config.example.yaml
config:
log:
level: debug
cache:
enabled: false
container:
valid_volumes:
- /var/run/docker.sock
options: -v /var/run/docker.sock:/var/run/docker.sock
## Specify an existing token secret
##
existingSecret: "runner-token2"
existingSecretKey: "token"
## Specify the root URL of the Gitea instance
giteaRootURL: "http://192.168.1.2:3000"
```
I do not like the regex test approach, but I didn't come up with a better one. I wish that I can parse the nested yaml in the helm tests.
### ⚠ BREAKING
N/A
### Checklist
- [x] Helm templating unittests are added (required when changing anything in `templates` folder)
- [x] All added template resources MUST render a namespace in metadata
Reviewed-on: https://gitea.com/gitea/helm-actions/pulls/43
Reviewed-by: DaanSelen <daanselen@noreply.gitea.com>
Co-authored-by: Christopher Homberger <christopher.homberger@web.de>
Co-committed-by: Christopher Homberger <christopher.homberger@web.de>
Gitea Actions Helm Chart
This helm chart serves as the way to deploy the Gitea act-runners alongside a running Gitea instance.
It serves as a standalone chart and does not rely on Gitea to be present in the same environment, however it needs to be able to reach a Gitea instance to function.
The parameters which can be used to customize the deployment are described below, check those out if you want to see if something is supported.
If you want to propose a new feature or mechanism, submit an issue here.
Docs
Rootless Defaults
If .Values.image.rootless: true, then the following will occur. In case you use .Values.image.fullOverride, check that this works in your image:
- If
.Values.provisioning.enabled: true, then uses the rootless Gitea image, must match helm-Gitea.
Quick-start
To get started, add the Helm repo, assuming you have not already:
helm repo add gitea-charts https://dl.gitea.com/charts/
helm repo update
Then pull the values.yaml file and fill it accordingly.
helm show values gitea-charts/actions > values.yaml
Deploy with your values, make sure the path is correct:
helm upgrade --install gitea-actions gitea-charts/actions -f values.yaml
You should be good to go!
Parameters
Gitea Actions
| Name | Description | Value |
|---|---|---|
enabled |
Create an act runner StatefulSet. | false |
init.image.repository |
The image used for the init containers | busybox |
init.image.tag |
The image tag used for the init containers | 1.37.0 |
statefulset.replicas |
the amount of (replica) runner pods deployed | 1 |
statefulset.timezone |
is the timezone that will be set in the act_runner image | Etc/UTC |
statefulset.annotations |
Act runner annotations | {} |
statefulset.labels |
Act runner labels | {} |
statefulset.resources |
Act runner resources | {} |
statefulset.nodeSelector |
NodeSelector for the statefulset | {} |
statefulset.tolerations |
Tolerations for the statefulset | [] |
statefulset.affinity |
Affinity for the statefulset | {} |
statefulset.extraVolumes |
Extra volumes for the statefulset | [] |
statefulset.actRunner.registry |
image registry, e.g. gcr.io,docker.io | docker.gitea.com |
statefulset.actRunner.repository |
The Gitea act runner image | gitea/act_runner |
statefulset.actRunner.tag |
The Gitea act runner tag | 0.2.13 |
statefulset.actRunner.digest |
Image digest. Allows to pin the given image tag. Useful for having control over mutable tags like latest |
"" |
statefulset.actRunner.pullPolicy |
The Gitea act runner pullPolicy | IfNotPresent |
statefulset.actRunner.fullOverride |
Completely overrides the image registry, path/image, tag and digest. | "" |
statefulset.actRunner.extraVolumeMounts |
Allows mounting extra volumes in the act runner container | [] |
statefulset.actRunner.config |
Act runner custom configuration. See Act Runner documentation for details. | Too complex. See values.yaml |
statefulset.dind.registry |
image registry, e.g. gcr.io,docker.io | "" |
statefulset.dind.repository |
The Docker-in-Docker image | docker |
statefulset.dind.tag |
The Docker-in-Docker image tag | 28.3.3-dind |
statefulset.dind.digest |
Image digest. Allows to pin the given image tag. Useful for having control over mutable tags like latest |
"" |
statefulset.dind.fullOverride |
Completely overrides the image registry, path/image, tag and digest. | "" |
statefulset.dind.pullPolicy |
The Docker-in-Docker pullPolicy | IfNotPresent |
statefulset.dind.extraVolumeMounts |
Allows mounting extra volumes in the Docker-in-Docker container | [] |
statefulset.dind.extraEnvs |
Allows adding custom environment variables, such as DOCKER_IPTABLES_LEGACY |
[] |
statefulset.persistence.size |
Size for persistence to store act runner data | 1Gi |
existingSecret |
Secret that contains the token | "" |
existingSecretKey |
Secret key | "" |
giteaRootURL |
URL the act_runner registers and connect with | "" |
Gitea Actions Init
| Name | Description | Value |
|---|---|---|
init.image.registry |
image registry, e.g. gcr.io,docker.io | "" |
init.image.repository |
The init image | busybox |
init.image.tag |
the init image tag | 1.37.0 |
init.image.digest |
Image digest. Allows to pin the given image tag. Useful for having control over mutable tags like latest |
"" |
init.image.pullPolicy |
The init image pullPolicy | IfNotPresent |
init.image.fullOverride |
Completely overrides the image registry, path/image, tag and digest. | "" |
Global
| Name | Description | Value |
|---|---|---|
global.imageRegistry |
global image registry override | "" |
global.storageClass |
global storage class override | "" |