From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40])
	by lore.proxmox.com (Postfix) with ESMTPS id F3B061FF0F1
	for <inbox@lore.proxmox.com>; Mon, 13 Jul 2026 08:30:55 +0200 (CEST)
Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1])
	by gate001.proxmox.com (Proxmox) with ESMTP id 203282134F;
	Mon, 13 Jul 2026 08:30:55 +0200 (CEST)
Message-ID: <5a21861b-6818-41d1-95a4-f054bdce027d@proxmox.com>
Date: Mon, 13 Jul 2026 08:30:41 +0200
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird Beta
Subject: Re: [RFC storage, manager] schema-driven web UI dialog for custom
 storage plugins
To: Ciro Iriarte <cyruspy@gmail.com>, pve-devel@lists.proxmox.com
References: <6a511d0e.201ddd8e.107a97.f791@mx.google.com>
Content-Language: en-US
From: Dominik Csapak <d.csapak@proxmox.com>
In-Reply-To: <6a511d0e.201ddd8e.107a97.f791@mx.google.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2
X-Bm-Transport-Timestamp: 1783924233910
X-SPAM-LEVEL: Spam detection results:  0
	AWL                     0.001 Adjusted score from AWL reputation of From:
 address
	DMARC_MISSING             0.1 Missing DMARC policy
	KAM_ASCII_DIVIDERS        0.8 Email that uses ascii formatting dividers and
 possible spam tricks
	KAM_DMARC_STATUS         0.01 Test Rule for DKIM or SPF Failure with Strict
 Alignment (newer systems)
	RCVD_IN_DNSWL_LOW        -0.7 Sender listed at https://www.dnswl.org/,
 low trust
	SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
	SPF_PASS               -0.001 SPF: sender matches SPF record
Message-ID-Hash: VOFVSLCBSMZVBR3I7YNPU4ETWC6JVN4C
X-Message-ID-Hash: VOFVSLCBSMZVBR3I7YNPU4ETWC6JVN4C
X-MailFrom: d.csapak@proxmox.com
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop;
 banned-address; emergency; member-moderation; nonmember-moderation;
 administrivia; implicit-dest; max-recipients; max-size; news-moderation;
 no-subject; digests; suspicious-header
X-Mailman-Version: 3.3.10
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Owner: <mailto:pve-devel-owner@lists.proxmox.com>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Subscribe: <mailto:pve-devel-join@lists.proxmox.com>
List-Unsubscribe: <mailto:pve-devel-leave@lists.proxmox.com>

On 7/10/26 6:26 PM, Ciro Iriarte wrote:
> Hello,
> 

Hi,

> I'd like feedback on a supported way for a custom storage plugin to
> contribute its create/edit dialog to the web UI, so third-party plugins
> no longer have to inject JavaScript into pve-manager's index.html.tpl.
> 
> Decision I am asking about
> --------------------------
> Should pve-storage let a plugin declare a GUI form schema that
> pve-manager renders into the storage add/edit dialog, instead of the
> plugin shipping ExtJS and patching index.html.tpl? If yes, I propose the
> minimal contract below.
> 
> Background
> ----------
> A custom storage plugin (PVE::Storage::Custom) registers its config
> properties server-side via properties()/options(), but there is no
> supported way to contribute the create/edit dialog. The only working
> method today is to ship an ExtJS panel and inject a <script> into
> /usr/share/pve-manager/index.html.tpl (via a packaging trigger), which:
> - edits a file owned by pve-manager, re-broken on every upgrade, and
> - depends on private manager6 internals (PVE.panel.StorageBase,
>    PVE.Utils.storageSchema) with no API-stability guarantee.
> 
> This is the JS-injection concern raised in #3420. That bug's 2022 fix
> added the `type-text` property (a friendly grid label); the form
> generation was deferred. In #3420 Thomas Lamprecht suggested following
> the ACME DNS-Challenge provider pattern, "where we return a schema ...
> and even generate the GUI's form fields." This proposes that deferred
> half.
> 
> Most of the needed information already lives server-side: the registered
> SectionConfig property carries type/format/default, and options() marks
> which keys are `fixed` (immutable after create). The dialog is largely
> re-encoding data the plugin already declares.
> 
> Proposed contract (pve-storage)
> -------------------------------
> - Add an optional plugin-provided GUI schema (JSON-serializable), e.g.
>    via plugindata() or a new method, carrying presentation metadata only:
>    field labels, grouping (general/advanced), a widget hint, enum display
>    text, placeholder, and the onlineHelp anchor.
> - Widget type, required-ness, min/max, default, and immutable-on-edit are
>    derived from the already-registered property and the options() `fixed`
>    set -- not duplicated in the schema.
> - Bump the storage APIVER/APIAGE.
> 
> Consumer (pve-manager)
> ----------------------
> - Add a generic schema-driven storage InputPanel (extending the existing
>    storage base panel) that builds the create/edit dialog from the schema.
> - Deliver the schema through the existing plugin metadata the GUI already
>    reads for the storage type list, so no index.html.tpl patching and no
>    third-party JS.
> 
> Scope / compatibility
> ---------------------
> - Opt-in and backward compatible: a plugin with no schema behaves exactly
>    as today (raw type token, no dialog).
> - Secret fields never round-trip the stored value (blank = unchanged).
> - Common widgets only (text, integer, boolean, enum, password,
>    content-type) cover the typical plugin. A supported JS drop-in plus a
>    public registerStoragePlugin() escape hatch, for plugins that need a
>    custom widget or validator, could be a follow-up rather than part of
>    this.
> 
> Out of scope
> ------------
> - Custom ExtJS widgets/validators (the escape-hatch follow-up above).
> - Reworking built-in storage dialogs; they can adopt the generic panel
>    later but need not change for this.
> 
> If the contract looks acceptable, I'll follow up with an [RFC PATCH]
> series against pve-storage and then pve-manager. My CLA is on file.
> 
> Tracking: https://bugzilla.proxmox.com/show_bug.cgi?id=7808 (and the
> earlier #3420).
> 
> Thanks,
> Ciro
> 
> 
> 


just so you know, Max is already working on GUI support for custom 
storage plugins:

https://lore.proxmox.com/pve-devel/20260623143402.772452-1-m.carrara@proxmox.com/

the last rebase was end of june, so not that long ago.

Instead of posting your own patches, a review and/or test from you side
could help here...