From fb8aa899e76f1a95d2b30045a46cb5faa4cc6712 Mon Sep 17 00:00:00 2001 From: Marc Cataford Date: Fri, 29 Mar 2024 20:05:29 -0400 Subject: [PATCH] feat(forge): add actions runner --- services/code-forge/README.md | 9 +++- services/code-forge/config.yml | 84 ++++++++++++++++++++++++++++++++++ services/code-forge/start.sh | 31 ++++++++++++- 3 files changed, 121 insertions(+), 3 deletions(-) create mode 100644 services/code-forge/config.yml diff --git a/services/code-forge/README.md b/services/code-forge/README.md index b6a0ebe..98c26ee 100644 --- a/services/code-forge/README.md +++ b/services/code-forge/README.md @@ -7,10 +7,15 @@ Forgejo instance serving https://forge.karnov.club. ### Starting / restarting ```bash -FORGEJO_ROOT= ./start.sh +FORGEJO_ROOT=.. FORGEJO_RUNNER_ROOT=... FORGEJO_RUNNER_CONFIG=... ./start.sh ``` -The storage root should be readable+writable by the user within the container. +`FORGEJO_ROOT` should be a directory with read+write access by the container user, this is where application data will +get stored. + +`FORGEJO_RUNNER_ROOT` should also be read+write accessible and will be where the runner stores data. + +`FORGEJO_RUNNER_CONFIG` should point to the runner configuration YAML file. If undefined, the default included with the scripts is used. Calling the `start.sh` script will replace the containers if they already exists. diff --git a/services/code-forge/config.yml b/services/code-forge/config.yml new file mode 100644 index 0000000..16d3ae6 --- /dev/null +++ b/services/code-forge/config.yml @@ -0,0 +1,84 @@ +log: + level: info + +runner: + file: .runner + # Execute how many tasks concurrently at the same time. + capacity: 1 + # Extra environment variables to run jobs. + envs: + CI: 1 + # Extra environment variables to run jobs from a file. + # It will be ignored if it's empty or the file doesn't exist. + env_file: .env + # The timeout for a job to be finished. + # Please note that the Forgejo instance also has a timeout (3h by default) for the job. + # So the job could be stopped by the Forgejo instance if it's timeout is shorter than this. + timeout: 10m + # Whether skip verifying the TLS certificate of the Forgejo instance. + insecure: false + # The timeout for fetching the job from the Forgejo instance. + fetch_timeout: 5s + # The interval for fetching the job from the Forgejo instance. + fetch_interval: 2s + # The labels of a runner are used to determine which jobs the runner can run, and how to run them. + # Like: ["macos-arm64:host", "ubuntu-latest:docker://node:16-bullseye", "ubuntu-22.04:docker://node:16-bullseye"] + # If it's empty when registering, it will ask for inputting labels. + # If it's empty when execute `deamon`, will use labels in `.runner` file. + labels: [] + +cache: + # Enable cache server to use actions/cache. + enabled: true + # The directory to store the cache data. + # If it's empty, the cache data will be stored in $HOME/.cache/actcache. + dir: "" + # The host of the cache server. + # It's not for the address to listen, but the address to connect from job containers. + # So 0.0.0.0 is a bad choice, leave it empty to detect automatically. + host: "" + # The port of the cache server. + # 0 means to use a random available port. + port: 0 + # The external cache server URL. Valid only when enable is true. + # If it's specified, act_runner will use this URL as the ACTIONS_CACHE_URL rather than start a server by itself. + # The URL should generally end with "/". + external_server: "" + +container: + # 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. + network: "" + # Whether to create networks with IPv6 enabled. Requires the Docker daemon to be set up accordingly. + # Only takes effect if "network" is set to "". + enable_ipv6: false + # Whether to use privileged mode or not when launching task containers (privileged mode is required for Docker-in-Docker). + privileged: false + # And other options to be used when the container is started (eg, --add-host=my.forgejo.url:host-gateway). + options: + # The parent directory of a job's working directory. + # If it's empty, /workspace will be used. + workdir_parent: + # Volumes (including bind mounts) can be mounted to containers. Glob syntax is supported, see https://github.com/gobwas/glob + # You can specify multiple volumes. If the sequence is empty, no volumes can be mounted. + # For example, if you only allow containers to mount the `data` volume and all the json files in `/src`, you should change the config to: + # valid_volumes: + # - data + # - /src/*.json + # If you want to allow any volume, please use the following configuration: + # valid_volumes: + # - '**' + valid_volumes: [] + # overrides the docker client host with the specified one. + # If it's empty, act_runner will find an available docker host automatically. + # If it's "-", act_runner will find an available docker host automatically, but the docker host won't be mounted to the job containers and service containers. + # If it's not empty or "-", the specified docker host will be used. An error will be returned if it doesn't work. + docker_host: "" + # Pull docker image(s) even if already present + force_pull: false + +host: + # The parent directory of a job's working directory. + # If it's empty, $HOME/.cache/act/ will be used. + workdir_parent: diff --git a/services/code-forge/start.sh b/services/code-forge/start.sh index caa1b2f..d6bb93f 100755 --- a/services/code-forge/start.sh +++ b/services/code-forge/start.sh @@ -5,12 +5,22 @@ if [[ -z "$FORGEJO_ROOT" ]]; then exit 1 fi +if [[ -z "$FORGEJO_RUNNER_ROOT" ]]; then + echo "Error: FORGEJO_RUNNER_ROOT must be defined in the environment." + exit 1 +fi + +if [[ -z "$FORGEJO_RUNNER_CONFIG" ]]; then + echo "Using the default runner configuration." +fi + podman pod create \ -p 3000:3000 \ --replace \ "code-forge" -podman run -itd \ +podman run \ + -td \ --name "code-forge_app" \ --pod "code-forge" \ -v "$FORGEJO_ROOT"/data:/var/lib/gitea \ @@ -19,3 +29,22 @@ podman run -itd \ -v /etc/localtime:/etc/localtime:ro \ --replace \ codeberg.org/forgejo/forgejo:1.21.8-0-rootless + +# The runners require the app to be healthy before startup. +response="" +until [[ $response = *"200 OK"* ]]; do + response="$(curl localhost:3000 -s -i | head -1)" + echo "Waiting for app to respond..." +done + +podman run \ + --pod "code-forge" \ + --user root \ + -td \ + --name "code-forge_runner" \ + --pod "code-forge" \ + -v "$FORGEJO_RUNNER_ROOT":/data \ + -v "${FORGEJO_RUNNER_CONFIG:=./config.yml}":/data/config.yml \ + -v "$XDG_RUNTIME_DIR"/podman/podman.sock:/var/run/docker.sock \ + code.forgejo.org/forgejo/runner:3.3.0 \ + forgejo-runner --config config.yml daemon