From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v2 26/43] server: notifications: send acme notifications via notification system
Date: Wed, 17 Apr 2024 16:34:57 +0200 [thread overview]
Message-ID: <20240417143514.346233-27-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240417143514.346233-1-l.wagner@proxmox.com>
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Tested-by: Gabriel Goller <g.goller@proxmox.com>
Reviewed-by: Gabriel Goller <g.goller@proxmox.com>
---
debian/proxmox-backup-server.install | 2 ++
src/server/notifications.rs | 41 +++++++---------------
templates/Makefile | 24 +++++++------
templates/default/acme-err-body.txt.hbs | 7 ++++
templates/default/acme-err-subject.txt.hbs | 1 +
5 files changed, 35 insertions(+), 40 deletions(-)
create mode 100644 templates/default/acme-err-body.txt.hbs
create mode 100644 templates/default/acme-err-subject.txt.hbs
diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install
index 52a01ca5..17951780 100644
--- a/debian/proxmox-backup-server.install
+++ b/debian/proxmox-backup-server.install
@@ -41,6 +41,8 @@ usr/share/zsh/vendor-completions/_pmtx
usr/share/zsh/vendor-completions/_proxmox-backup-debug
usr/share/zsh/vendor-completions/_proxmox-backup-manager
usr/share/zsh/vendor-completions/_proxmox-tape
+usr/share/proxmox-backup/templates/default/acme-err-body.txt.hbs
+usr/share/proxmox-backup/templates/default/acme-err-subject.txt.hbs
usr/share/proxmox-backup/templates/default/gc-err-body.txt.hbs
usr/share/proxmox-backup/templates/default/gc-ok-body.txt.hbs
usr/share/proxmox-backup/templates/default/gc-err-subject.txt.hbs
diff --git a/src/server/notifications.rs b/src/server/notifications.rs
index 991ee11e..306c228d 100644
--- a/src/server/notifications.rs
+++ b/src/server/notifications.rs
@@ -86,18 +86,6 @@ Please visit the web interface for further details:
"###;
-const ACME_CERTIFICATE_ERR_RENEWAL: &str = r###"
-
-Proxmox Backup Server was not able to renew a TLS certificate.
-
-Error: {{error}}
-
-Please visit the web interface for further details:
-
-<https://{{fqdn}}:{{port}}/#pbsCertificateConfiguration>
-
-"###;
-
lazy_static::lazy_static! {
static ref HANDLEBARS: Handlebars<'static> = {
@@ -110,8 +98,6 @@ lazy_static::lazy_static! {
hb.register_template_string("tape_backup_ok_template", TAPE_BACKUP_OK_TEMPLATE)?;
hb.register_template_string("tape_backup_err_template", TAPE_BACKUP_ERR_TEMPLATE)?;
- hb.register_template_string("certificate_renewal_err_template", ACME_CERTIFICATE_ERR_RENEWAL)?;
-
Ok(())
});
@@ -598,23 +584,22 @@ pub fn send_certificate_renewal_mail(result: &Result<(), Error>) -> Result<(), E
_ => return Ok(()),
};
- if let Some(email) = lookup_user_email(Userid::root_userid()) {
- let (fqdn, port) = get_server_url();
+ let (fqdn, port) = get_server_url();
- let text = HANDLEBARS.render(
- "certificate_renewal_err_template",
- &json!({
- "fqdn": fqdn,
- "port": port,
- "error": error,
- }),
- )?;
+ let data = json!({
+ "fqdn": fqdn,
+ "port": port,
+ "error": error,
+ });
- let subject = "Could not renew certificate";
+ let metadata = HashMap::from([
+ ("hostname".into(), proxmox_sys::nodename().into()),
+ ("type".into(), "acme".into()),
+ ]);
- send_job_status_mail(&email, subject, &text)?;
- }
+ let notification = Notification::from_template(Severity::Info, "acme-err", data, metadata);
+ send_notification(notification)?;
Ok(())
}
@@ -673,6 +658,4 @@ pub fn lookup_datastore_notify_settings(
fn test_template_register() {
assert!(HANDLEBARS.has_template("tape_backup_ok_template"));
assert!(HANDLEBARS.has_template("tape_backup_err_template"));
-
- assert!(HANDLEBARS.has_template("certificate_renewal_err_template"));
}
diff --git a/templates/Makefile b/templates/Makefile
index 56965400..824d28d9 100644
--- a/templates/Makefile
+++ b/templates/Makefile
@@ -1,12 +1,14 @@
include ../defines.mk
-NOTIFICATION_TEMPLATES= \
- default/gc-err-body.txt.hbs \
- default/gc-ok-body.txt.hbs \
- default/gc-err-subject.txt.hbs \
- default/gc-ok-subject.txt.hbs \
- default/package-updates-body.txt.hbs \
- default/package-updates-subject.txt.hbs \
+NOTIFICATION_TEMPLATES= \
+ default/acme-err-body.txt.hbs \
+ default/acme-err-subject.txt.hbs \
+ default/gc-err-body.txt.hbs \
+ default/gc-ok-body.txt.hbs \
+ default/gc-err-subject.txt.hbs \
+ default/gc-ok-subject.txt.hbs \
+ default/package-updates-body.txt.hbs \
+ default/package-updates-subject.txt.hbs \
default/prune-err-body.txt.hbs \
default/prune-ok-body.txt.hbs \
default/prune-err-subject.txt.hbs \
@@ -14,10 +16,10 @@ NOTIFICATION_TEMPLATES= \
default/sync-err-body.txt.hbs \
default/sync-ok-body.txt.hbs \
default/sync-err-subject.txt.hbs \
- default/sync-ok-subject.txt.hbs \
- default/test-body.txt.hbs \
- default/test-body.html.hbs \
- default/test-subject.txt.hbs \
+ default/sync-ok-subject.txt.hbs \
+ default/test-body.txt.hbs \
+ default/test-body.html.hbs \
+ default/test-subject.txt.hbs \
default/verify-err-body.txt.hbs \
default/verify-ok-body.txt.hbs \
default/verify-err-subject.txt.hbs \
diff --git a/templates/default/acme-err-body.txt.hbs b/templates/default/acme-err-body.txt.hbs
new file mode 100644
index 00000000..3cbfea4a
--- /dev/null
+++ b/templates/default/acme-err-body.txt.hbs
@@ -0,0 +1,7 @@
+Proxmox Backup Server was not able to renew a TLS certificate.
+
+Error: {{error}}
+
+Please visit the web interface for further details:
+
+<https://{{fqdn}}:{{port}}/#pbsCertificateConfiguration>
diff --git a/templates/default/acme-err-subject.txt.hbs b/templates/default/acme-err-subject.txt.hbs
new file mode 100644
index 00000000..3cf4fe45
--- /dev/null
+++ b/templates/default/acme-err-subject.txt.hbs
@@ -0,0 +1 @@
+Could not renew certificate
--
2.39.2
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2024-04-17 14:36 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-17 14:34 [pbs-devel] [PATCH many v2 00/43] integrate " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 01/43] notify: expose `config` module Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 02/43] notify: use std::sync::OnceCell instead of lazy_static! Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 03/43] notify: pbs-context: exclude successful prunes in default matcher Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 04/43] notify: endpoints: matcher: improve descriptions for API types Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 05/43] notify: sys: move 'email' module from proxmox_sys to proxmox_notify Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 06/43] notify: add getter for notification timestamp Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH widget-toolkit v2 07/43] sendmail: smtp: allow to overide default mail author Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 08/43] pbs-config: add module for loading notification config Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 09/43] server: rename email_notifications module to notifications Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 10/43] notifications: allow sending notifications via proxmox_notify Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 11/43] buildsys: install templates for test notifications Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 12/43] pbs-config: acl: add /system/notifications as known ACL path Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 13/43] api: add endpoints for querying/testing notification targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 14/43] api: add endpoints for notification matchers Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 15/43] api: add endpoints for sendmail targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 16/43] api: add endpoints for smtp targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 17/43] api: add endpoints for gotify targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 18/43] api: add endpoints for querying known notification values/fields Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 19/43] api-types: api: datatore: add notification-mode parameter Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 20/43] api-types: api: tape: " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 21/43] server: notifications: send GC notifications via notification system Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 22/43] server: notifications: send prune " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 23/43] server: notifications: send verify " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 24/43] server: notifications: send sync " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 25/43] server: notifications: send update " Lukas Wagner
2024-04-17 14:34 ` Lukas Wagner [this message]
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 27/43] server: notifications: send tape " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 28/43] ui: add notification config panel Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 29/43] ui: tape backup job: add selector for notification-mode Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 30/43] ui: tape backup: add selector for 'notification-mode' Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 31/43] ui: tape restore: add 'notification-mode' parameter Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 32/43] ui: datastore options: " Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 33/43] ui: utils: add overrides for known notification metadata fields/values Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 34/43] ui: datastore edit: make new stores use notification system by default Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 35/43] ui: permissions paths: add /system/notifications to combobox Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 36/43] proxmox-backup-manager: add CLI for notification targets Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 37/43] proxmox-backup-manager: add CLI for notification matchers Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 38/43] proxmox-backup-manager: add CLI for gotify endpoints Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 39/43] proxmox-backup-manager: add CLI for sendmail endpoints Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 40/43] proxmox-backup-manager: add CLI for SMTP endpoints Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 41/43] docgen: generate synopsis for notifications{-priv, }.cfg Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 42/43] docs: add documentation for notification system Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 43/43] ui: util: override default mail author for sendmail/smtp targets 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=20240417143514.346233-27-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pbs-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