Базовая настройка раннера

2025-04-08 11:30:37 +08:00
parent 8de39dbee3
commit 469109aa35
4 changed files with 183 additions and 11 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,10 @@
 /gitea/*.ini
 /gitea/data/
+
+/runner/*.yaml
+/runner/.runner
+/runner/data/
+
 /opengist/*.yml
 /opengist/data/

--- a/README.md
+++ b/README.md
@@ -16,22 +16,26 @@
 2. Выполнить `cp .env.example .env` и указать корректные данные для подключения
 3. Перенос Gitea:
   1. Потушить сервис (не сервер)
-   2. Конфиг скопировать в `./gitea/app.ini` и скорректировать по необходимости
+   2. Скопировать существующий конфиг в `./gitea/app.ini` и скорректировать по необходимости
   3. Снять дамп mysql и положить в `./gitea/dump.sql.gz`
   4. Директории с данными скопировать в `./gitea/data`
-4. Перенос OpenGist:
+4. Перенос Gitea Runner:
+    * Скопировать старый конфиг в `./runner/config.yaml` и скорректировать по необходимости  
+      ИЛИ  
+    * Выполнить `cp ./runner/config.example.yaml ./runner/config.yaml` и скорректировать по необходимости
+5. Перенос OpenGist:
   1. Потушить сервис (не сервер)
-   2. Конфиг скопировать в `./opengist/opengist.yml` и скорректировать по необходимости
+   2. Скопировать существующий конфиг скопировать в `./opengist/opengist.yml` и скорректировать по необходимости
   3. Снять дамп mysql и положить в `./opengist/dump.sql.gz`
   4. Директории с данными скопировать в `./opengist/data`
-5. Убедиться, что владельцем `./` является юзер с `UID`=`1000`, если не -- `cd ..; chown -R 1000:1000 gitea; cd -`
-6. Запустить через `docker compose up -d --build`
-7. Проверить логи через `docker logs -f ...`
-8. Проверить веб-морды через `curl -I localhost:...`
+6. Убедиться, что владельцем `./` является юзер с `UID`=`1000`, если не -- `cd ..; chown -R 1000:1000 gitea; cd -`
+7. Запустить через `docker compose up -d --build`
+8. Проверить логи через `docker logs -f ...`
+9. Проверить веб-морды через `curl -I localhost:...`

 Опционально, если есть домены:

-9.  Настроить nginx на хосте как реверс-прокси из внешки в контейнеры:  
+10.  Настроить nginx на хосте как реверс-прокси из внешки в контейнеры:  
    (поменять `server_name` и порты на свои)
    1. `/etc/nginx/sites-available/gitea.conf`
    ```
@@ -72,9 +76,9 @@
    unlink /etc/nginx/sites-enabled/default
    systemctl restart nginx
    ```
-10. Переключить DNS на новый IP
-11. Проверить веб-морды по доменам через `curl -i ...`
-12. Настроить SSL через `certbot`
+11. Переключить DNS на новый IP
+12. Проверить веб-морды по доменам через `curl -i ...`
+13. Настроить SSL через `certbot`

 ## Для деплоя с нуля

@@ -98,3 +102,50 @@
    ```

 4. Перезапустить демона через `systemctl restart sshd`
+
+## Настройка Gitea Actions (runner)
+
+При использовании Gitea версии ниже 1.21.0, необходимо в `./gitea/app.ini` добавить строчки:
+
+```ini
+[actions]
+ENABLED=true
+```
+
+Для начала нужно запустить всю среду.
+
+Чтобы раннер заработал, его нужно зарегистрировать в Gitea с помощью токена регистрации.
+Они могу быть разными.
+Получить его можно с помощью мануалов:
+* https://docs.gitea.com/usage/actions/quickstart
+* https://docs.gitea.com/usage/actions/act-runner#register-the-runner
+
+Базово, для создания глобального раннера, нужно зайти в [список раннеров](http://localhost:8080/-/admin/actions/runners) и найти кнопку в правом верхнем углу.
+
+Токен из этого поля нужно скопировать в файл [`.env`](.env) в переменную `RUNNER_REG_TOKEN` и перезапустить контейнер `gitea-runner` или всю среду по желанию.
+
+В логах раннера должны быть подобные строчки:
+
+```
+level=info msg="Registering runner, arch=amd64, os=linux, version=v0.2.11."
+level=debug msg="Successfully pinged the Gitea instance server"
+level=info msg="Runner registered successfully."
+SUCCESS
+time="2025-04-08T02:14:17Z" level=info msg="Starting runner daemon"
+time="2025-04-08T02:14:17Z" level=info msg="runner: gitea-runner, with version: v0.2.11, with labels: [ubuntu-latest ubuntu-22.04 ubuntu-20.04], declare successfully"
+```
+
+В списке раннеров по ссылке выше должен отобразиться `gitea-runner` зелёном статусе "Простаивает".
+
+Если во время выполнения экшена `actions/checkout@v4` возникает ошибка `Could not resolve host`, то в конфиге `./runner/config.yaml` надо указать имя сети:
+
+```yaml
+#...
+container:
+  network: "gitea_network"
+#...
+```
+
+Доп. информация:
+* https://docs.gitea.com/usage/actions/quickstart
+* https://docs.gitea.com/usage/actions/act-runner#start-the-runner-using-docker-compose
--- a/compose.yml
+++ b/compose.yml
@@ -36,6 +36,21 @@ services:
    depends_on:
      - gitea-db

+  gitea-runner:
+    <<: *common-attributes
+    container_name: gitea-runner
+    image: docker.io/gitea/act_runner:latest
+    environment:
+      CONFIG_FILE: /config.yaml
+      GITEA_INSTANCE_URL: http://gitea:3000
+      GITEA_RUNNER_REGISTRATION_TOKEN: ${RUNNER_REG_TOKEN}
+      GITEA_RUNNER_NAME: gitea-runner
+      # GITEA_RUNNER_LABELS: ${RUNNER_LABELS}
+    volumes:
+      - ./runner/config.yaml:/config.yaml
+      - ./runner/data:/data
+      - /var/run/docker.sock:/var/run/docker.sock
+
  gitea-db:
    <<: *common-attributes
    container_name: gitea-db
--- a/runner/config.example.yaml
+++ b/runner/config.example.yaml
@@ -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: ""
+  # 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, 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: