From 6d82ade984ffce5ba7168880edb2a9794f7dae62 Mon Sep 17 00:00:00 2001 From: Christopher Homberger Date: Wed, 27 Aug 2025 05:38:01 +0000 Subject: [PATCH] chore(docs): add job container dind docs (#44) Reviewed-on: https://gitea.com/gitea/helm-actions/pulls/44 Reviewed-by: DaanSelen Reviewed-by: Lunny Xiao Reviewed-by: Markus Pesch Co-authored-by: Christopher Homberger Co-committed-by: Christopher Homberger --- README.md | 4 +++ docs/README.md | 3 +++ docs/share-dind-with-job-container.md | 36 +++++++++++++++++++++++++++ 3 files changed, 43 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/share-dind-with-job-container.md diff --git a/README.md b/README.md index f2fe5ee..0f75d49 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ The parameters which can be used to customize the deployment are described below 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: diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..891006f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,3 @@ +# Gitea Actions Helm Chart Docs + +- [Share dind with job container](share-dind-with-job-container.md) \ No newline at end of file diff --git a/docs/share-dind-with-job-container.md b/docs/share-dind-with-job-container.md new file mode 100644 index 0000000..57cd949 --- /dev/null +++ b/docs/share-dind-with-job-container.md @@ -0,0 +1,36 @@ +# Share dind with job container + +You can weaken isolation and allow jobs to call docker commands. + +## Limitations + +- Docker bind mounts like `-v /path/on/self/container:/path/to/new/container` do not work, because they are going to mount the path from the dind container +- Docker port expose to local host `-e 80:8080` is not going to work + +## Example Values + +```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" +``` + +Now you can run docker commands inside your jobs. \ No newline at end of file