From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
	by lore.proxmox.com (Postfix) with ESMTPS id 8F5101FF380
	for <inbox@lore.proxmox.com>; Fri, 19 Apr 2024 10:45:51 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 2C9871AEE;
	Fri, 19 Apr 2024 10:45:53 +0200 (CEST)
Message-ID: <95b8c12e-b959-4c4e-93b6-04e91acc3953@proxmox.com>
Date: Fri, 19 Apr 2024 10:45:19 +0200
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: Fiona Ebner <f.ebner@proxmox.com>,
 Proxmox VE development discussion <pve-devel@lists.proxmox.com>
References: <20240409132555.364926-1-l.wagner@proxmox.com>
 <20240409132555.364926-2-l.wagner@proxmox.com>
 <f005dc76-3201-4e2b-8f6d-252046887721@proxmox.com>
Content-Language: de-AT, en-US
From: Lukas Wagner <l.wagner@proxmox.com>
In-Reply-To: <f005dc76-3201-4e2b-8f6d-252046887721@proxmox.com>
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.002 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: Re: [pve-devel] [PATCH proxmox 01/19] notify: switch to file-based
 templating system
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>



On  2024-04-19 10:14, Fiona Ebner wrote:
> Am 09.04.24 um 15:25 schrieb Lukas Wagner:
>> Instead of passing the template strings for subject and body when
>> constructing a notification, we pass only the name of a template.
>> When rendering the template, the name of the template is used to find
>> corresponding template files. For PVE, they are located at
>> /usr/share/proxmox-ve/templates/default. The `default` part is
>> the 'template namespace', which is a preparation for user-customizable
>> and/or translatable notifications.
>>
> 
> Is the plan to create different namespaces there ourselves or tell users
> they can put their custom templates there? In the latter case, I'm not
> sure /usr/share is the best place, rather than some place under /etc/

The idea would be to implement translations as other namespaces, e.g. `de` or `fr`
instead of `default`.
For user-overridable templates we would extend the implementation to search for a template
in another location first and then fall back to the templates provided by us in '/usr/share/...`
I have not made up my mind yet on where these user-provided templates would be located, either
in /usr/local/share/.... or somewhere in /etc (/etc/pve would ensure that we have the same templates
on all nodes, but I'm not sure if it is a good idea to put custom, user-created files in there...)

Combining both ideas: assuming that we want to render a fencing notification translated to German, assuming
that the user-override is in /usr/local/share:
  - First try to load /usr/local/share/proxmox-ve/templates/de/fencing.txt.hbs
  - If not found, try loading the shipped template at /usr/share/proxmox-ve/templates/de/...
  - If that one also does not exist, fall back to `default` namespace
    - first user-location
    - finally shipped template

> 
> Who adds the template files? I don't see a patch for proxmox-ve in this
> series. Does this series require some versioned breaks to some package?

The pve-manager and pve-ha-manager (for fencing notifications) patches add the templates.
I can't use `/usr/share/pve-manager` and `/usr/share/pve-ha-manager` because 
proxmox_notify needs to have a single base directory from where to load template files.
Maybe we should use some other base dir to avoid confusion with the `proxmox-ve` metapackage?

In terms of versions:
pve-{ha}-manager needs to pull in a bumped libpve-notify-perl
libpve-notify-perl needs to pull in bumped libpve-rs-perl/libproxmox-rs-perl
libpve-rs-perl needs to pull in bumped librust-proxmox-notify

I really wish the dep-chain was a bit easier, yet here we are.

-- 
- Lukas


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel