130b9f1877
Added environment variable `RUNNER_STATE_FILE` to let users specify where `run.sh` looks for the runner JSON file. Defaults to ``.runner`` to preserve the original behavior. Addresses issue #368. It's not my preferred solution but it's the least invasive one I can think of. I'm happy to make any changes you want. I didn't see an appropriate place to reference the change in the documentation. I will add documentation wherever you think is appropriate. To test this I did the following: * Built an image with the `make docker` command and pushed it to my private registry. * Added that private image as the image in my existing docker stack that was exhibiting the behavior described in #368. * Added the RUNNER_STATE_FILE environment variable pointing to the runner JSON file set in my `config.yml` (``/data/runner.json`` in this case). * Configured a new runner in gitea and added the token as an environment variable in the stack config. * Deployed the stack and verified the new runner was recognized (in the idle state). * Force updated the runner service to restart the container. * Verified the same runner was still recognized in gitea (in the idle state) once it was back up and running. Here is the relevant config. It's stored as a template so I've left the things that would normally be redacted as they are in the template. ``` runner: image: hub.hax.in.net/haxwithaxe/act_runner:dev1 networks: - swarm-net environment: RUNNER_STATE_FILE: /data/runner.json CONFIG_FILE: /data/config.yml GITEA_INSTANCE_URL: "https://git_gitea" GITEA_RUNNER_REGISTRATION_TOKEN: "{{ git_runner_reg_token }}" GITEA_RUNNER_NAME: "git_runner" volumes: - runner_data:/data - /var/run/docker.sock:/var/run/docker.sock ``` `runner_data` is a glusterfs subvolume Thanks for creating this gitea specific fork. Apart from the issue this pull request addresses it works so well I don't have to think about it once it's set up. Co-authored-by: haxwithaxe <spam@haxwithaxe.net> Reviewed-on: https://gitea.com/gitea/act_runner/pulls/377 Co-authored-by: haxwithaxe <haxwithaxe@noreply.gitea.com> Co-committed-by: haxwithaxe <haxwithaxe@noreply.gitea.com>
act runner
Act runner is a runner for Gitea based on Gitea fork of act.
Installation
Prerequisites
Docker Engine Community version is required for docker mode. To install Docker CE, follow the official install instructions.
Download pre-built binary
Visit here and download the right version for your platform.
Build from source
make build
Build a docker image
make docker
Quickstart
Actions are disabled by default, so you need to add the following to the configuration file of your Gitea instance to enable it:
[actions]
ENABLED=true
Register
./act_runner register
And you will be asked to input:
- Gitea instance URL, like
http://192.168.8.8:3000/. You should use your gitea instance ROOT_URL as the instance argument and you should not uselocalhostor127.0.0.1as instance IP; - Runner token, you can get it from
http://192.168.8.8:3000/admin/actions/runners; - Runner name, you can just leave it blank;
- Runner labels, you can just leave it blank.
The process looks like:
INFO Registering runner, arch=amd64, os=darwin, version=0.1.5.
WARN Runner in user-mode.
INFO Enter the Gitea instance URL (for example, https://gitea.com/):
http://192.168.8.8:3000/
INFO Enter the runner token:
fe884e8027dc292970d4e0303fe82b14xxxxxxxx
INFO Enter the runner name (if set empty, use hostname: Test.local):
INFO Enter the runner labels, leave blank to use the default labels (comma-separated, for example, ubuntu-20.04:docker://node:16-bullseye,ubuntu-18.04:docker://node:16-buster,linux_arm:host):
INFO Registering runner, name=Test.local, instance=http://192.168.8.8:3000/, labels=[ubuntu-latest:docker://node:16-bullseye ubuntu-22.04:docker://node:16-bullseye ubuntu-20.04:docker://node:16-bullseye ubuntu-18.04:docker://node:16-buster].
DEBU Successfully pinged the Gitea instance server
INFO Runner registered successfully.
You can also register with command line arguments.
./act_runner register --instance http://192.168.8.8:3000 --token <my_runner_token> --no-interactive
If the registry succeed, it will run immediately. Next time, you could run the runner directly.
Run
./act_runner daemon
Run with docker
docker run -e GITEA_INSTANCE_URL=https://your_gitea.com -e GITEA_RUNNER_REGISTRATION_TOKEN=<your_token> -v /var/run/docker.sock:/var/run/docker.sock --name my_runner gitea/act_runner:nightly
Configuration
You can also configure the runner with a configuration file.
The configuration file is a YAML file, you can generate a sample configuration file with ./act_runner generate-config.
./act_runner generate-config > config.yaml
You can specify the configuration file path with -c/--config argument.
./act_runner -c config.yaml register # register with config file
./act_runner -c config.yaml daemon # run with config file
Example Deployments
Check out the examples directory for sample deployment types.
Copyright (c) 2022 The Gitea Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.