From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id B833320EC88 for ; Thu, 25 Apr 2024 14:48:47 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 7D19331F2E; Thu, 25 Apr 2024 14:48:53 +0200 (CEST) From: Lukas Wagner To: pbs-devel@lists.proxmox.com Date: Thu, 25 Apr 2024 14:48:17 +0200 Message-Id: <20240425124818.325318-1-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.003 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v2 1/2] docs: document notification-mode and merge old notification section X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" This new section describes how the notification-mode parameter works. The section also contains also parts of the old notification section from the maintenance chapter, reusing the description of the `notify` and `notify-user` parameters. Signed-off-by: Lukas Wagner Reviewed-by: Gabriel Goller --- v2: fixed spelling, thx @Gabriel docs/maintenance.rst | 26 -------------------------- docs/notifications.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ docs/storage.rst | 4 ++-- 3 files changed, 44 insertions(+), 28 deletions(-) diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 6dbb6941..1dd17ad0 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -272,32 +272,6 @@ datastores, backup groups or snapshots. To do this, navigate to the **Content** tab of the datastore and either click *Verify All* or select the *V.* icon from the **Actions** column in the table. -.. _maintenance_notification: - -Notifications -------------- - -Proxmox Backup Server can send you notification emails about automatically -scheduled verification, garbage-collection and synchronization tasks results. - -By default, notifications are sent to the email address configured for the -`root@pam` user. You can instead set this user for each datastore. - -.. image:: images/screenshots/pbs-gui-datastore-options.png - :target: _images/pbs-gui-datastore-options.png - :align: right - :alt: Datastore Options - -You can also change the level of notification received per task type, the -following options are available: - -* Always: send a notification for any scheduled task, independent of the - outcome - -* Errors: send a notification for any scheduled task that results in an error - -* Never: do not send any notification at all - .. _maintenance_mode: Maintenance Mode diff --git a/docs/notifications.rst b/docs/notifications.rst index 4f9b01b7..d2bc573f 100644 --- a/docs/notifications.rst +++ b/docs/notifications.rst @@ -211,3 +211,45 @@ Permissions In order to modify/view the configuration for notification targets, the ``Sys.Modify/Sys.Audit`` permissions are required for the ``/system/notifications`` ACL node. + +.. _notification_mode: + +Notification Mode +----------------- + +To ensure a smooth transition from the old, purely email based system to +the new configurable notification system introduced in Proxmox Backup Server 3.2, +datastore options, tape backup jobs and tape restore jobs gain a new option: +``notification-mode``. This option must be set to ``notification-system`` +to opt in to the new notification system. If the option is not set, or +set to ``legacy-sendmail``, Proxmox Backup Server will use the old +system. + +Starting with Proxmox Backup Server 3.2, a datastore created in the UI will +automatically opt in to the new notification system. If the datastore is created +via the API or the ``proxmox-backup-manager`` CLI, the ``notification-system`` +option has to be set explicitly. + +The ``legacy-sendmail`` mode will be deprecated and removed in a later +release of Proxmox Backup Server. + +Settings for ``legacy-sendmail`` notification mode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If ``notification-mode`` is set to ``legacy-sendmail``, Proxmox Backup Server +will send notification emails via the system's ``sendmail`` command to the email +address configured for the user set in the ``notify-user`` option +(falling back to ``root@pam`` if not set). + +For datastores, you can also change the level of notifications received per task +type via the ``notify`` option. + +* Always: send a notification for any scheduled task, independent of the + outcome + +* Errors: send a notification for any scheduled task that results in an error + +* Never: do not send any notification at all + +The ``notify-user`` and ``notify`` options are ignored if ``notification-mode`` +is set to ``notification-system``. diff --git a/docs/storage.rst b/docs/storage.rst index 4444c423..f1e15d52 100644 --- a/docs/storage.rst +++ b/docs/storage.rst @@ -314,7 +314,7 @@ Options There are a few per-datastore options: -* :ref:`Notifications ` +* :ref:`Notification mode and legacy notification settings ` * :ref:`Maintenance Mode ` * Verification of incoming backups @@ -419,7 +419,7 @@ remote-source to avoid that an attacker that took over the source can cause deletions of backups on the target hosts. If the source-host became victim of a ransomware attack, there is a good chance that sync jobs will fail, triggering an :ref:`error notification -`. +`. It is also possible to create :ref:`tape backups ` as a second storage medium. This way, you get an additional copy of your data on a -- 2.39.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel