[pve-devel] [PATCH docs v6 15/16] notifications: describe new notification metadata fields

[Fiona Ebner]

Am 22.04.24 um 10:31 schrieb Lukas Wagner:
> Signed-off-by: Lukas Wagner <l.wagner at proxmox.com>
> ---
>  notifications.adoc | 20 +++++++++++---------
>  1 file changed, 11 insertions(+), 9 deletions(-)
> 
> diff --git a/notifications.adoc b/notifications.adoc
> index 57053c8..dec878a 100644
> --- a/notifications.adoc
> +++ b/notifications.adoc
> @@ -289,19 +289,21 @@ Notification Events
>  
>  [width="100%",options="header"]
>  |===========================================================================
> -| Event                        | `type`            | Severity | Metadata fields (in addition to `type`)
> -| System updates available     |`package-updates`  | `info`   | `hostname`
> -| Cluster node fenced          |`fencing`          | `error`  | `hostname`
> -| Storage replication failed   |`replication`      | `error`  | -
> -| Backup finished              |`vzdump`           | `info` (`error` on failure) | `hostname`
> -| Mail for root                |`system-mail`      | `unknown`| -
> +| Event                            | `type`            | Severity | Metadata fields (in addition to `type`)
> +| System updates available         |`package-updates`  | `info`   | `hostname`
> +| Cluster node fenced              |`fencing`          | `error`  | `hostname`
> +| Storage replication job failed   |`replication`      | `error`  | `hostname`, `job-id`
> +| Backup succeeded                 |`vzdump`           | `info`   | `hostname`, `job-id` (only for backup jobs)
> +| Backup failed                    |`vzdump`           | `error`  | `hostname`, `job-id` (only for backup jobs)

I think the "(only for backup jobs)" should not be there, or?

> +| Mail for root                    |`system-mail`      | `unknown`| `hostname`
>  |===========================================================================
>  
>  [width="100%",options="header"]
>  |=======================================================================
> -| Field name | Description
> -| `type`     | Type of the notifcation
> -| `hostname` | Hostname, without domain (e.g. `pve1`)
> +| Field name        | Description
> +| `type`            | Type of the notifcation

Pre-existing typo: s/notfcation/notification

> +| `hostname`        | Hostname, without domain (e.g. `pve1`)
> +| `job-id`          | Job ID
>  |=======================================================================
>  
>  System Mail Forwarding