public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox-mail-forward v2 62/63] add pve-notify-worker crate and package
Date: Wed, 18 Nov 2026 10:43:46 +0100	[thread overview]
Message-ID: <20261118094348.273646-63-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261118094348.273646-1-l.wagner@proxmox.com>

This new daemon hosts the notification worker task from proxmox-notify
for Proxmox VE. It processes PVE's notification queue at
/var/lib/pve-manager/notifications/queue, including mails submitted by
the mail forwarder, and is meant to be pulled in as a service
dependency by pve-manager.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 Cargo.toml                          |  6 +++
 Makefile                            | 12 ++++--
 debian/control                      |  7 ++++
 debian/proxmox-mail-forward.install |  1 +
 debian/pve-notify-worker.install    |  1 +
 debian/pve-notify-worker.service    | 13 ++++++
 debian/rules                        |  2 +-
 pve-notify-worker/Cargo.toml        | 21 ++++++++++
 pve-notify-worker/src/main.rs       | 64 +++++++++++++++++++++++++++++
 9 files changed, 122 insertions(+), 5 deletions(-)
 create mode 100644 debian/proxmox-mail-forward.install
 create mode 100644 debian/pve-notify-worker.install
 create mode 100644 debian/pve-notify-worker.service
 create mode 100644 pve-notify-worker/Cargo.toml
 create mode 100644 pve-notify-worker/src/main.rs

diff --git a/Cargo.toml b/Cargo.toml
index 27e4d8e..59e94c0 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,6 +2,7 @@
 members = [
     "common",
     "proxmox-mail-forward",
+    "pve-notify-worker",
 ]
 resolver = "3"
 
@@ -18,8 +19,13 @@ homepage = "https://www.proxmox.com"
 
 [workspace.dependencies]
 anyhow = "1.0"
+futures = "0.3"
 nix = "0.29"
+tokio = "1.6"
+tracing = "0.1"
 
+proxmox-async = "0.5"
+proxmox-daemon = "1"
 proxmox-log = "1"
 proxmox-notify = "2"
 proxmox-sys = "1"
diff --git a/Makefile b/Makefile
index 0c7dc72..384037a 100644
--- a/Makefile
+++ b/Makefile
@@ -8,8 +8,10 @@ BUILDDIR ?= $(PACKAGE)-$(DEB_VERSION)
 DSC=rust-$(PACKAGE)_$(DEB_VERSION_UPSTREAM).dsc
 DEB=$(PACKAGE)_$(DEB_VERSION)_$(DEB_HOST_ARCH).deb
 DBG_DEB=$(PACKAGE)-dbgsym_$(DEB_VERSION)_$(DEB_HOST_ARCH).deb
+WORKER_DEB=pve-notify-worker_$(DEB_VERSION)_$(DEB_HOST_ARCH).deb
+WORKER_DBG_DEB=pve-notify-worker-dbgsym_$(DEB_VERSION)_$(DEB_HOST_ARCH).deb
 
-DEBS=$(DEB) $(DBG_DEB)
+DEBS=$(DEB) $(DBG_DEB) $(WORKER_DEB) $(WORKER_DBG_DEB)
 
 ifeq ($(BUILD_MODE), release)
 CARGO_BUILD_ARGS += --release --target $(DEB_HOST_RUST_TYPE)
@@ -22,7 +24,7 @@ CARGO ?= cargo
 
 $(BUILDDIR):
 	rm -rf $@ $@.tmp && mkdir $@.tmp
-	cp -a debian Cargo.toml common proxmox-mail-forward Makefile .cargo $@.tmp
+	cp -a debian Cargo.toml common proxmox-mail-forward pve-notify-worker Makefile .cargo $@.tmp
 	rm -f $@.tmp/Cargo.lock
 	find $@.tmp/debian -name "*.hint" -delete
 	mv $@.tmp $@
@@ -50,11 +52,13 @@ dinstall: $(DEBS)
 .PHONY: cargo-build
 cargo-build:
 	$(CARGO) build $(CARGO_BUILD_ARGS) \
-	    --package proxmox-mail-forward
+	    --package proxmox-mail-forward \
+	    --package pve-notify-worker
 
 install: cargo-build
-	install -d $(DESTDIR)/usr/libexec
+	install -d $(DESTDIR)/usr/libexec/proxmox
 	install -m 0755 $(COMPILEDIR)/proxmox-mail-forward $(DESTDIR)/usr/libexec/
+	install -m 0755 $(COMPILEDIR)/pve-notify-worker $(DESTDIR)/usr/libexec/proxmox/
 
 .PHONY: upload
 upload: $(DEBS)
