Разделы документации

Как запустить

Пошаговый запуск сканирования пайплайном на агентах — подготовка, запуск, результаты в S3 и SBOM со страницы запуска; PT AI и CodeScoring в своём шаблоне.

Скан выполняют агенты по шаблону пайплайна. Как это устроено — в Обзоре.

Пайплайн на агентах

Подготовка (один раз, администратор):

(своё S3, если нужно) → агент → шаблон пайплайна → (секреты и файлы конфигурации, если нужны шаблону)

1. Хранилище результатов

Настраивать не обязательно. Без своего S3 результаты попадают во встроенное хранилище комплекта сервера, а агенты загружают их через Archepelag.

Своё S3 подключите, если нужны другой бакет, срок хранения или лимиты: Настройки → Интеграции → S3-хранилище → Добавить хранилище — адрес, бакет, ключ доступа и, если агенты видят S3 по другому адресу, Адрес для агентов. Нажмите Проверить подключение. Подробно — S3-хранилище.

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

Workflow → Раннеры → Добавить раннера: имя и метки. Скопируйте токен (он показывается один раз) и выполните команды установки из того же окна — на скан-хосте с Docker или в Kubernetes. Через несколько секунд агент станет онлайн. Для теста хватит встроенного агента: docker compose --profile scan-agent up -d в каталоге комплекта сервера, создавать агента в UI не нужно. Подробно — Установка агентов.

3. Выберите или напишите шаблон

Workflow → Пайплайны. Готовые шаблоны: SBOM для Maven, Gradle, npm и cdxgen, Gitleaks, Semgrep, Trivy и «Полная проверка безопасности». Их можно включать, выключать, копировать и править. Свой шаблон — кнопка Создать пайплайн: ключ, название, кто может запускать и YAML. Проверить покажет ошибки и план стадий. Справочник — Описание пайплайна (YAML).

Если шаблону нужны секреты (токен Nexus, settings.xml), создайте их в Настройки → Секреты и Настройки → Файлы конфигурации — шаблон ссылается на них по имени.

4. Запустите

Откройте Scan pipeline → Новый запуск:

  1. Выберите шаблон. Шаблон по умолчанию выбран заранее.
  2. Заполните параметры, если они есть (например, версию JDK).
  3. Посмотрите панель Подходящие агенты: сколько агентов онлайн и сколько свободных слотов. Если подходящих агентов нет, панель скажет почему.
  4. Выберите репозитории и при необходимости ветку.
  5. Запустите.

Каждый репозиторий становится отдельным заданием. Задания выполняются параллельно на свободных агентах с подходящими метками.

5. Посмотрите результат

Страница запуска: слева — репозитории со статусом, агентом или причиной ожидания; справа — выбранный репозиторий.

ЧтоГде
Стадии и шагиДоска стадий: статус, длительность, код выхода и ошибка каждого шага
ЛогиВкладка Логи: шаг или всё задание, обновляется во время работы; Полный лог скачивает файл из S3
Отчёты, SBOM, логи шаговВкладка Файлы: всё, что агент загрузил в S3, с кнопкой скачивания; ошибки загрузки и предупреждения разбора
SBOMКнопка Скачать SBOM в заголовке репозитория
НаходкиВкладка Находки — после завершения задания и разбора отчётов
ПопыткиИстория попыток: на каком агенте и чем закончилась каждая

Остановить отменяет запуск: задания в очереди отменяются сразу, а агенты останавливают идущие шаги и загружают логи и уже готовые отчёты — находки завершённых шагов не теряются. Перезапустить и Перезапустить упавшие создают новый запуск с теми же параметрами.

Файлы хранятся столько дней, сколько задано в настройках своего S3 или, для встроенного хранилища, в SCAN_RESULTS_RETENTION_DAYS сервера (по умолчанию 90). Находки остаются и после удаления файлов.

Если все репозитории запуска удалили, пока он шёл, запуск через несколько минут завершается сам: со статусом «Репозитории запуска удалены», если от них ничего не осталось.

PT AI и CodeScoring

Встроенных шаблонов для PT AI, CodeScoring и выгрузки в ASOC нет. Если они нужны, напишите свой шаблон, в котором шаг вызывает CLI инструмента:

  • Токен шаг получает из интеграции: credentials: [{ integration: ptai, env: PTAI_TOKEN }] (также codescoring, aspm, defectdojo). Передаётся только токен.
  • Адрес сервера задайте в env пайплайна или шага либо параметром шаблона. В шаблоне с секретами параметр string должен иметь pattern — или используйте choice.
  • Образ с CLI берите из своего registry (registry: в шаблоне).
  • Отчёт объявите в reports: sarif, если CLI умеет его выдавать, — тогда находки попадут в таблицу; иначе raw — файл только сохранится в S3.

Синтаксис привязок — Секреты и файлы конфигурации, ограничения параметров — Правила безопасности параметров.

Связанные страницы