Перейти к содержанию

Уведомления

Уведомления в Sharx Base используются для информирования пользователей о важных событиях в системе: отправки сертификатов при включенной двухфакторной аутентификации, настройке журнала безопасности, наличии ошибок при выполнении процессов и т. д.

Внимание

Предварительно настройте сторонний SMTP-сервер, по которому будет осуществляться подключение

Чтобы настроить уведомления, необходимо сформировать маршрут отправки.
Создание маршрута состоит из следующих шагов:

  1. Создать Почтовый сервер.
    Возможно существование нескольких типов почтовых серверов. Самый распространенный — SMTP-сервер для отправки почты.
  2. Сформировать Адреса для отправки сообщения. Возможно задать набор адресов для получения сообщения.
  3. Задать Шаблоны. Данные для шаблона передаются как часть сообщения, которое приходит в маршрутизатор.
  4. Создать Маршрут отправки.

Создать почтовый сервер

  1. Чтобы добавить почтовый сервер, введите в командной строке 

    notif endpoint add --descr <endpoint_description> --name <endpoint_name> --passwd <service_server_passwd> --tls <yes_or_no> --type SMTP --url <server_url> --user <service_server_user>

  2. Запрос информации о всех почтовых серверах 

    notif endpoint list

  3. Запрос информации об определенном почтовом сервере 

    notif endpoint show --name <endpoint_name>

Сформировать список адресов

  1. Чтобы добавить адреса, введите в командной строке 

    notif mailing add --addresses <list_of_addresses> --descr <description> --name <mailing_name>
    где addresses — адреса, существующие на SMTP-сервере и на кластере Sharx Base.

  2. Запрос информации о всех адресах 

    notif mailing list

  3. Запрос информации об определенном адресе 

    notif mailing show --name <mailing_name>

Задать шаблоны сообщений

Примечание

Добавляйте шаблон с помощью файла YAML, так как часто возникают ошибки при внесении данных.
Файл с примером шаблона notif.yaml

  1. Чтобы добавить шаблон, введите в командной строке 

    notif template add --data <template_data> --descr <template_description> --name <template_name>

  2. Запрос информации о всех шаблонах сообщений 

    notif template list

  3. Запрос информации об определенном шаблоне 

    notif template show --name <template_name>

Настроить маршрут отправки уведомлений

Маршрут объединяет в себе ранее созданные сущности endpoint, mailing, template и является точкой входа и отправки сообщения по конкретному пути.

  1. Чтобы настроить маршрут, введите в командной строке 

    notif route add --name <route_name> --descr <route_description> --endpoint <endpoint_name> --mailing <mailing_name> --sender <message_sender_name> --subject <message_subject> --template <template_name>

  2. Чтобы запросить информацию о всех маршрутах, введите 

    notif route list

  3. Запросить информацию об определенном маршруте 

    notif route show --name <route_name>

Настроить уведомления с помощью файла YAML

  1. Создайте файл формата YAML.

    В файле опишите все необходимые параметры и команды для настройки отправки уведомлений. Пример файла автоматической настройки уведомлений notif.yaml

    Примечание

    Пример файла содержит шаблон для уведомления о невалидном объекте (неправомерном изменении объекта)

  2. Сохраните файл настройки уведомлений.

  3. Загрузите файл на Платформу.

    Чтобы загрузить файлы в Sharx Base, введите команду

    resource --spec <path_to_yaml_file>
    где spec — расположение YAML-файла.

    При локальном расположении на АРМ пользователя введите путь до файла.

    При расположении в стороннем репозитории укажите ссылку на данный файл.

  4. Проверьте загрузку файла 

    notif <arg_notif> list

    где arg_notif — аргумент для проверки конкретного параметра настройки уведомлений.

    Возможные значения:

    • endpoint — конечный сервис или сервер для отправки сообщений;
    • mailing — список адресантов или рассылки для отправки сообщения;
    • template — шаблон сообщения;
    • route — маршрут отправки уведомлений.

Проверяемые параметры уведомлений должны отобразиться в общем списке.

Контроль отправленных сообщений

  1. Чтобы проверить перечень отправленных сообщений, введите команду 

    notif message list

  2. Отобразить подробную информацию об отправленном сообщении 

    notif message show --uuid <message_uuid>
    где uuid — идентификатор сообщения.

Термины и определения содержатся в статьях: