Задачи и политики
Задача — это сценарий, управляющий применением состояния (SLS) на одном или нескольких миньонах.
Для создания задач в Salt.Box используются шаблоны задач, загружаемые из репозиториев SLS.
О подключении репозиториев и перечне доступных шаблонов см. разделы онлайн-документации:
Шаблоны задач
Репозитории SLS
Политика — режим выполнения задачи, предназначенный не для немедленного выполнения действий, а для задания правил и ограничений, в рамках созданных и запущенных задач.
При создании политики:
- Задача описывается как правило (политика), а не как разовое действие;
- Пользователь не выбирает конкретные миньоны напрямую, а работает с разрешёнными коллекциями.
Создание задачи
В процессе создания задачи пользователь Salt.Box выполняет следующие шаги:
- Выбирает адресатов задачи.
- Выбирает шаблон задачи и вводит общие параметры задачи.
- Вводит параметры, определённые в шаблоне задачи.
- Просматривает параметры на вкладке Обзор и подтверждает создание задачи.
- Запускает и контролирует выполнение задачи со страницы Карточка задачи.
Выбор адресатов задачи
Создание задач в Salt.Box осуществляется со страницы миньонов (переход на страницу — через пункт Клиенты главного меню).
В Salt.Box действует алгоритм, по которому при создании задачи определяются целевые миньоны (т.е. миньоны, на которых будет выполняться задача):
-
Все миньоны текущей активной (выбранной пользователем из числа доступных ему) коллекции
(этот вариант применяется по умолчанию).
-
Все миньоны, отобранные фильтром, применённым к исходной коллекции.
-
Миньоны, выбранные пользователем из результата применения фильтра к исходной коллекции.
На Рис. 1 показан пример, в котором пользователем из коллекции root collection выбрана группа миньонов (отмечены пользователем флажками).
 |
|---|
Нажмите кнопку + Создать задачу Рис. 1.
Выбор шаблона задачи и ввод общих параметров задачи
В открывшемся диалоговом окне Выберите шаблон задачи выберите нужный шаблон (например Установка и удаление программного обеспечения) Рис. 2.
 |
|---|
Если список шаблонов пуст, синхронизируйте шаблоны, как указано в разделе Шаблоны задач.
В результате откроется диалоговое окно Настройка задачи Рис. 3.
Ввод параметров, определённых в шаблоне задачи
Состав параметров, определённых в шаблоне, зависит от соответствующего ему файла SLS.
На Рис. 3 показан пример набора параметров, определённых в выбранном пользователем шаблоне Установка и удаление программного обеспечения (Base - Software - Packages).
На вкладке Настройки в поле Package введите название пакета, который хранится на сервере или в репозиториях ОС миньонов Рис. 3.
Если необходимо обновить уже установленный пакет на ОС миньона (миньонов) в поле Update the package repository database (optional) следует выбрать параметр True (по умолчанию указано False).
 |
|---|
В поле аргументов вводится только название пакета. Например: Package: htop Рис. 3.
Обязательные поля отмечены знаком *
При массовом использовании задач есть функция расширенные настройки, которые позволяют распределять нагрузку при выполнении множества задач на определённом промежутке времени.
Для этого на вкладке Настройки необходимо активировать кнопку Расширенные настройки Рис. 4 [1].
В таблице 1 приведено описание общих параметров задачи.
 |
|---|
Таблица 1. Перечень общих параметров задачи
| Параметр | Описание |
|---|---|
| Размер пакета | Размер «окна» выполнения (максимальное количество одновременно выполняемых задач). Значение 0 — без ограничений |
| Параллельные задачи | Максимальное количество одновременно выполняемых задач |
| Максимум попыток | Количество попыток выполнения задачи в случае недачного завершения |
| Задержка повтора | Задержка в секундах перед повторной попыткой |
Нажать кнопку Далее к обзору Рис. 4 [2].
В результате в диалоговом окне Настройка задачи откроется вкладка Обзор Рис. 5.
 |
|---|
Вкладка Обзор Рис. 5 предназначена для предварительного просмотра и проверки параметров задачи перед её запуском.
Вкладка Обзор позволяет пользователю:
- увидеть сводную информацию по создаваемой задаче;
- проверить корректность выбранных параметров;
- убедиться, что задача будет выполнена на нужных миньонах и с нужными настройками;
- избежать ошибок перед запуском задачи.
Подтверждение создания задачи
После ввода параметров нажмите кнопку Создать задачу Рис. 5.
Будет создана задача, откроется страница карточки задачи Рис. 6.
Первоначальный статус новой задачи — “created” (Создана).
Карточка задачи
 |
|---|
Карточка задачи состоит из следующих основных блоков и элементов интерфейса:
-
блок с кнопками управления, кнопкой Параметры задачи и атрибутами задачи Рис. 6 [1]
Таблица 2. Перечень атрибутов задачиперечень атрибутов задачи приведён в таблице 2
Атрибут Описание Тип Тип задачи Статус Статус задачи Создана Время создания задачи Пользователь Имя пользователя, создавший задачу -
блок выполнения задачи Рис. 6 [2]
- вкладка
Всена вкладке отображается список всех адресатов (миньонов, на которые планируется или уже запущена задача)
- вкладка
Ожидаетна вкладке отображается список адресатов (миньонов), находящихся в режиме ожидания
- вкладка
В процессена вкладке отображается список адресатов (миньонов), находящихся в процессе выполнения
- вкладка
С ошибкойна вкладке отображается список адресатов (миньонов) с ошибками выполнения
- вкладка
Успешнона вкладке отображается список адресатов (миньонов) с успешно выполненными задачами
- вкладка
-
таблица Карточки задачи Рис. 6 [3]
Таблица 3. Перечень полей таблицы Карточки задачиперечень полей таблицы Карточки задачи приведён в таблице 3
Имя поля Значение ID клиента Идентификатор задачи Мастер Наименование мастера Статус Статус миньона Количество запусков Количество проделанных запусков задачи Запущена Период запуска задачи Завершена Период завершения задачи
Для просмотра списка всех задач, выполненных на миньонах текущей отображаемой коллекции, выберите вкладку Задачи, расположенную в верхней левой части страницы коллекции миньонов.
Вид таблицы задач показан на Рис. 7.
 |
|---|
Создание политики
В процессе создания политики пользователь Salt.Box выполняет следующие шаги:
- Выбирает коллекции миньонов.
- Выбирает шаблон задачи и вводит общие параметры политики.
- Вводит параметры, определённые в шаблоне задачи.
- Просматривает параметры на вкладке Обзор и подтверждает создание политики.
- Запускает и контролирует выполнение политики со страницы Карточка задачи (политики).
Выбор коллекции миньонов
Создание политики в Salt.Box осуществляется со страницы миньонов.
В главном меню системы выберите пункт Клиенты Рис. 8.
 |
|---|
На появившейся выдвижной панели Рис. 9 будут показаны все доступные коллекции.
 |
|---|
Более подробную информацию о том, как создаются коллекции миньонов см. в разделе Миньоны.
Выберите необходимую коллекцию (например,root collection) в рамках которой будет создана политика.
В рабочей области окна браузера будет выведен список миньонов выбранной коллекции Рис. 10.
 |
|---|
+ Создать политику
Выбор шаблона задачи и ввод общих параметров политики
На вкладке Список нажмите кнопку + Создать политику Рис. 10.
В открывшемся диалоговом окне Выберите шаблон политики из списка выберите шаблон политики (например,
Test - Return a random result) Рис. 11.