Работа с запусками

Данный раздел описывает процесс работы с запусками определенных элементов экспертизы в системе. Работа осуществляется в разделе Автоматизация → Запуски веб-интерфейса системы.

Раздел доступен администраторам, пользователям, которые имеют соответствующее разрешение в составе своих ролей, а также учетным записям со статусом Суперадминистратор.

О запусках

Запуск — это компонент системы, позволяющий запускать скрипты и плейбуки в системе, а также проверять статус их выполнения.

В систему можно добавлять следующие сущности, обеспечивающие автоматизацию процессов:

скрипты — сценарии, определяющие последовательность выполнения различных действий.
плейбуки — наборы связанных сценариев.

Условия автоматического запуска скриптов и плейбуков определяются триггерами. Триггеры срабатывают при наступлении определенных событий или выполнении определенных условий, которые в них заданы. При этом скрипты и плейбуки можно запустить не только по срабатыванию триггеров, но и вручную.

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

Интерфейс раздела

Панель инструментов включает в себя следующие компоненты:

Кнопка Запустить () позволяет запустить выполнение скрипта или плейбука.
Поле Поиск предназначено для быстрого поиска запусков по названию в отображаемом списке.
Кнопка Фильтр позволяет настроить критерии фильтрации запусков. Запуски можно фильтровать по типу, времени старта и статусу.

В рабочей области отображается таблица имеющихся запусков. Таблица содержит следующие колонки:

Название — название запуска.
Тип — тип запуска (Скрипт или Плейбук).
Группа воркеров — теги воркеров, на которых запущен скрипт или плейбук.
- Если хотя бы один воркер с этим тегом находится в статусе Включен, отображается зеленый индикатор.
- Если все воркеры с этим тегом находятся в статусе Выключен или Ошибка, отображается серый индикатор.
Время запуска — дата и время старта запуска.
Время выполнения — время, затраченное на выполнение запуска.
Статус — статус запуска.
Триггер — имя пользователя или название триггера, инициировавшего запуск.
Информация, отображаемая в этой колонке, зависит от того, как именно был инициирован запуск:
- имя пользователя — пользователь, запустивший скрипт или плейбук.
- Событие — запуск скрипта или плейбука инициируется триггером типа Событие триггера.
- Расписание — запуск скрипта или плейбука инициируется триггером типа Расписание.
Событие триггера указывается в самом триггере. Расписание добавляется в параметры запуска или триггера.

Если название триггера активно, по нажатию на него можно перейти в раздел Автоматизация → Триггеры.

При работе с таблицей запусков доступны следующие операции:

Поиск запусков по полю Название.
Фильтрация запусков по полям Тип, Время запуска и Статус:
- Тип и статус запуска выбираются из выпадающих списков.
- Начало и конец диапазона времени запуска задаются с помощью панели выбора даты и времени.
Сортировка запусков по полям Название, Время запуска, Статус и Триггер.

Работа с запуском

Выполнение скриптов или плейбуков может инициироваться следующими триггерами:

триггер типа Расписание. Триггер запускает скрипт или плейбук в соответствии с настройками расписания.
триггер типа Событие триггера. Триггер запускает скрипт или плейбук при наступлении определенного события.

Доступные операции над запуском:

Добавление запуска
Просмотр запуска
Остановка запуска

Добавление запуска

Запуск можно добавить, указав параметры вручную или выбрав ранее установленные параметры.

Чтобы добавить новый запуск:

Перейдите в раздел Запуски.
Нажмите на кнопку Запустить (). Отобразится форма добавления запуска.
Выберите тип элементов экспертизы для запуска — Скрипт или Плейбук.

Для выбора доступны скрипты и плейбуки со статусом Включен.

Добавьте в запуск элемент экспертизы. Для этого:

Раскройте дерево каталогов в левой части окна и выберите каталог, который содержит нужный элемент экспертизы.

Панель инструментов включает в себя следующие компоненты:

Поле Поиск предназначено для быстрого поиска элементов экспертизы в отображаемом списке по названию и идентификатору.
Поле фильтра Тип позволяет выбрать тип элементов экспертизы для отображения.
Поле фильтра Теги позволяет задать комбинацию тегов искомых элементов.

Выделите элемент экспертизы, который необходимо добавить в запуск.
Нажмите на кнопку Добавить. Выбранный элемент экспертизы будет добавлен в запуск.

После добавления выбранного элемента экспертизы в запуск открывается окно параметров запуска.

Укажите параметры запуска:

В блоке Настройки:

В поле Название экспертизы отображается элемент экспертизы, который будет запущен. Чтобы просмотреть элемент в отдельной вкладке, нажмите на кнопку Открыть.
Выберите из выпадающего списка ID тенанта, в котором будет выполнен запуск.

По умолчанию в параметрах отображается текущий тенант, в котором работает пользователь.