diff --git a/debian/control b/debian/control
index ebf96e1..3e574b7 100644
--- a/debian/control
+++ b/debian/control
@@ -30,3 +30,10 @@ Depends: ${misc:Depends}, ${shlibs:Depends},
 Description: Proxmox mail forward helper
  This package contains the Proxmox mail forward helper. It forwards mails to
  the address(es) of the root@pam user in Proxmox Backup Server and Proxmox VE.
+
+Package: pve-notify-worker
+Architecture: any
+Depends: ${misc:Depends}, ${shlibs:Depends},
+Description: Proxmox VE notification worker
+ This package contains the worker that processes the notification queue of
+ Proxmox VE.
diff --git a/debian/proxmox-mail-forward.install b/debian/proxmox-mail-forward.install
new file mode 100644
index 0000000..1b08c0b
--- /dev/null
+++ b/debian/proxmox-mail-forward.install
@@ -0,0 +1 @@
+usr/libexec/proxmox-mail-forward
diff --git a/debian/pve-notify-worker.install b/debian/pve-notify-worker.install
new file mode 100644
index 0000000..abdcdf7
--- /dev/null
+++ b/debian/pve-notify-worker.install
@@ -0,0 +1 @@
+usr/libexec/proxmox/pve-notify-worker
diff --git a/debian/pve-notify-worker.service b/debian/pve-notify-worker.service
new file mode 100644
index 0000000..dccbb61
--- /dev/null
+++ b/debian/pve-notify-worker.service
@@ -0,0 +1,13 @@
+[Unit]
+Description=Proxmox VE notification worker
+Wants=network-online.target
+After=network-online.target
+
+[Service]
+Type=exec
+ExecStart=/usr/libexec/proxmox/pve-notify-worker
+KillSignal=SIGINT
+Restart=on-failure
+
+[Install]
+WantedBy=multi-user.target
diff --git a/debian/rules b/debian/rules
index ddde12f..2049ba3 100755
--- a/debian/rules
+++ b/debian/rules
@@ -25,7 +25,7 @@ override_dh_auto_configure:
 	$(CARGO) prepare-debian $(CURDIR)/debian/cargo_registry --link-from-system
 	dh_auto_configure
 
-execute_after_dh_auto_install:
+execute_after_dh_install:
 	chmod u+s debian/proxmox-mail-forward/usr/libexec/proxmox-mail-forward
 
 override_dh_fixperms:
