Установка агента GitFlic Runner типом powershell

---

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

• Для агентов версии 1.7.1 и ниже выбор рабочей директории недоступен.
• Рабочей директорией для агента, является директория gitflic-runner в корне домашней директории пользователя, который запускает агент.
• Для работы агента, рекомендуется создать отдельного пользователя в системе, который будет осуществлять запуск агента.

* Далее все команды выполняются от пользователя, который будет запускать агент

Установка зависимостей

1. Установите Java

   Загрузить установщик Java 11 для Windows можно на данной странице.

2. Установите Git

   Загрузить установщик Git для Windows можно на данной странице.

Установка агента

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

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

2. В директории gitflic-runner создайте директории build, cache и data\log

New-Item -ItemType Directory $env:USERPROFILE\gitflic-runner\build ; New-Item -ItemType Directory $env:USERPROFILE\gitflic-runner\cache ; New-Item -ItemType Directory $env:USERPROFILE\gitflic-runner\data\log

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

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

helper.jar - вспомогательный файл для работы агента в режиме shell/powershell. Он необходим для работы агентов до непосредственного выполнения задачи (скачивание артефактов, подготовка кэша и прочее), и после ее выполнения (скачивание и загрузка артефактов на GitFlic, загрузка отчетов sast/dast/sca/unit-test, создание кэша и прочее).

4. Переместите или скопируйте файл helper.bat из директории powershell-scripts , в директорию gitflic-runner созданную в п.1

Copy-Item .\powershell-scripts\helper.bat $env:USERPROFILE\gitflic-runner

helper.bat - batch скрипт, через который происходит вызов helper.jar с различным набором параметров. Агент CI/CD в своей работе вызывает helper.jar через helper.bat.

Без файлов helper.jar, helper.bat агент не сможет корректно выполнять задачи, связанные с CI/CD.

Регистрация агента

1. Перейдите в веб интерфейс приложения

   SelfhostedGitflic.ru

   GitFlic -> Панель администратора -> СI/CD

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

   Настройки компании -> Агенты CI/CD*

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

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

   

3. Перейдите в директорию с исполняемым файлом runner.jar

   cd $env:USERPROFILE\gitflic-runner
   

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

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

   Ключ	Обязательный	Описание
   --url \<url>	да	Url скопированный в п.3
   --registration-token \<token> или --token \<token>	да	Token скопированный в п.1
   --name \<name>	нет	Название агента
   --tags \<tags>	нет	Теги агента (через запятую)

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

   

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

   runner.executor=powershell
   logging.file.name=runner.log
   logging.level.root=INFO
   

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

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

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

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