Система уведомлений (нотификаций) PVE предназначена для информирования администраторов о значимых событиях, происходящих в системе, например об ошибках репликации данных, сбоях ограждения узлов, успешном завершении или ошибках выполнения заданий резервного копирования.
При возникновении значимого события PVE формирует событие уведомления, которое обрабатывается системой уведомлений. Каждое событие содержит метаданные: временную метку, уровень серьёзности, тип события и дополнительные поля, зависящие от типа события.
Сопоставители уведомлений определяют, каким целям следует передать уведомление. Для выбора целевых объектов сопоставители могут использовать правила фильтрации по метаданным события.
Цель уведомления — конечный пункт назначения, в который направляется уведомление. PVE поддерживает следующие типы целей:
Sendmail — отправка уведомлений через локальный почтовый сервер;
SMTP — отправка уведомлений через внешний SMTP-сервер;
Gotify — отправка уведомлений в сервис Gotify (легковесный сервер для push-уведомлений);
Webhook — отправка HTTP-запросов на настраиваемый URL-адрес.
Для заданий резервного копирования можно настроить режим уведомлений: использовать систему уведомлений PVE или классический механизм отправки сообщений электронной почты.
Систему уведомлений можно настроить следующими способами:
Конфигурация системы уведомлений хранится в файлах:
/etc/pve/notifications.cfg — основные настройки;
/etc/pve/priv/notifications.cfg — конфиденциальные параметры (пароли, токены аутентификации). Файл доступен для чтения только пользователю root.
38.1. Цели уведомлений (Notification Targets)
Цель уведомлений Sendmail использует команду sendmail для отправки электронных писем указанным получателям. Если в качестве получателя указан пользователь PVE, система использует адрес электронной почты из его профиля (адрес электронной почты пользователя можно настроить в разделе → → ). Если адрес электронной почты не указан, отправить уведомление этому пользователю не удастся.
Команда
sendmail предоставляется почтовым агентом (MTA), например Postfix. Для корректной доставки писем может потребоваться настройка Postfix, в том числе указание внешнего ретранслятора. При ошибках доставки следует проверить системный журнал на наличие сообщений службы Postfix:
# journalctl -u postfix
Для работы цели Sendmail необходимо, чтобы команда
sendmail была доступна и почтовая система была настроена для отправки сообщений. В стандартной установке PVE команда обычно предоставляется Postfix. Если используется Postfix, необходимо добавить его в автозагрузку и запустить:
# systemctl enable --now postfix
Для настройки цели Sendmail необходимо выполнить следующие действия:
Перейти в раздел → → .
Нажать кнопку → :
В открывшемся окне указать параметры (в скобках приведены соответствующие имена параметров в файле
notifications.cfg):
Имя конечной точки — идентификатор цели уведомлений;
Включить (disable) — состояние цели: включена или отключена;
Получатель (получатели) (mailto-user) — пользователи PVE, которым будут отправляться уведомления. Адреса электронной почты пользователей берутся из файла users.cfg;
Дополнительный получатель (получатели) (mailto) — адреса электронной почты дополнительных получателей;
Комментарий (comment) — описание цели;
Автор (author) — имя отправителя (по умолчанию: Proxmox VE);
Адрес отправителя (from-address) — адрес отправителя. Если параметр не задан, используется настройка → → (значение email_from из файла datacenter.cfg). Если оно также не задано, используется адрес root@$hostname, где $hostname — имя узла.
Пример конфигурации (
/etc/pve/notifications.cfg):
sendmail: sendmails-admin
comment Отправка уведомлений администраторам
mailto user@example.test
mailto-user kim@test.alt
mailto-user orlov@test.alt
mailto-user root@pam
Цель уведомлений SMTP отправляет электронные письма непосредственно через SMTP-сервер, не используя системный MTA для доставки сообщений.
В отличие от Sendmail, SMTP-цель не поддерживает очередь сообщений и повторные попытки отправки в случае сбоя доставки.
Для настройки цели SMTP необходимо выполнить следующие действия:
Перейти в раздел → → .
Нажать кнопку → :
В открывшемся окне указать параметры (в скобках приведены соответствующие имена параметров в файле
notifications.cfg):
Имя конечной точки — идентификатор цели уведомлений;
Включить (disable) — состояние цели: включена или отключена;
Сервер (server) — адрес SMTP-сервера;
Шифрование (mode) — режим соединения: без шифрования (insecure), STARTTLS (starttls) или TLS (tls). По умолчанию используется TLS;
Порт (port) — порт SMTP-сервера. Если порт не указан, он выбирается в зависимости от режима соединения: 465 (TLS), 587 (STARTTLS), 25 (без шифрования);
Выполнять аутентификацию — настройка аутентификации на SMTP-сервере;
Имя пользователя (username) — имя пользователя для аутентификации SMTP. Если параметр не задан, аутентификация не выполняется. Поддерживаются методы аутентификации PLAIN и LOGIN;
Пароль (password) — пароль для аутентификации SMTP;
Адрес отправителя (from-address) — адрес отправителя. SMTP-сервер может требовать, чтобы этот адрес принадлежал аутентифицированному пользователю. В заголовке From указываются имя автора и адрес отправителя в формате $author <$from-address>;
Получатель (получатели) (mailto-user) — пользователи PVE, которым будут отправляться уведомления. Адреса электронной почты пользователей берутся из файла users.cfg;
Дополнительный получатель (получатели) (mailto) — адреса электронной почты дополнительных получателей;
Комментарий (comment) — описание цели;
Автор (author) — имя отправителя (по умолчанию: Proxmox VE).
Пример конфигурации:
файл
/etc/pve/notifications.cfg:
smtp: smtp
from-address pve-mail@test.alt
mailto-user root@pam
mailto-user orlov@test.alt
mode tls
server mail.test.alt
username pve-mail
файл
/etc/pve/priv/notifications.cfg:
smtp: smtp
password somepassword
Цель уведомлений Webhook выполняет HTTP-запросы к указанному URL-адресу. Для формирования URL, заголовков и тела запроса поддерживается шаблонизация с использованием Handlebars.
Для настройки цели Webhook необходимо выполнить следующие действия:
Перейти в раздел → → .
Нажать кнопку → :
В открывшемся окне указать параметры (в скобках приведены соответствующие имена параметров в файле
notifications.cfg):
Имя конечной точки — идентификатор цели уведомлений;
Включить (disable) — состояние цели: включена или отключена;
Метод/URL-адрес (method/url) — HTTP-метод (POST, PUT или GET) и URL-адрес, на который отправляется запрос. URL-адрес поддерживает шаблонизацию, позволяющую подставлять содержимое уведомления, метаданные и секреты;
Заголовки (header) — HTTP-заголовки запроса. Их значения могут содержать шаблоны;
Тело письма (body) — содержимое HTTP-запроса (в формате base64). Поддерживается шаблонизация;
Секреты (secret) — набор секретов, представленных парами «имя — значение». Секреты хранятся в защищенном файле конфигурации (/etc/pve/priv/notifications.cfg), доступном для чтения только пользователю root. При получении конфигурации через API возвращается имя секрета, но не его значение. В шаблонах URL, заголовков и тела запроса к секретам можно обращаться через пространство имён secrets.
Комментарий (comment) — описание цели;
Пример конфигурации:
файл
/etc/pve/notifications.cfg:
webhook: ntfy
body e3sgbWVzc2FnZSB9fQ== # Закодированный {{ message }}
comment Отправка PUSH уведомлений
method post
url https://ntfy.sh/pve_backup_job_186
файл
/etc/pve/priv/notifications.cfg:
webhook: ntfy
secret name=channel,value=MTIzNDU2NDg3OA==
В конфигурационном файле значение параметра body и значения value в записях header и secret хранятся в формате Base64.
Закодировать строку в Base64 можно следующей командой:
$ echo -n 'pve_backup_job_186' | base64 -w 0
cHZlX2JhY2t1cF9qb2JfMTg2
Доступны следующие переменные шаблонов:
{{ title }} — заголовок уведомления;
{{ message }} — тело уведомления;
{{ severity }} — уровень серьёзности (info, notice, warning, error, unknown);
{{ timestamp }} — временная метка в формате времени Unix (количество секунд с начала эпохи Unix);
{{ fields.<name> }} — метаданные события (например, fields.type содержит тип уведомления);
{{ secrets.<name> }} — секреты (например, секрет с именем token доступен через secrets.token).
Для обработки значений доступны следующие помощники:
{{ url-encode <value/property> }} — URL-кодирование значения или свойства;
{{ escape <value/property> }} — экранирование управляющих символов, которые нельзя безопасно представить в строке JSON;
{{ json <value/property> }} — преобразование значения в JSON. Например, {{ json fields }} позволяет представить всё пространство имён fields в формате JSON.
Цели Webhook учитывают настройки HTTP-прокси, заданные в разделе → → .