diff --git a/pve-notify-worker/Cargo.toml b/pve-notify-worker/Cargo.toml
new file mode 100644
index 0000000..61738e9
--- /dev/null
+++ b/pve-notify-worker/Cargo.toml
@@ -0,0 +1,21 @@
+[package]
+name = "pve-notify-worker"
+description = "Proxmox VE notification worker"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+
+[dependencies]
+anyhow.workspace = true
+futures.workspace = true
+tokio = { workspace = true, features = [ "full" ] }
+tracing.workspace = true
+
+common.workspace = true
+
+proxmox-async.workspace = true
+proxmox-daemon.workspace = true
+proxmox-log.workspace = true
+proxmox-notify = { workspace = true, features = [ "send-impl", "queue-worker", "pve-context", "legacy-matchers" ]}
diff --git a/pve-notify-worker/src/main.rs b/pve-notify-worker/src/main.rs
new file mode 100644
index 0000000..5f13b25
--- /dev/null
+++ b/pve-notify-worker/src/main.rs
@@ -0,0 +1,64 @@
+//! This binary hosts the notification worker for PVE.
+//!
+//! When sending a notification, it is written as a JSON file into the queue directory at
+//! `/var/lib/pve-manager/notifications/queue`.
+//!
+//! The notification worker will periodically read the contents of the queue directory and process
+//! any notification that was put there.
+//!
+//! The worker task was implemented in such a way that it tries to finish sending the currently
+//! handled notification in case of a requested daemon shutdown. If there are multiple
+//! notifications in the queue, they are handled one-by-one, giving ample opportunities for
+//! a clean shutdown.
+
+#![deny(unsafe_code)]
+#![deny(missing_docs)]
+
+use std::time::Duration;
+
+use anyhow::{Context, Error};
+use tracing::level_filters::LevelFilter;
+
+use proxmox_notify::context::pve::PVEContext;
+use proxmox_notify::queue::{QueueConsumer, QueueWorker};
+
+use common::Product;
+
+fn main() -> Result<(), Error> {
+    proxmox_log::Logger::from_env("PVE_LOG", LevelFilter::INFO)
+        .journald()
+        .init()?;
+
+    proxmox_async::runtime::main(run())
+}
+
+async fn run() -> Result<(), Error> {
+    let signal_task = proxmox_daemon::shutdown_signal_task().context("unable to start daemon")?;
+    tokio::task::spawn(signal_task);
+
+    tracing::info!("PVE notification worker starting up");
+
+    start_notification_worker().await?;
+
+    tracing::info!("PVE notification worker shutting down");
+
+    Ok(())
+}
+
+/// Start the notification worker task
+async fn start_notification_worker() -> Result<(), Error> {
+    let consumer = QueueConsumer::new(Product::Pve.queue_dir());
+
+    let notification_worker = std::pin::pin!(
+        QueueWorker::builder(proxmox_notify::Context::new(PVEContext), consumer)
+            .interval(Duration::from_secs(5))
+            .retry_attempts(2)
+            .build()
+            .run()
+    );
+
+    let abort_future = std::pin::pin!(proxmox_daemon::shutdown_future());
+    futures::future::select(notification_worker, abort_future).await;
+
+    Ok(())
+}
-- 
2.47.3





  parent reply	other threads:[~2026-11-18  9:52 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-18  9:42 [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 01/63] notify: disallow `unsafe` code Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 02/63] notify: refactor error type Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 03/63] notify: move `Endpoint` trait to endpoint module as pub(crate) Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 04/63] notify: use ConfigDigest instead of raw byte arrays Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 05/63] notify: remove static context and pass context as parameter Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 06/63] notify: matcher: drop unused field matcher verifiers Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 07/63] notify: introduce 'send-impl', 'api-impl' and 'api-types' features Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 08/63] notify: matcher: make matcher validation methods public Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 09/63] notify: matcher: stub CalendarMatcher::matches on wasm32 Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 10/63] notify: make SendmailEndpoint and SmtpEndpoint private types Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 11/63] notify: move `send`, `test_target` and `Bus` to new `send` module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 12/63] notify: move Origin type to api_types module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 13/63] notify: move Target " Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 14/63] notify: move Config to config module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 15/63] notify: move Notification and sub-types to `notification` module Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 16/63] notify: move schema module to api_types Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 17/63] notify: move check_matches from api_types::matcher to send::Bus Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 18/63] notify: move TemplateSource to context module Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 19/63] notify: config: cleanup helper names and visibility Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 20/63] notify: config: rename section config parser/writer methods Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 21/63] notify: config: pass builtins explicitly when parsing section config Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 22/63] notify: implement PartialEq for all Config types Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 23/63] notify: use typed SectionConfigData Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 24/63] notify: api: api types: rename Deleteable* -> Deletable* Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 25/63] notify: context: parse builtin config only once Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 26/63] notify: context: parse proxy config in trait impl, not at the callsite Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 27/63] notify: gate sub-modules with the appropriate feature flags Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 28/63] notify: fold mail-forwarder feature into send-impl Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 29/63] notify: forwarded mails: don't hardcode severity and metadata fields Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 30/63] notify: don't pass uid when instantiating forwarded mail notifications Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 31/63] notify: derive PartialEq for Notification type Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 32/63] notify: add getters for severity and fields on " Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 33/63] notify: add test suite for " Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 34/63] notify: serialize raw, forwarded mail content as base64 Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 35/63] notify: unify code paths for legacy-sendmail and regular notifications Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 36/63] notify: add backwards-compat note to Notification type Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 37/63] notify: remove 'test_target' API Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 38/63] notify: replace notification instantiation with builder pattern Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 39/63] notify: add send receipts Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 40/63] notify: make sure that template name matches SAFE_ID_REGEX Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 41/63] notify: implement notification queue submitter Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 42/63] notify: context: add read_config Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 43/63] notify: queue: add queue consumer Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 44/63] notify: queue: add worker task Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 45/63] notifications: don't ignore verification errors in legacy-sendmail mode Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 46/63] notifications: adapt to proxmox-notify API changes Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 47/63] api: notification: send test notification via proxmox_notify::send Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 48/63] notifications: send all notifications via proxmox-notify's queue Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-perl-rs v2 49/63] pve: notify: adapt to changes in the public API of proxmox-notify Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-perl-rs v2 50/63] pve: notify: add `PVE::RS::Notify::enqueue` method Lukas Wagner
2026-11-18  9:43 ` [PATCH pve-cluster v2 51/63] notify: send notifications via notification queue Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 52/63] vzdump: send legacy-sendmail notifications via simplified API Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 53/63] debian: create notification queue directory via tmpfiles Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 54/63] debian: add 'pve-notify-worker' as dependecy Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 55/63] api: services: add 'pve-notify-worker' as known service Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 56/63] services: request pve-notify-worker.service via Wants Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 57/63] forward mails via notification queue Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 58/63] use return code to signal permanent or temporary failure Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 59/63] limit size of mail read from stdin Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 60/63] cargo: move mail forwarder into a workspace member crate Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 61/63] add crate for code shared between the mail-forwarder and the worker Lukas Wagner
2026-11-18  9:43 ` Lukas Wagner [this message]
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 63/63] debian: add versioned break for pve-manager and proxmox-backup-server Lukas Wagner
2026-11-18 21:44 ` [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Thomas Lamprecht
2026-11-19 10:45   ` 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=20261118094348.273646-63-l.wagner@proxmox.com \
    --to=l.wagner@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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal