From: "Fabian Grünbichler" <f.gruenbichler@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Subject: Re: [pve-devel] [PATCH manager v7 02/19] api: jobs: vzdump: pass job 'job-id' parameter
Date: Thu, 04 Jul 2024 14:53:10 +0200 [thread overview]
Message-ID: <172009759069.180658.6701916029718316579@yuna.proxmox.com> (raw)
In-Reply-To: <20240610084038.71643-3-l.wagner@proxmox.com>
Quoting Lukas Wagner (2024-06-10 10:40:21)
> This allows us to access us the backup job id in the send_notification
> function, where we can set it as metadata for the notification.
should we have some sort of safeguard against passing in a bogus/fake job-id?
e.g., right now, I could call this API endpoint with arbitrary job-id values
and (potentially) trigger notifications to other users..
some possible avenues would be:
- limit the parameter to root (but that means only scheduled executions can set
it, manual invocations can't)
- limit to existing job-ids (doesn't provide much benefit)
- ..
>
> Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
> ---
> PVE/API2/VZDump.pm | 8 ++++++++
> PVE/Jobs/VZDump.pm | 4 +++-
> PVE/VZDump.pm | 6 +++---
> 3 files changed, 14 insertions(+), 4 deletions(-)
>
> diff --git a/PVE/API2/VZDump.pm b/PVE/API2/VZDump.pm
> index 7f92e7ec..84dbc100 100644
> --- a/PVE/API2/VZDump.pm
> +++ b/PVE/API2/VZDump.pm
> @@ -53,6 +53,14 @@ __PACKAGE__->register_method ({
> parameters => {
> additionalProperties => 0,
> properties => PVE::VZDump::Common::json_config_properties({
> + 'job-id' => {
> + description => "The ID of the backup job. If set, the 'backup-job' metadata field"
> + . " of the backup notification will be set to this value.",
> + type => 'string',
> + format => 'pve-configid',
> + maxLength => 256,
> + optional => 1,
> + },
> stdout => {
> type => 'boolean',
> description => "Write tar to stdout, not to a file.",
> diff --git a/PVE/Jobs/VZDump.pm b/PVE/Jobs/VZDump.pm
> index b8e57945..2dad3f55 100644
> --- a/PVE/Jobs/VZDump.pm
> +++ b/PVE/Jobs/VZDump.pm
> @@ -12,7 +12,7 @@ use PVE::API2::VZDump;
> use base qw(PVE::VZDump::JobBase);
>
> sub run {
> - my ($class, $conf) = @_;
> + my ($class, $conf, $job_id) = @_;
>
> my $props = $class->properties();
> # remove all non vzdump related options
> @@ -20,6 +20,8 @@ sub run {
> delete $conf->{$opt} if !defined($props->{$opt});
> }
>
> + $conf->{'job-id'} = $job_id;
> +
> # Required as string parameters # FIXME why?! we could just check ref()
> for my $key (keys $PVE::VZDump::Common::PROPERTY_STRINGS->%*) {
> if ($conf->{$key} && ref($conf->{$key}) eq 'HASH') {
> diff --git a/PVE/VZDump.pm b/PVE/VZDump.pm
> index 5b7080f3..2167b289 100644
> --- a/PVE/VZDump.pm
> +++ b/PVE/VZDump.pm
> @@ -483,6 +483,7 @@ sub send_notification {
> my ($self, $tasklist, $total_time, $err, $detail_pre, $detail_post) = @_;
>
> my $opts = $self->{opts};
> + my $job_id = $opts->{'job-id'};
> my $mailto = $opts->{mailto};
> my $cmdline = $self->{cmdline};
> my $policy = $opts->{mailnotification} // 'always';
> @@ -529,12 +530,11 @@ sub send_notification {
> };
>
> my $fields = {
> - # TODO: There is no straight-forward way yet to get the
> - # backup job id here... (I think pvescheduler would need
> - # to pass that to the vzdump call?)
> type => "vzdump",
> hostname => $hostname,
> };
> + # Add backup-job metadata field in case this is a backup job.
> + $fields->{'job-id'} = $job_id if $job_id;
>
> my $severity = $failed ? "error" : "info";
> my $email_configured = $mailto && scalar(@$mailto);
> --
> 2.39.2
>
>
>
> _______________________________________________
> pve-devel mailing list
> pve-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
>
>
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next prev parent reply other threads:[~2024-07-04 12:53 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-10 8:40 [pve-devel] [PATCH many v7 00/19] notifications: notification metadata matching improvements Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH pve-guest-common v7 01/19] vzdump: common: allow 'job-id' as a parameter without being in schema Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 02/19] api: jobs: vzdump: pass job 'job-id' parameter Lukas Wagner
2024-07-04 12:53 ` Fabian Grünbichler [this message]
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 03/19] ui: dc: backup: send 'job-id' property when starting a backup job manually Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 04/19] ui: dc: backup: allow to set custom job id in advanced settings Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 05/19] api: replication: add 'job-id' to notification metadata Lukas Wagner
2024-07-04 13:08 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 06/19] vzdump: apt: notification: do not include domain in 'hostname' field Lukas Wagner
2024-07-04 13:08 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 07/19] api: replication: include 'hostname' field for notifications Lukas Wagner
2024-07-04 13:08 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 08/19] api: notification: add API for getting known metadata fields/values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 09/19] ui: utils: add overrides for translatable notification fields/values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH manager v7 10/19] d/control: bump proxmox-widget-toolkit dependency to 4.1.4 Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 11/19] notification: matcher: match-field: show known fields/values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 12/19] notification: matcher: move match-field formulas to local viewModel Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 13/19] notification: matcher: move match-calendar fields to panel Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH widget-toolkit v7 14/19] notification: matcher: move match-severity " Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 15/19] notification: clarify that 'hostname' does not include the domain Lukas Wagner
2024-07-04 13:12 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 16/19] notifications: describe new notification metadata fields Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 17/19] notifications: match-field 'exact'-mode can now match multiple values Lukas Wagner
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 18/19] notifications: fix typo in 'notification' Lukas Wagner
2024-07-04 13:12 ` [pve-devel] applied: " Fabian Grünbichler
2024-06-10 8:40 ` [pve-devel] [PATCH docs v7 19/19] notifications: backport some rephrased parts from PBS docs Lukas Wagner
2024-07-04 13:13 ` [pve-devel] applied: " Fabian Grünbichler
2024-07-04 12:56 ` [pve-devel] [PATCH many v7 00/19] notifications: notification metadata matching improvements Fabian Grünbichler
2024-07-04 13:32 ` Lukas Wagner
2024-07-05 13:59 ` [pve-devel] superseded: " 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=172009759069.180658.6701916029718316579@yuna.proxmox.com \
--to=f.gruenbichler@proxmox.com \
--cc=pve-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox