补充文件
This commit is contained in:
63
giteaRunner/README.md
Normal file
63
giteaRunner/README.md
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
# Gitea Runner 配置说明
|
||||||
|
|
||||||
|
## 项目简介
|
||||||
|
|
||||||
|
这是一个用于配置和运行 Gitea Runner 的 Docker Compose 项目。Gitea Runner 是 Gitea 的 CI/CD 执行器,用于运行 Gitea Actions 工作流程,runner不够用时,可以在公司电脑本地部署,提高效率。
|
||||||
|
|
||||||
|
## 配置说明
|
||||||
|
|
||||||
|
### 必要配置项
|
||||||
|
|
||||||
|
在使用之前,需要修改 `docker-compose.yml` 中的以下配置项:
|
||||||
|
|
||||||
|
1. `GITEA_RUNNER_REGISTRATION_TOKEN`:
|
||||||
|
- 这是您的 Gitea 账号的 registration token
|
||||||
|
- 获取方法:
|
||||||
|
1. 登录您的 Gitea 实例
|
||||||
|
2. 进入设置页面
|
||||||
|
3. 在左侧菜单找到 Actions
|
||||||
|
4. 点击「创建 Runner」获取 token
|
||||||
|
|
||||||
|
2. `GITEA_RUNNER_NAME`:
|
||||||
|
- 设置 Runner 的名称
|
||||||
|
- 建议使用有意义的名称,方便识别(如:team-dev-runner)
|
||||||
|
|
||||||
|
### 其他重要配置
|
||||||
|
|
||||||
|
- `GITEA_INSTANCE_URL`:Gitea 实例的 URL
|
||||||
|
- `DOCKER_HOST`:Docker 套接字路径,用于 Docker in Docker 功能
|
||||||
|
- 端口映射:9010 端口用于 Actions 缓存服务
|
||||||
|
|
||||||
|
## 使用方法
|
||||||
|
|
||||||
|
1. 克隆此项目到本地
|
||||||
|
2. 修改上述必要配置项
|
||||||
|
3. 在项目目录下运行:
|
||||||
|
```bash
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
./
|
||||||
|
├── config.yaml # Runner 详细配置文件
|
||||||
|
├── docker-compose.yml # Docker 编排配置文件
|
||||||
|
└── data/ # Runner 数据目录
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. Runner 需要特权模式运行,因为需要支持 Docker in Docker 功能
|
||||||
|
2. 确保 Docker 套接字正确挂载
|
||||||
|
3. 首次启动时会自动注册 Runner 到您的 Gitea 实例
|
||||||
|
4. 默认支持 ubuntu-latest 等多个运行环境
|
||||||
|
|
||||||
|
## 支持的运行环境
|
||||||
|
|
||||||
|
默认支持以下运行环境:
|
||||||
|
- ubuntu-latest
|
||||||
|
- ubuntu-22.04
|
||||||
|
- ubuntu-20.04
|
||||||
|
|
||||||
|
可以在 `config.yaml` 中根据需要添加或修改支持的环境。
|
||||||
101
giteaRunner/config.yaml
Normal file
101
giteaRunner/config.yaml
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
# Example configuration file, it's safe to copy this as the default config file without any modification.
|
||||||
|
|
||||||
|
# You don't have to copy this file to your instance,
|
||||||
|
# just run `./act_runner generate-config > config.yaml` to generate a config file.
|
||||||
|
|
||||||
|
log:
|
||||||
|
# The level of logging, can be trace, debug, info, warn, error, fatal
|
||||||
|
level: info
|
||||||
|
|
||||||
|
runner:
|
||||||
|
# Where to store the registration result.
|
||||||
|
file: .runner
|
||||||
|
# Execute how many tasks concurrently at the same time.
|
||||||
|
capacity: 1
|
||||||
|
# Extra environment variables to run jobs.
|
||||||
|
envs:
|
||||||
|
A_TEST_ENV_NAME_1: a_test_env_value_1
|
||||||
|
A_TEST_ENV_NAME_2: a_test_env_value_2
|
||||||
|
# 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 Gitea instance also has a timeout (3h by default) for the job.
|
||||||
|
# So the job could be stopped by the Gitea instance if it's timeout is shorter than this.
|
||||||
|
timeout: 3h
|
||||||
|
# The timeout for the runner to wait for running jobs to finish when shutting down.
|
||||||
|
# Any running jobs that haven't finished after this timeout will be cancelled.
|
||||||
|
shutdown_timeout: 0s
|
||||||
|
# Whether skip verifying the TLS certificate of the Gitea instance.
|
||||||
|
insecure: false
|
||||||
|
# The timeout for fetching the job from the Gitea instance.
|
||||||
|
fetch_timeout: 5s
|
||||||
|
# The interval for fetching the job from the Gitea 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" or "ubuntu-latest:docker://gitea/runner-images:ubuntu-latest"
|
||||||
|
# Find more images provided by Gitea at https://gitea.com/gitea/runner-images .
|
||||||
|
# If it's empty when registering, it will ask for inputting labels.
|
||||||
|
# If it's empty when execute `daemon`, will use labels in `.runner` file.
|
||||||
|
labels:
|
||||||
|
- "ubuntu-latest:docker://gitea/runner-images:ubuntu-latest"
|
||||||
|
- "ubuntu-22.04:docker://gitea/runner-images:ubuntu-22.04"
|
||||||
|
- "ubuntu-20.04:docker://gitea/runner-images:ubuntu-20.04"
|
||||||
|
|
||||||
|
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: "/var/cache/gitea_runner"
|
||||||
|
# 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: "http://gcode.congshangyun.com/"
|
||||||
|
# The port of the cache server.
|
||||||
|
# 0 means to use a random available port.
|
||||||
|
# port: 9010
|
||||||
|
# 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, act_runner will create a network automatically.
|
||||||
|
network: ""
|
||||||
|
# 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.gitea.url:host-gateway).
|
||||||
|
options:
|
||||||
|
# The parent directory of a job's working directory.
|
||||||
|
# NOTE: There is no need to add the first '/' of the path as act_runner will add it automatically.
|
||||||
|
# If the path starts with '/', the '/' will be trimmed.
|
||||||
|
# For example, if the parent directory is /path/to/my/dir, workdir_parent should be path/to/my/dir
|
||||||
|
# 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: true
|
||||||
|
# Rebuild docker image(s) even if already present
|
||||||
|
force_rebuild: false
|
||||||
|
|
||||||
|
host:
|
||||||
|
# The parent directory of a job's working directory.
|
||||||
|
# If it's empty, $HOME/.cache/act/ will be used.
|
||||||
|
workdir_parent:
|
||||||
18
giteaRunner/docker-compose.yml
Normal file
18
giteaRunner/docker-compose.yml
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
services:
|
||||||
|
runner:
|
||||||
|
image: gitea/act_runner
|
||||||
|
restart: always
|
||||||
|
privileged: true
|
||||||
|
environment:
|
||||||
|
CONFIG_FILE: /config.yaml
|
||||||
|
GITEA_INSTANCE_URL: "https://code.congshangyun.com/"
|
||||||
|
GITEA_RUNNER_REGISTRATION_TOKEN: "你的gitea账号的registration token"
|
||||||
|
GITEA_RUNNER_NAME: "runner名称"
|
||||||
|
# GITEA_RUNNER_LABELS: "暂时不建议修改"
|
||||||
|
DOCKER_HOST: unix:///var/run/docker.sock # 这是docker的套接字,用于Docker in Docker
|
||||||
|
ports:
|
||||||
|
- 9010:9010 # 这里是映射缓存端口
|
||||||
|
volumes:
|
||||||
|
- ./config.yaml:/config.yaml
|
||||||
|
- ./data:/data
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
Reference in New Issue
Block a user