Выберите из выпадающего списка Группа воркеров тег воркеров, на которых возможен запуск скрипта или плейбука.

В выпадающем списке отображаются теги имеющихся воркеров с их статусами. Для выполнения запуска хотя бы один из воркеров должен быть включен.

По умолчанию поле имеет значение all. В этом случае для запуска будет использоваться любой из доступных воркеров.

В поле ID интеграции отображается идентификатор интеграции, позволяющий получить сведения о запуске для использования в скриптах и плейбуках. Эти сведения содержатся в специальном хранилище данных о запусках.

В блоке Аргументы при необходимости отредактируйте аргументы скрипта или плейбука, для которого добавляется запуск.
В блоке Триггер при необходимости укажите параметры триггера типа Расписание или Событие триггера, согласно которым будет производиться запуск. Для того чтобы указать параметры, необходимо перевести переключатель в верхней части блока Триггер в активное положение.

Нажмите на панели инструментов на кнопку Запустить ( play ). Система добавит новый запуск для выбранного скрипта или плейбука и отобразит соответствующее уведомление.

Чтобы отменить добавление нового запуска и удалить введенные значения из полей, нажмите на кнопку Отменить.

Просмотр запуска

Чтобы просмотреть запуск:

Перейдите в раздел Запуски. Система отобразит сведения о всех запусках.
Нажмите на строку запуска в списке. Система отобразит в правой части экрана карточку с подробной информацией.

Название запуска отображается в верхней части карточки. Карточка содержит меню для действий с запуском:

Остановить — остановка запуска.

Карточка содержит основные сведения о запуске:

ID тенанта — идентификатор тенанта, создавшего запуск.
Название — название используемого скрипта или плейбука.
Тип — тип элементов экспертизы, используемый для запуска (скрипт или плейбук).
Группа воркеров — список тегов воркеров, заданных для плейбука или скрипта.
- Если хотя бы один воркер с этим тегом находится в статусе Включен, отображается зеленый индикатор.
- Если все воркеры с этим тегом находятся в статусе Выключен или Ошибка, отображается серый индикатор.
Статус — статус запуска.

Просмотреть ошибки запуска можно в карточке запуска по кнопке Просмотреть логи.
Триггер — название триггера или имя пользователя (в зависимости от того, как был инициирован запуск).
Воркер — название воркера, назначенного для выполнения задачи.
ID интеграции — идентификатор интеграции.
Время запуска — дата и время запуска.
Время выполнения — время, затраченное на выполнение запуска.
Резолюция (для плейбуков с модулем approval в статусе На согласовании) — ссылка Открыть резолюцию для перехода на страницу Автоматизация → Резолюции. На этой странице необходимо согласовать возобновление выполнения.

Таблица 1. Статусы элементов
Статус	Индикатор	Описание статуса
Выполнен	Зеленый	Задание выполнено без ошибок.
В процессе	—	Задание выполняется.
Ошибка	Красный	Задание не выполнилось или завершилось с ошибкой.
Согласован	Зеленый	Пользователь согласовал запрос. Выполнение задания возобновлено.
На согласовании	Синий	Схема выполняемого плейбука содержит модуль `approval`, требующий согласования дальнейшего выполнения. Система отправила пользователю запрос на согласование. Выполнение задания приостановлено и будет продолжено после того, как пользователь согласует запрос.
Не согласован	Желтый	Пользователь отклонил запрос на согласование. Выполнение задания остановлено.
Истекло время согласования	Желтый	У задания истекло время ожидания резолюции.

Остановка запуска

Чтобы остановить запуск:

Перейдите в раздел Запуски. Система отобразит сведения о запусках.
Нажмите на строку запуска в списке. Система отобразит страницу с карточкой этого запуска с подробной информацией о нем.

В верхней части карточки отображается название запуска.
Нажмите на кнопку Остановить. Кнопка отображается только в карточках запусков в статусах В очереди ожидания, На согласовании и В процессе.

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

Статусы запуска

Таблица 2. Статусы запуска
Статус	Индикатор	Описание статуса
Выполнен	Зеленый	Плейбук выполнен.
В очереди ожидания	Синий	Плейбук находится в очереди ожидания на выполнение в воркере.
Согласован	Желтый	Пользователь согласовал запрос. Выполнение плейбука возобновлено.
В процессе	—	Плейбук выполняется.
Ошибка	Красный	Плейбук не выполнился или завершился с ошибкой.
Остановлен	Серый	Принудительная остановка выполнения плейбука.
На согласовании	Синий	Схема выполняемого плейбука содержит модуль `approval`, требующий согласования дальнейшего выполнения плейбука. Система отправила пользователю запрос на согласование. Выполнение плейбука приостановлено и будет продолжено после того, как пользователь согласует запрос.
Не согласован	Желтый	Пользователь отклонил запрос на согласование. Выполнение плейбука остановлено.
Истекло время согласования	Желтый	У плейбука истекло время ожидания резолюции.