Установка и запуск агента GitFlic Runner c типом Docker

Посмотрите в таблице совместимости нужную вам версию агента и скачайте её с страницы релизов runner. Последняя версия runner доступна по ссылке.

Установка и регистрация агента

1. В корне домашней директории создайте директорию gitflic-runner

shell

mkdir $HOME/gitflic-runner

powershell

New-Item -ItemType Directory $env:USERPROFILE\gitflic-runner

2. Переместите или скопируйте файл runner.jar в директорию gitflic-runner созданную в п.1

shell

cp runner.jar $HOME/gitflic-runner

powershell

Copy-Item runner.jar $env:USERPROFILE\gitflic-runner

! Далее все команды выполняются из рабочей директории агента, созданной в п.1

2. Перейдите в веб интерфейс приложения GitFlic -> Панель администратора -> СI/CD

http(s)://<Адрес веб интерфейса>/admin/runners

* Для регистрации агента в сервисе GitFlic.ru перейдите в Настройки компании -> Агенты CI/CD

https://gitflic.ru/company/<company_name>/setting/cicd/runners

3. Скопируйте и сохраните URL и Token

4. Выполните команду регистрации

shell и powershell

java -jar runner.jar register --url <url> --registration-token <token>

Ключ	Обязательный	Описание
--url \<url>	да	Url скопированный в п.3
--registration-token \<token> или --token \<token>	да	Token скопированный в п.3
--name \<name>	нет	Название агента
--tags \<tags>	нет	Теги агента (через запятую)
--registry-url \<docker_registry_url>	нет	URL реестра пакетов
--registry-user \<docker_registry_user>	нет	Пользователь, который используется для авторизации в реестре пакетов
--registry-password \<docker_registry_password>	нет	Пароль, который используется для авторизации в реестре пакетов
--docker-image \<image>	нет	Образ, который будет использован для работы, если не указан любой другой в задачи или конвейере

* При успешном завершении регистрации в веб интерфейсе приложения на вкладке из п.4 появится соответствующая запись о том, что агент подключен к приложению.
* В рабочей директории будет создана директория config содержащая файл application.properties.

5. Добавьте необходимые параметры для запуска в файл config/application.properties.

runner.executor=docker
docker.didEnable=false
docker.host=unix:///var/run/docker.sock
docker.registry-username= #Имя пользователя для доступа к registry
docker.registry-password= #Пароль пользователя для доступа к registry
docker.registry-url= #URL для входа в registry
logging.file.name=data/log/server.log
logging.level.root=INFO

*При необходимости добавьте дополнительные параметры в файл application.properties созданный в п.5. С описанием параметров можно ознакомиться на данной странице.

! В связи с недоступностью Docker Hub, для корректной работы агента необходимо использование другого реестра docker образов. Чтобы подключить к агенту GitFlic Docker Registry, необходимо изменить необходимые параметры в файле config/application.properties (пункт 5) по следующей схеме:

docker.registry-username= #username пользователя на gitflic.ru
docker.registry-password= #транспортный токен пользователя на gitflic.ru
docker.registry-url=https\://registry.gitflic.ru

*** При использовании старой версии агента (< 3.1.1), могут возникать ошибки при пулле образа gitflic-runner-helper, обусловленные недоступностью Docker Hub. Для их исправления требуется добавить в application.properties агента следующие параметры:

runner.helperImage=registry.gitflic.ru/company/gitflic/gitflic-runner-helper:{используемая версия агента}
docker.registry-username= #username пользователя на gitflic.ru
docker.registry-password= #транспортный токен пользователя на gitflic.ru
docker.registry-url=https\://registry.gitflic.ru

Таким образом агент будет использовать GitFlic Docker Registry и корректный образ gitflic-runner-helper. Если необходимо при работе с агентом использовать другой реестр докер контейнеров, gitflic-runner-helper образ можно спуллить на машину, где запущен агент, используя параметры подключения к GitFlic Docker Registry, описанные выше. При этом в application.properties должна быть указана лишь:

runner.helperImage=registry.gitflic.ru/company/gitflic/gitflic-runner-helper:{используемая версия агента}

Запуск агента

Выполните команду запуска

java -jar runner.jar start --config=config/application.properties

*--config= - Параметр указывающий на расположение файла с настройками.