From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 25A151FF396 for ; Tue, 21 May 2024 09:35:49 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id B9E43136EB; Tue, 21 May 2024 09:36:05 +0200 (CEST) Message-ID: <11bc8d09-bf65-4693-a69b-360af789ae7d@proxmox.com> Date: Tue, 21 May 2024 09:35:30 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird From: Lukas Wagner To: pbs-devel@lists.proxmox.com References: <20240426112335.194289-1-l.wagner@proxmox.com> Content-Language: de-AT, en-US In-Reply-To: <20240426112335.194289-1-l.wagner@proxmox.com> 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: Re: [pbs-devel] [PATCH proxmox-backup v3 1/3] 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" ping... On 2024-04-26 13:23, Lukas Wagner wrote: > 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 > --- > docs/maintenance.rst | 20 ++-------------- > docs/notifications.rst | 53 ++++++++++++++++++++++++++++++++++++++++++ > docs/storage.rst | 4 ++-- > 3 files changed, 57 insertions(+), 20 deletions(-) > > diff --git a/docs/maintenance.rst b/docs/maintenance.rst > index 6dbb6941..4bb135e4 100644 > --- a/docs/maintenance.rst > +++ b/docs/maintenance.rst > @@ -277,26 +277,10 @@ the **Actions** column in the table. > Notifications > ------------- > > -Proxmox Backup Server can send you notification emails about automatically > +Proxmox Backup Server can send you notifications 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 > +Refer to the :ref:`notifications` chapter for more details. > > .. _maintenance_mode: > > diff --git a/docs/notifications.rst b/docs/notifications.rst > index 4f9b01b7..7bc3db82 100644 > --- a/docs/notifications.rst > +++ b/docs/notifications.rst > @@ -1,3 +1,5 @@ > +.. _notifications: > + > Notifications > ============= > > @@ -33,6 +35,10 @@ the latter contains sensitive configuration options such as > passwords or authentication tokens for notification targets and > can only be read by ``root``. > > +Datastores and tape backup jobs have a configurable :ref:`notification_mode`, > +which allows you to choose between the notification system and a legacy mode > +for sending notification emails. > + > > Notification Targets > -------------------- > @@ -211,3 +217,50 @@ 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 > +----------------- > +Datastores and tape backup/restore job configuration have a ``notification-mode`` > +option which can have one of two values: > + > +* ``legacy-sendmail``: Send notification emails via the system's ``sendmail`` command. > + The notification system will be bypassed and any configured targets/matchers will be ignored. > + This mode is equivalent to the notification behavior for version before > + Proxmox Backup Server 3.2. > + > +* ``notification-system``: Use the new, flexible notification system. > + > +If the ``notification-mode`` option is not set, Proxmox Backup Server will default > +to ``legacy-sendmail``. > + > +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-mode`` > +option has to be set explicitly to ``notification-system`` if the > +notification system shall be used. > + > +The ``legacy-sendmail`` mode might be 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 -- - Lukas _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel