all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v4 18/43] api-types: api: datatore: add notification-mode parameter
Date: Mon, 22 Apr 2024 14:38:16 +0200	[thread overview]
Message-ID: <20240422123841.280675-19-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240422123841.280675-1-l.wagner@proxmox.com>

This one lets the user choose between the old notification behavior
(selecting an email address/user and always/error/never behavior per
datastore) and the new one (emit notification events to the
notification system)

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Tested-by: Gabriel Goller <g.goller@proxmox.com>
Reviewed-by: Gabriel Goller <g.goller@proxmox.com>
---
 pbs-api-types/src/datastore.rs | 22 ++++++++++++++++++++++
 src/api2/config/datastore.rs   |  9 +++++++++
 2 files changed, 31 insertions(+)

diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
index 5e13c157..76b6ef43 100644
--- a/pbs-api-types/src/datastore.rs
+++ b/pbs-api-types/src/datastore.rs
@@ -309,6 +309,10 @@ pub struct DataStoreConfig {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub notify: Option<String>,
 
+    /// Opt in to the new notification system
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub notification_mode: Option<NotificationMode>,
+
     /// Datastore tuning options
     #[serde(skip_serializing_if = "Option::is_none")]
     pub tuning: Option<String>,
@@ -318,6 +322,23 @@ pub struct DataStoreConfig {
     pub maintenance_mode: Option<String>,
 }
 
+#[api]
+#[derive(Serialize, Deserialize, Updater, Clone, PartialEq, Default)]
+#[serde(rename_all = "kebab-case")]
+/// Configure how notifications for this datastore should be sent.
+/// `legacy-sendmail` sends email notifications to the user configured
+/// in `notify-user` via the system's `sendmail` executable.
+/// `notification-system` emits matchable notification events to the
+/// notification system.
+pub enum NotificationMode {
+    /// Send notifications via the system's sendmail command to the user
+    /// configured in `notify-user`
+    #[default]
+    LegacySendmail,
+    /// Emit notification events to the notification system
+    NotificationSystem,
+}
+
 impl DataStoreConfig {
     pub fn new(name: String, path: String) -> Self {
         Self {
@@ -330,6 +351,7 @@ impl DataStoreConfig {
             verify_new: None,
             notify_user: None,
             notify: None,
+            notification_mode: None,
             tuning: None,
             maintenance_mode: None,
         }
diff --git a/src/api2/config/datastore.rs b/src/api2/config/datastore.rs
index 3081e1f4..9a64c6a6 100644
--- a/src/api2/config/datastore.rs
+++ b/src/api2/config/datastore.rs
@@ -222,6 +222,8 @@ pub enum DeletableProperty {
     NotifyUser,
     /// Delete the notify property
     Notify,
+    /// Delete the notification-mode property
+    NotificationMode,
     /// Delete the tuning property
     Tuning,
     /// Delete the maintenance-mode property
@@ -315,6 +317,9 @@ pub fn update_datastore(
                 DeletableProperty::NotifyUser => {
                     data.notify_user = None;
                 }
+                DeletableProperty::NotificationMode => {
+                    data.notification_mode = None;
+                }
                 DeletableProperty::Tuning => {
                     data.tuning = None;
                 }
@@ -385,6 +390,10 @@ pub fn update_datastore(
         data.notify_user = update.notify_user;
     }
 
+    if update.notification_mode.is_some() {
+        data.notification_mode = update.notification_mode;
+    }
+
     if update.tuning.is_some() {
         data.tuning = update.tuning;
     }
-- 
2.39.2



_______________________________________________
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-22 12:39 UTC|newest]

Thread overview: 51+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-22 12:37 [pbs-devel] [PATCH many v4 00/43] integrate notification system Lukas Wagner
2024-04-22 12:37 ` [pbs-devel] [PATCH proxmox v4 01/43] notify: expose `config` module Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox v4 02/43] notify: use std::sync::OnceCell instead of lazy_static! Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox v4 03/43] notify: pbs-context: exclude successful prunes in default matcher Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox v4 04/43] notify: endpoints: matcher: improve descriptions for API types Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox v4 05/43] notify: add getter for notification timestamp Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH widget-toolkit v4 06/43] sendmail: smtp: allow to overide default mail author Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 07/43] pbs-config: add module for loading notification config Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 08/43] server: rename email_notifications module to notifications Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 09/43] notifications: allow sending notifications via proxmox_notify Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 10/43] buildsys: install templates for test notifications Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 11/43] pbs-config: acl: add /system/notifications as known ACL path Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 12/43] api: add endpoints for querying/testing notification targets Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 13/43] api: add endpoints for notification matchers Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 14/43] api: add endpoints for sendmail targets Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 15/43] api: add endpoints for smtp targets Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 16/43] api: add endpoints for gotify targets Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 17/43] api: add endpoints for querying known notification values/fields Lukas Wagner
2024-04-22 12:38 ` Lukas Wagner [this message]
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 19/43] api-types: api: tape: add notification-mode parameter Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 20/43] server: notifications: send GC notifications via notification system Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 21/43] server: notifications: send prune " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 22/43] server: notifications: send verify " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 23/43] server: notifications: send sync " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 24/43] server: notifications: send update " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 25/43] server: notifications: send acme " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 26/43] server: notifications: send tape " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 27/43] ui: add notification config panel Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 28/43] ui: tape backup job: add selector for notification-mode Lukas Wagner
2024-04-22 14:32   ` Dominik Csapak
2024-04-23  8:14     ` Lukas Wagner
2024-04-23  8:16       ` Dominik Csapak
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 29/43] ui: tape backup: add selector for 'notification-mode' Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 30/43] ui: tape restore: add 'notification-mode' parameter Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 31/43] ui: datastore options: " Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 32/43] ui: utils: add overrides for known notification metadata fields/values Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 33/43] ui: datastore edit: make new stores use notification system by default Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 34/43] ui: permissions paths: add /system/notifications to combobox Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 35/43] proxmox-backup-manager: add CLI for notification targets Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 36/43] proxmox-backup-manager: add CLI for notification matchers Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 37/43] proxmox-backup-manager: add CLI for gotify endpoints Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 38/43] proxmox-backup-manager: add CLI for sendmail endpoints Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 39/43] proxmox-backup-manager: add CLI for SMTP endpoints Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 40/43] docgen: generate synopsis for notifications{-priv, }.cfg Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 41/43] docs: add documentation for notification system Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 42/43] ui: util: override default mail author for sendmail/smtp targets Lukas Wagner
2024-04-22 12:38 ` [pbs-devel] [PATCH proxmox-backup v4 43/43] ui: notifications: pull in UX improvements for match rules creation Lukas Wagner
2024-04-22 13:58 ` [pbs-devel] [PATCH many v4 00/43] integrate notification system Maximiliano Sandoval
2024-04-23 11:44   ` Lukas Wagner
2024-04-22 14:24 ` Fabian Grünbichler
2024-04-23 11:13   ` 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=20240422123841.280675-19-l.wagner@proxmox.com \
    --to=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