all lists on lists.proxmox.com
 help / color / mirror / Atom feed
* [pve-devel] [PATCH docs/manager/widget-toolkit v5 00/16] notifications: notification metadata matching improvements
@ 2024-04-15  8:25 Lukas Wagner
  2024-04-15  8:25 ` [pve-devel] [PATCH manager v5 01/16] api: notifications: add 'smtp' to target index Lukas Wagner
                   ` (15 more replies)
  0 siblings, 16 replies; 29+ messages in thread
From: Lukas Wagner @ 2024-04-15  8:25 UTC (permalink / raw)
  To: pve-devel

This patch series attempts to improve the user experience when creating
notification matchers.

Some of the noteworthy changes:
  - Fixup inconsistent 'hostname' field. Some notification events sent
  the hostname including a domain, while other did not.
  This series unifies the behavior, now the field only includes the hostname
  without a domain. Also updated the docs to reflect this change.
  - Allow setting a custom backup job ID, similar how we handle it for
  sync/prune jobs in PBS (to allow recognizable names used in matchers)
  - Adding columns for backup job ID/replication job ID in the UI
  - New metadata fields:
    - backup-job: ID of the backup job (set for backups, unless they are 'ad-hoc' backups)
    - replication-job: ID of the replication job
  - Add an API that enumerates known notification metadata fields/values
  - Suggest known fields/values in match rule window
  - Some code clean up for match rule edit window
  - Extended the 'exact' match-field mode - it now allows setting multiple
    allowed values, separated via ',':
      e.g. `match-field exact:type=replication,fencing
    Originally, I created a separate 'list' match type for this, but
    since the semantics for a list with one value and 'exact' mode
    are identical, I decided to just extend 'exact'.
    This is a safe change since there are are no values where a ','
    makes any sense (config IDs, hostnames)

Inter-Dependencies:
  - the widget-toolkit dep in pve-manager needs to be bumped
    to at least 4.1.4
    (we need "utils: add mechanism to add and override translatable notification event
    descriptions in the product specific UIs", otherwise the UI breaks
    with the pve-manager patches applied)
  - widget-toolkit relies on a new API endpoint provided by pve-manager
  - the changes in the backend for matching multiple values in "exact"
    mode have already been rolled out as of libpve-rs-perl 0.8.8
    --> this means that libpve-notify-perl (which pulls in libpve-rs-perl)
    must depend on libpve-rs-perl 0.8.8 at minimum - otherwise
    the notification stack cannot understand the comma-separated
    array of matched values

Changelog:
  - v5:
    - Rebased onto latest master, resolving some small conflict
  - v4:
    - widget-toolkit: break out changes for the utils module so that they
      can be applied ahead of time to ease dep bumping
    - don't show Job IDs in the backup/replication job columns
  - v3:
    - Drop already applied patches for `proxmox`
    - Rebase onto latest master - minor conflict resolution was needed
  - v2:
    - include 'type' metadata field for forwarded mails
      --> otherwise it's not possible to match them
    - include Maximilliano's T-b trailer in UI patches

pve-manager:

Lukas Wagner (9):
  api: notifications: add 'smtp' to target index
  api: jobs: vzdump: pass job 'id' parameter
  ui: dc: backup: send 'id' property when starting a backup job manually
  ui: dc: backup: allow to set custom job id in  advanced settings
  api: replication: add 'replication-job' to notification metadata
  vzdump: apt: notification: do not include domain in 'hostname' field
  api: replication: include 'hostname' field for notifications
  api: notification: add API for getting known metadata fields/values
  ui: utils: add overrides for translatable notification fields/values

 PVE/API2/APT.pm                   |   3 +-
 PVE/API2/Cluster/Notifications.pm | 155 +++++++++++++++++++++++++++++-
 PVE/API2/Replication.pm           |   4 +-
 PVE/API2/VZDump.pm                |   8 ++
 PVE/Jobs/VZDump.pm                |   4 +-
 PVE/VZDump.pm                     |  14 +--
 www/manager6/Utils.js             |  16 +++
 www/manager6/dc/Backup.js         |  12 ++-
 8 files changed, 204 insertions(+), 12 deletions(-)


proxmox-widget-toolkit:

Lukas Wagner (4):
  notification: matcher: match-field: show known fields/values
  notification: matcher: move match-field formulas to local viewModel
  notification: matcher: move match-calendar fields to panel
  notification: matcher: move match-severity fields to panel

 src/data/model/NotificationConfig.js  |  12 +
 src/window/NotificationMatcherEdit.js | 613 ++++++++++++++++++--------
 2 files changed, 441 insertions(+), 184 deletions(-)


pve-docs:

Lukas Wagner (3):
  notification: clarify that 'hostname' does not include the domain
  notifications: describe new notification metadata fields
  notifications: match-field 'exact'-mode can now match multiple values

 notifications.adoc | 39 ++++++++++++++++++---------------------
 1 file changed, 18 insertions(+), 21 deletions(-)


Summary over all repositories:
  11 files changed, 663 insertions(+), 217 deletions(-)

-- 
Generated by git-murpp 0.7.1




^ permalink raw reply	[flat|nested] 29+ messages in thread

end of thread, other threads:[~2024-04-19 14:01 UTC | newest]

Thread overview: 29+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-04-15  8:25 [pve-devel] [PATCH docs/manager/widget-toolkit v5 00/16] notifications: notification metadata matching improvements Lukas Wagner
2024-04-15  8:25 ` [pve-devel] [PATCH manager v5 01/16] api: notifications: add 'smtp' to target index Lukas Wagner
2024-04-19 10:47   ` [pve-devel] applied: " Fiona Ebner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 02/16] api: jobs: vzdump: pass job 'id' parameter Lukas Wagner
2024-04-19 11:53   ` Fiona Ebner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 03/16] ui: dc: backup: send 'id' property when starting a backup job manually Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 04/16] ui: dc: backup: allow to set custom job id in advanced settings Lukas Wagner
2024-04-19 10:22   ` Fiona Ebner
2024-04-19 10:31   ` Fiona Ebner
2024-04-19 12:23     ` Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 05/16] api: replication: add 'replication-job' to notification metadata Lukas Wagner
2024-04-19 12:02   ` Fiona Ebner
2024-04-19 12:22     ` Lukas Wagner
2024-04-19 13:11       ` Fiona Ebner
2024-04-19 13:15         ` Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 06/16] vzdump: apt: notification: do not include domain in 'hostname' field Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 07/16] api: replication: include 'hostname' field for notifications Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 08/16] api: notification: add API for getting known metadata fields/values Lukas Wagner
2024-04-19 12:59   ` Fiona Ebner
2024-04-19 13:45   ` Fiona Ebner
2024-04-19 14:01     ` Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH manager v5 09/16] ui: utils: add overrides for translatable notification fields/values Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 10/16] notification: matcher: match-field: show known fields/values Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 11/16] notification: matcher: move match-field formulas to local viewModel Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 12/16] notification: matcher: move match-calendar fields to panel Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH widget-toolkit v5 13/16] notification: matcher: move match-severity " Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH docs v5 14/16] notification: clarify that 'hostname' does not include the domain Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH docs v5 15/16] notifications: describe new notification metadata fields Lukas Wagner
2024-04-15  8:26 ` [pve-devel] [PATCH docs v5 16/16] notifications: match-field 'exact'-mode can now match multiple values Lukas Wagner

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