Отправка уведомлений в Mattermost#

В данном документе представлена инструкция по настройке уведомлений из Automation Controller на примере Mattermost.

Создание уведомления#

Для создания уведомления выполните следующие действия:

  1. Перейдите в раздел Администрирование ‣ Уведомления (Administration ‣ Notifications) и нажмите кнопку Добавить (Add).

    ../../_images/notification-template.png
  2. Создайте новый шаблон уведомления.

  3. После сохранения откроется окно с созданным уведомлением, в котором можно проверить его работоспособность, нажав кнопку Тест. В канал Mattermost направляется уведомление следующего вида:

    ../../_images/notification-test.png

Добавление уведомления к шаблонам заданий и потоков заданий#

Для добавления уведомлений к шаблонам заданий и потоков заданий выполните следующие действия:

  1. Перейдите в раздел Ресурсы ‣ Шаблоны (Resources ‣ Templates) и выберите вкладку Уведомления (Notifications).

  2. Напротив созданного уведомления включите необходимые флаги для отправки уведомления:

    • Согласование (Approval) – подтверждение или отмена действия, связанного с заданиями.

    • Пуск (Start) – запуск заданий.

    • Успех (Success) – успешное выполнение заданий.

    • Сбой (Failure)– возникновение ошибок при выполнении заданий.

    ../../_images/notification-options.png

Изменение текста сообщений#

Для изменения текста сообщений в уведомлениях выполните следующие действия:

  1. В настройках созданного ранее уведомления переведите переключатель Настройка сообщений… во включенное состояние:

    ../../_images/custom-message.png
  2. Выберите событие, для которого необходимо изменить сообщение.

  3. Если необходимо добавить основную информацию о задании или потоке заданий, используйте переменную Ansible {{ job_metadata }}. Это словарь, который содержит следующие поля:

    • inventory;

    • project;

    • playbook;

    • credential;

    • limit;

    • extra_vars;

    • hosts;

    • body (отображается только в потоке заданий).

    Пример вывода для шаблона задания:

    ../../_images/job-template-test.png

    Пример вывода для потока заданий:

    ../../_images/job-workflow-template-test.png