all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox Backup Server development discussion
	<pbs-devel@lists.proxmox.com>,
	Lukas Wagner <l.wagner@proxmox.com>
Subject: Re: [pbs-devel] [PATCH proxmox-backup v2 1/2] docs: document notification-mode and merge old notification section
Date: Fri, 26 Apr 2024 09:18:42 +0200	[thread overview]
Message-ID: <edaf78ef-65a6-44f8-adb6-5a8ff7000987@proxmox.com> (raw)
In-Reply-To: <20240425124818.325318-1-l.wagner@proxmox.com>

Am 25/04/2024 um 14:48 schrieb Lukas Wagner:
> 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 <l.wagner@proxmox.com>
> Reviewed-by: Gabriel Goller <g.goller@proxmox.com>
> ---
> 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
> --------------


This is linked a few times in the forum, and so I'd like to avoid breaking the
anchor. Can we possibly keep this section in a minimal form that states that
this is now legacy and one should check out the new notification system, with
a link to that one.

I'd do so at least for the current major release. Not a huge thing, but IMO to
cheap to not do.

> -
> -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.

Maybe starting out with something like "There exist two notifications modes:"
and then using bulletin points for the two notification modes would make this
a bit easier to read. As the sentence feels a tiny bit convoluted to me – I
know because, I write "worse" ones by default all the time ;-)

btw. a short section in the PBS 2 to 3 upgrade guide would be nice too, could
consist only of a short sentence for context and then just link to this one
here, once applied.

> +
> +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.

Not sure if we really do a hard-removal, or at least how soon that would be.
S o maybe s/removed/might be removed/ to hold out our options and avoid making
(responsible) users stumbling upon this might think "I must switch now or
things break".


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

  parent reply	other threads:[~2024-04-26  7:19 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-25 12:48 Lukas Wagner
2024-04-25 12:48 ` [pbs-devel] [PATCH proxmox-backup v2 2/2] ui: datastore options: link to 'notification-mode' section Lukas Wagner
2024-04-26  7:18 ` Thomas Lamprecht [this message]
2024-04-26  7:24   ` [pbs-devel] [PATCH proxmox-backup v2 1/2] docs: document notification-mode and merge old notification section Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=edaf78ef-65a6-44f8-adb6-5a8ff7000987@proxmox.com \
    --to=t.lamprecht@proxmox.com \
    --cc=l.wagner@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal