diff options
| author | Gabriel Simmer <g@gmem.ca> | 2023-08-17 11:43:07 +0200 |
|---|---|---|
| committer | Earl Warren <contact@earl-warren.org> | 2023-08-23 16:03:12 +0200 |
| commit | f82d6e49ca8ef3696b1d96d9ab33c5114bb27b32 (patch) | |
| tree | 46ea66a20231ab352059c14d5a2283ad738c1fb7 /examples | |
| parent | [FORGEJO] simplify Kubernetes examples with offline registration (diff) | |
| download | forgejo-runner-f82d6e49ca8ef3696b1d96d9ab33c5114bb27b32.tar.xz forgejo-runner-f82d6e49ca8ef3696b1d96d9ab33c5114bb27b32.zip | |
[FORGEJO] update Kubernetes example README
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/kubernetes/README.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/examples/kubernetes/README.md b/examples/kubernetes/README.md index 5427893..a8784b4 100644 --- a/examples/kubernetes/README.md +++ b/examples/kubernetes/README.md @@ -1,11 +1,13 @@ ## Kubernetes Docker in Docker Deployment with `act_runner` +Registers Kubernetes pod runners using [offline registration](https://forgejo.org/docs/v1.21/admin/actions/#offline-registration), allowing the scaling of runners as needed. + NOTE: Docker in Docker (dind) requires elevated privileges on Kubernetes. The current way to achieve this is to set the pod `SecurityContext` to `privileged`. Keep in mind that this is a potential security issue that has the potential for a malicious application to break out of the container context. Files in this directory: - [`dind-docker.yaml`](dind-docker.yaml) - How to create a Deployment and Persistent Volume for Kubernetes to act as a runner. The Docker credentials are re-generated each time the pod connects and does not need to be persisted. + How to create a Deployment and Secret for Kubernetes to act as a runner. The Docker credentials are re-generated each time the pod connects and does not need to be persisted. - [`rootless-docker.yaml`](rootless-docker.yaml) - How to create a rootless Deployment and Persistent Volume for Kubernetes to act as a runner. The Docker credentials are re-generated each time the pod connects and does not need to be persisted. + How to create a rootless Deployment and Secret for Kubernetes to act as a runner. The Docker credentials are re-generated each time the pod connects and does not need to be persisted. |