konevsa/proxmox
1
0
Fork 0
forked from Proxmox/proxmox
Code Pull Requests Activity
master
proxmox/proxmox-notify/Cargo.toml

45 lines
1.4 KiB
TOML
Raw Permalink Normal View History

add proxmox-notify crate Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:30 +03:00
[package]
name = "proxmox-notify"
tree-wide: unify workspace inherited attributes Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-09-20 09:42:25 +03:00
description = "implementation of notification base and plugins"
notify: bump to 0.4.2-1 Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-07-11 16:18:46 +03:00
version = "0.4.2"
tree-wide: unify workspace inherited attributes Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-09-20 09:42:25 +03:00
add proxmox-notify crate Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:30 +03:00
authors.workspace = true
edition.workspace = true
tree-wide: unify workspace inherited attributes Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-09-20 09:42:25 +03:00
exclude.workspace = true
homepage.workspace = true
add proxmox-notify crate Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:30 +03:00
license.workspace = true
repository.workspace = true
tree-wide: unify workspace inherited attributes Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-09-20 09:42:25 +03:00
rust-version.workspace = true
add proxmox-notify crate Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:30 +03:00
[dependencies]
notify: replace filters and groups with matcher-based system This shifts notification routing into the matcher-system. Every notification has associated metadata (key-value fields, severity - to be extended) that can be match with match directives in notification matchers. Right now, there are 2 matching directives, match-field and match-severity. The first one allows one to do a regex match/exact match on a metadata field, the other one allows one to match one or more severites. Every matcher also allows 'target' directives, these decide which target(s) will be notified if a matcher matches a notification. Since routing now happens in matchers, the API for sending is simplified, since we do not need to specify a target any more. The API routes for filters and groups have been removed completely. The parser for the configuration file will still accept filter/group entries, but will delete them once the config is saved again. This is needed to allow a smooth transition from the old system to the new system, since the old system was already available on pvetest. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:13 +03:00
anyhow.workspace = true
notify: copy sendmail/forward fn's from proxmox_sys proxmox_notify is the only user of those functions, so it makes sense to move them here. A future commit will mark the original functions from proxmox_sys as deprecated. The functions were slightly modified, mostly to not rely on anyhow for error reporting. Also they are now private functions. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2024-06-24 15:31:29 +03:00
base64.workspace = true
notify: adapt to proxmox_schema changes, use const_format Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-03-19 12:29:27 +03:00
const_format.workspace = true
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
handlebars = { workspace = true }
notify: add 'smtp' endpoint This commit adds a new endpoint type, namely 'smtp'. This endpoint uses the `lettre` crate to directly send emails to SMTP relays. The `lettre` crate was chosen since it is by far the most popular SMTP implementation for Rust that looks like it is well maintained. Also, it includes async support (for when we want to extend proxmox-notify to be async). For this new endpoint type, a new section-config type was introduced (smtp). It has the same fields as the type for `sendmail`, with the addition of some new options (smtp server, authentication, tls mode, etc.). Some of the behavior that is shared between sendmail and smtp endpoints has been moved to a new `endpoints::common::mail` module. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:20 +03:00
lettre = { workspace = true, optional = true }
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
log.workspace = true
notify: add mechanisms for email message forwarding As preparation for the integration of `proxmox-mail-foward` into the notification system, this commit makes a few changes that allow us to forward raw email messages (as passed from postfix). For mail-based notification targets, the email will be forwarded as-is, including all headers. The only thing that changes is the message envelope. For other notification targets, the mail is parsed using the `mail-parser` crate, which allows us to extract a subject and a body. As a body we use the plain-text version of the mail. If an email is HTML-only, the `mail-parser` crate will automatically attempt to transform the HTML into readable plain text. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:18 +03:00
mail-parser = { workspace = true, optional = true }
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
openssl.workspace = true
notify: sort and group dependencies Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-03-19 12:27:25 +03:00
regex.workspace = true
notify: cargo.toml: add spaces before curly braces Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> Reviewed-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-19 17:17:09 +03:00
serde = { workspace = true, features = ["derive"] }
notify: sort and group dependencies Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-03-19 12:27:25 +03:00
serde_json.workspace = true
notify: add gotify endpoint Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations. [1] https://gotify.net/ Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:36 +03:00
proxmox-http = { workspace = true, features = ["client-sync"], optional = true }
notify: use HttpError from proxmox-http-error Also improve API documentation in terms of which HttpError is returned when. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-26 17:18:23 +03:00
proxmox-http-error.workspace = true
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
proxmox-human-byte.workspace = true
notify: cargo.toml: add spaces before curly braces Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> Reviewed-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-19 17:17:09 +03:00
proxmox-schema = { workspace = true, features = ["api-macro", "api-types"] }
notify: preparation for the first endpoint plugin Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:31 +03:00
proxmox-section-config = { workspace = true }
notify: sort and group dependencies Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2024-03-19 12:27:25 +03:00
proxmox-serde.workspace = true
notify: add sendmail plugin This plugin uses the 'sendmail' command to send an email to one or more recipients. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:34 +03:00
proxmox-sys = { workspace = true, optional = true }
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
proxmox-time.workspace = true
notify: give each notification a unique ID We need this for queuing notifications on PBS from the unprivileged proxy process. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> Reviewed-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-19 17:17:10 +03:00
proxmox-uuid = { workspace = true, features = ["serde"] }
notify: add sendmail plugin This plugin uses the 'sendmail' command to send an email to one or more recipients. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:34 +03:00
[features]
notify: add 'smtp' endpoint This commit adds a new endpoint type, namely 'smtp'. This endpoint uses the `lettre` crate to directly send emails to SMTP relays. The `lettre` crate was chosen since it is by far the most popular SMTP implementation for Rust that looks like it is well maintained. Also, it includes async support (for when we want to extend proxmox-notify to be async). For this new endpoint type, a new section-config type was introduced (smtp). It has the same fields as the type for `sendmail`, with the addition of some new options (smtp server, authentication, tls mode, etc.). Some of the behavior that is shared between sendmail and smtp endpoints has been moved to a new `endpoints::common::mail` module. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:20 +03:00
default = ["sendmail", "gotify", "smtp"]
notify: make the `mail-forwarder` feature depend on proxmox-sys It uses proxmox_sys::nodename - the dep is needed, otherwise the code does not compile in some feature flag permutations. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com> Tested-by: Folke Gleumes <f.gleumes@proxmox.com> Reviewed-by: Fiona Ebner <f.ebner@proxmox.com>
2024-04-19 17:17:08 +03:00
mail-forwarder = ["dep:mail-parser", "dep:proxmox-sys"]
notify: add template rendering This commit adds template rendering to the `proxmox-notify` crate, based on the `handlebars` crate. Title and body of a notification are rendered using any `properties` passed along with the notification. There are also a few helpers, allowing to render tables from `serde_json::Value`. 'Value' renderers. These can also be used in table cells using the 'renderer' property in a table schema: - {{human-bytes val}} Render bytes with human-readable units (base 2) - {{duration val}} Render a duration (based on seconds) - {{timestamp val}} Render a unix-epoch (based on seconds) There are also a few 'block-level' helpers. - {{table val}} Render a table from given val (containing a schema for the columns, as well as the table data) - {{object val}} Render a value as a pretty-printed json - {{heading_1 val}} Render a top-level heading - {{heading_2 val}} Render a not-so-top-level heading - {{verbatim val}} or {{/verbatim}}<content>{{#verbatim}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a regular font. - {{verbatim-monospaced val}} or {{/verbatim-monospaced}}<content>{{#verbatim-monospaced}} Do not reflow text. NOP for plain text, but for HTML output the text will be contained in a <pre> with a monospaced font. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:42 +03:00
sendmail = ["dep:proxmox-sys"]
notify: add gotify endpoint Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations. [1] https://gotify.net/ Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-07-20 17:31:36 +03:00
gotify = ["dep:proxmox-http"]
notify: add PVE/PBS context This commit moves PVEContext from `proxmox-perl-rs` into the `proxmox-notify` crate, since we now also need to access it from `promxox-mail-forward`. The context is now hidden behind a feature flag `pve-context`, ensuring that we only compile it when needed. This commit adds PBSContext, since we now require it for `proxmox-mail-forward`. Some of the code for PBSContext comes from `proxmox-mail-forward`. This commit also changes the global context from being stored in a `once_cell` to a regular `Mutex`, since we now need to set/reset the context in `proxmox-mail-forward`. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:19 +03:00
pve-context = ["dep:proxmox-sys"]
pbs-context = ["dep:proxmox-sys"]
notify: add 'smtp' endpoint This commit adds a new endpoint type, namely 'smtp'. This endpoint uses the `lettre` crate to directly send emails to SMTP relays. The `lettre` crate was chosen since it is by far the most popular SMTP implementation for Rust that looks like it is well maintained. Also, it includes async support (for when we want to extend proxmox-notify to be async). For this new endpoint type, a new section-config type was introduced (smtp). It has the same fields as the type for `sendmail`, with the addition of some new options (smtp server, authentication, tls mode, etc.). Some of the behavior that is shared between sendmail and smtp endpoints has been moved to a new `endpoints::common::mail` module. Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-14 15:59:20 +03:00
smtp = ["dep:lettre"]
Copy Permalink