mirror of
https://gitea.com/gitea/helm-actions.git
synced 2025-10-21 15:08:14 +00:00
6ad4d5cee6
<!-- Before you open the request please review the following guidelines and tips to help it be more easily integrated: - Describe the scope of your change - i.e. what the change does. - Describe any known limitations with your change. - Please run any tests or examples that can exercise your modified code. Thank you for contributing! We will try to review, test and integrate the change as soon as we can. --> ### Description of the change <!-- Describe the scope of your change - i.e. what the change does. --> This patch adds a new configuration option, statefulset.actRunner.extraEnvs, to the Gitea act runner Helm chart. This new parameter is an array that allows users to define custom environment variables for the act-runner container within the StatefulSet. ### Benefits <!-- What benefits will be realized by the code change? --> Enables users of the chart to specify additional environment variables for the act-runner container. This can be useful for cases where a user may want to customize the act-runner via environment variables. ### Possible drawbacks <!-- Describe any known limitations with your change --> ### Applicable issues <!-- Enter any applicable Issues here (You can reference an issue using #). Please remove this section if there is no referenced issue. --> - Fixes # ### Additional information <!-- If there's anything else that's important and relevant to your pull request, mention that information here. Please remove this section if it remains empty. --> ### ⚠ BREAKING <!-- If there's a breaking change, please shortly describe in which way users are affected and how they can mitigate it. If there are no breakings, please remove this section. --> ### Checklist <!-- [Place an '[X]' (no spaces) in all applicable fields. Please remove unrelated fields.] --> - [X] Parameters are documented in the `values.yaml` and added to the `README.md` using [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm) - [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/63 Reviewed-by: DaanSelen <daanselen@noreply.gitea.com> Co-authored-by: Stephen Sullivan <sjsullivan7@gmail.com> Co-committed-by: Stephen Sullivan <sjsullivan7@gmail.com>
99 lines
10 KiB
Markdown
99 lines
10 KiB
Markdown
# Gitea Actions Helm Chart
|
|
|
|
This helm chart serves as the way to deploy the Gitea [act-runners](https://gitea.com/gitea/act_runner) 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](https://gitea.com/gitea/helm-actions/issues).
|
|
|
|
## Docs
|
|
|
|
[Docs](./docs/README.md)
|
|
|
|
## 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:
|
|
|
|
```sh
|
|
helm repo add gitea-charts https://dl.gitea.com/charts/
|
|
helm repo update
|
|
```
|
|
|
|
Then pull the values.yaml file and fill it accordingly.
|
|
|
|
```sh
|
|
helm show values gitea-charts/actions > values.yaml
|
|
```
|
|
|
|
Deploy with your values, make sure the path is correct:
|
|
|
|
```sh
|
|
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](https://docs.gitea.com/usage/actions/act-runner#configuration) for details. | `Too complex. See values.yaml` |
|
|
| `statefulset.dind.registry` | image registry, e.g. gcr.io,docker.io | `""` |
|
|
| `statefulset.actRunner.extraEnvs` | Allows adding custom environment variables | `[]` |
|
|
| `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 | `""` |
|