[pve-devel] [PATCH v2 pve-manager 27/52] vzdump: adapt to new matcher based notification system
Lukas Wagner
l.wagner at proxmox.com
Tue Nov 14 13:59:35 CET 2023
To ease the migration from old-style mailto/mailnotification paramters
for backup jobs, the code will add a ephemeral sendmail endpoint and
a matcher.
Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
---
PVE/API2/VZDump.pm | 8 +-------
PVE/VZDump.pm | 40 +++++++++++++++++++---------------------
2 files changed, 20 insertions(+), 28 deletions(-)
diff --git a/PVE/API2/VZDump.pm b/PVE/API2/VZDump.pm
index 3886772e..f66fc740 100644
--- a/PVE/API2/VZDump.pm
+++ b/PVE/API2/VZDump.pm
@@ -44,9 +44,7 @@ __PACKAGE__->register_method ({
."'Datastore.AllocateSpace' on the backup storage. The 'tmpdir', 'dumpdir' and "
."'script' parameters are restricted to the 'root\@pam' user. The 'maxfiles' and "
."'prune-backups' settings require 'Datastore.Allocate' on the backup storage. The "
- ."'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'. "
- ."If 'notification-target' is set, then the 'Mapping.Use' permission is needed on "
- ."'/mapping/notification/<target>'.",
+ ."'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'. ",
user => 'all',
},
protected => 1,
@@ -115,10 +113,6 @@ __PACKAGE__->register_method ({
$rpcenv->check($user, "/storage/$storeid", [ 'Datastore.AllocateSpace' ]);
}
- if (my $target = $param->{'notification-target'}) {
- PVE::Notify::check_may_use_target($target, $rpcenv);
- }
-
my $worker = sub {
my $upid = shift;
diff --git a/PVE/VZDump.pm b/PVE/VZDump.pm
index 454ab494..b0574d41 100644
--- a/PVE/VZDump.pm
+++ b/PVE/VZDump.pm
@@ -452,20 +452,18 @@ sub send_notification {
my $opts = $self->{opts};
my $mailto = $opts->{mailto};
my $cmdline = $self->{cmdline};
- my $target = $opts->{"notification-target"};
- # Fall back to 'mailnotification' if 'notification-policy' is not set.
- # If both are set, 'notification-policy' takes precedence
- my $policy = $opts->{"notification-policy"} // $opts->{mailnotification} // 'always';
+ # Old-style notification policy. This parameter will influce
+ # if an ad-hoc notification target/matcher will be created.
+ my $policy = $opts->{"notification-policy"} //
+ $opts->{mailnotification} //
+ 'always';
- return if ($policy eq 'never');
sanitize_task_list($tasklist);
my $error_count = count_failed_tasks($tasklist);
my $failed = ($error_count || $err);
- return if (!$failed && ($policy eq 'failure'));
-
my $status_text = $failed ? 'backup failed' : 'backup successful';
if ($err) {
@@ -489,8 +487,10 @@ sub send_notification {
"See Task History for details!\n";
};
+ my $hostname = get_hostname();
+
my $notification_props = {
- "hostname" => get_hostname(),
+ "hostname" => $hostname,
"error-message" => $err,
"guest-table" => build_guest_table($tasklist),
"logs" => $text_log_part,
@@ -498,9 +498,16 @@ sub send_notification {
"total-time" => $total_time,
};
+ my $fields = {
+ type => "vzdump",
+ hostname => $hostname,
+ };
+
my $notification_config = PVE::Notify::read_config();
- if ($mailto && scalar(@$mailto)) {
+ my $legacy_sendmail = $policy eq "always" || ($policy eq "failure" && $failed);
+
+ if ($mailto && scalar(@$mailto) && $legacy_sendmail) {
# <, >, @ are not allowed in endpoint names, but that is only
# verified once the config is serialized. That means that
# we can rely on that fact that no other endpoint with this name exists.
@@ -514,29 +521,20 @@ sub send_notification {
my $endpoints = [$endpoint_name];
- # Create an anonymous group containing the sendmail endpoint and the
- # $target endpoint, if specified
- if ($target) {
- push @$endpoints, $target;
- }
-
- $target = "<group-$endpoint_name>";
- $notification_config->add_group(
- $target,
+ $notification_config->add_matcher(
+ "<matcher-$endpoint_name>",
$endpoints,
);
}
- return if (!$target);
-
my $severity = $failed ? "error" : "info";
PVE::Notify::notify(
- $target,
$severity,
$subject_template,
$body_template,
$notification_props,
+ $fields,
$notification_config
);
};
--
2.39.2
More information about the pve-devel
mailing list