public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: "Max R. Carrara" <m.carrara@proxmox.com>
To: pve-devel@lists.proxmox.com
Cc: Alfonso Kuen <gerencia@idkmanager.com>,
	Thomas Ellmenreich <t.ellmenreich@proxmox.com>,
	Jakob Klocker <j.klocker@proxmox.com>
Subject: [PATCH pve-storage v5 09/19] all plugins, api: mark certain properties as hidden in plugindata()
Date: Fri, 13 Nov 2026 21:33:13 +0100	[thread overview]
Message-ID: <20261113203330.932813-10-m.carrara@proxmox.com> (raw)
In-Reply-To: <20261113203330.932813-1-m.carrara@proxmox.com>

As done with 'advanced-properties', add a new 'hidden-properties' hash
in `plugindata()` of all plugins. For each plugin, mark the properties
that are *not* visible / used anywhere in the create / edit panel in
the UI in that hash.

This is purely done for consistency's sake.

Additionally, expose whether a property is hidden or not through a
new 'x-hidden' key that is added to each plugin property schema that
is returned by the `plugins/storage/plugin` endpoint.

The key is always set to either 0 or 1, also for plugins without the
hash.

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 src/PVE/API2/Plugins/Storage/Plugin.pm |  2 ++
 src/PVE/Storage/BTRFSPlugin.pm         |  9 +++++++++
 src/PVE/Storage/CIFSPlugin.pm          | 11 +++++++++++
 src/PVE/Storage/CephFSPlugin.pm        | 12 ++++++++++++
 src/PVE/Storage/DirPlugin.pm           |  9 +++++++++
 src/PVE/Storage/ESXiPlugin.pm          |  4 ++++
 src/PVE/Storage/ISCSIDirectPlugin.pm   |  1 +
 src/PVE/Storage/ISCSIPlugin.pm         |  3 +++
 src/PVE/Storage/LVMPlugin.pm           |  7 +++++++
 src/PVE/Storage/LvmThinPlugin.pm       |  3 +++
 src/PVE/Storage/NFSPlugin.pm           | 10 ++++++++++
 src/PVE/Storage/PBSPlugin.pm           |  3 +++
 src/PVE/Storage/RBDPlugin.pm           |  4 ++++
 src/PVE/Storage/ZFSPlugin.pm           |  5 +++++
 src/PVE/Storage/ZFSPoolPlugin.pm       |  4 ++++
 15 files changed, 87 insertions(+)

diff --git a/src/PVE/API2/Plugins/Storage/Plugin.pm b/src/PVE/API2/Plugins/Storage/Plugin.pm
index 360f21da..1b8c35d2 100644
--- a/src/PVE/API2/Plugins/Storage/Plugin.pm
+++ b/src/PVE/API2/Plugins/Storage/Plugin.pm
@@ -82,10 +82,11 @@ my sub get_schema_for_plugin : prototype($) ($plugin) {
     my $plugindata = $plugin->plugindata();
 
     # also covers the fallback for plugins without 'sensitive-properties' in their plugindata()
     my $sensitive = { map { $_ => 1 } PVE::Storage::Plugin::sensitive_properties($type)->@* };
     my $advanced = $plugindata->{'advanced-properties'} // {};
+    my $hidden = $plugindata->{'hidden-properties'} // {};
 
     my $schema = {};
 
     for my $option (keys $options->%*) {
         my $prop_schema = PVE::RESTHandler::api_dump_remove_refs(
@@ -98,10 +99,11 @@ my sub get_schema_for_plugin : prototype($) ($plugin) {
         if (!defined($property->{sensitive})) {
             $property->{sensitive} = $sensitive->{$option} ? 1 : 0;
         }
 
         $property->{'x-advanced'} = $advanced->{$option} ? 1 : 0;
+        $property->{'x-hidden'} = $hidden->{$option} ? 1 : 0;
 
         $schema->{$option} = $property;
 
         for my $opt_key (keys $options->{$option}->%*) {
             $property->{$opt_key} = $options->{$option}->{$opt_key};
diff --git a/src/PVE/Storage/BTRFSPlugin.pm b/src/PVE/Storage/BTRFSPlugin.pm
index 0108e03d..697530ef 100644
--- a/src/PVE/Storage/BTRFSPlugin.pm
+++ b/src/PVE/Storage/BTRFSPlugin.pm
@@ -46,10 +46,19 @@ sub plugindata {
         ],
         format => [{ raw => 1, subvol => 1 }, 'raw'],
         'advanced-properties' => {
             preallocation => 1,
         },
+        'hidden-properties' => {
+            'create-base-path' => 1,
+            'create-subdirs' => 1,
+            format => 1,
+            is_mountpoint => 1,
+            mkdir => 1,
+            nocow => 1,
+            shared => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/CIFSPlugin.pm b/src/PVE/Storage/CIFSPlugin.pm
index 5a04154a..9b145078 100644
--- a/src/PVE/Storage/CIFSPlugin.pm
+++ b/src/PVE/Storage/CIFSPlugin.pm
@@ -127,10 +127,21 @@ sub plugindata {
         format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'],
         'advanced-properties' => {
             preallocation => 1,
             'snapshot-as-volume-chain' => 1,
         },
+        'hidden-properties' => {
+            bwlimit => 1,
+            'create-base-path' => 1,
+            'create-subdirs' => 1,
+            'content-dirs' => 1,
+            format => 1,
+            mkdir => 1,
+            options => 1,
+            path => 1,
+            smbversion => 1,
+        },
         'sensitive-properties' => { password => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/CephFSPlugin.pm b/src/PVE/Storage/CephFSPlugin.pm
index 59cb57c3..82a4351f 100644
--- a/src/PVE/Storage/CephFSPlugin.pm
+++ b/src/PVE/Storage/CephFSPlugin.pm
@@ -117,10 +117,22 @@ sub type {
 sub plugindata {
     return {
         content =>
             [{ vztmpl => 1, iso => 1, backup => 1, snippets => 1, import => 1 }, { backup => 1 }],
         'advanced-properties' => {},
+        'hidden-properties' => {
+            bwlimit => 1,
+            'create-base-path' => 1,
+            'create-subdirs' => 1,
+            'content-dirs' => 1,
+            format => 1,
+            fuse => 1,
+            mkdir => 1,
+            options => 1,
+            path => 1,
+            subdir => 1,
+        },
         'sensitive-properties' => { keyring => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/DirPlugin.pm b/src/PVE/Storage/DirPlugin.pm
index 0165d7a2..d47ead90 100644
--- a/src/PVE/Storage/DirPlugin.pm
+++ b/src/PVE/Storage/DirPlugin.pm
@@ -40,10 +40,19 @@ sub plugindata {
         format => [{ raw => 1, qcow2 => 1, vmdk => 1, subvol => 1 }, 'raw'],
         'advanced-properties' => {
             preallocation => 1,
             'snapshot-as-volume-chain' => 1,
         },
+        'hidden-properties' => {
+            bwlimit => 1,
+            'create-base-path' => 1,
+            'create-subdirs' => 1,
+            'content-dirs' => 1,
+            format => 1,
+            is_mountpoint => 1,
+            mkdir => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ESXiPlugin.pm b/src/PVE/Storage/ESXiPlugin.pm
index 82f64650..e563e500 100644
--- a/src/PVE/Storage/ESXiPlugin.pm
+++ b/src/PVE/Storage/ESXiPlugin.pm
@@ -31,10 +31,14 @@ sub type {
 sub plugindata {
     return {
         content => [{ import => 1 }, { import => 1 }],
         format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'],
         'advanced-properties' => {},
+        'hidden-properties' => {
+            content => 1,
+            shared => 1,
+        },
         'sensitive-properties' => { password => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ISCSIDirectPlugin.pm b/src/PVE/Storage/ISCSIDirectPlugin.pm
index 72bad793..d7f2b2ab 100644
--- a/src/PVE/Storage/ISCSIDirectPlugin.pm
+++ b/src/PVE/Storage/ISCSIDirectPlugin.pm
@@ -65,10 +65,11 @@ sub type {
 sub plugindata {
     return {
         content => [{ images => 1, none => 1 }, { images => 1 }],
         select_existing => 1,
         'advanced-properties' => {},
+        'hidden-properties' => {}, # plugin has no editor
         'sensitive-properties' => {},
     };
 }
 
 sub options {
diff --git a/src/PVE/Storage/ISCSIPlugin.pm b/src/PVE/Storage/ISCSIPlugin.pm
index 11abc639..c1312f8a 100644
--- a/src/PVE/Storage/ISCSIPlugin.pm
+++ b/src/PVE/Storage/ISCSIPlugin.pm
@@ -386,10 +386,13 @@ sub type {
 sub plugindata {
     return {
         content => [{ images => 1, none => 1 }, { images => 1 }],
         select_existing => 1,
         'advanced-properties' => {},
+        'hidden-properties' => {
+            bwlimit => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/LVMPlugin.pm b/src/PVE/Storage/LVMPlugin.pm
index b7497b72..185e1f8e 100644
--- a/src/PVE/Storage/LVMPlugin.pm
+++ b/src/PVE/Storage/LVMPlugin.pm
@@ -856,10 +856,17 @@ sub plugindata {
         content => [{ images => 1, rootdir => 1 }, { images => 1 }],
         format => [{ raw => 1, qcow2 => 1 }, 'raw'],
         'advanced-properties' => {
             'snapshot-as-volume-chain' => 1,
         },
+        'hidden-properties' => {
+            bwlimit => 1,
+            'on-volume-remove' => 1,
+            'saferemove-stepsize' => 1,
+            saferemove_throughput => 1,
+            tagged_only => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 my $on_volume_remove_format = {
diff --git a/src/PVE/Storage/LvmThinPlugin.pm b/src/PVE/Storage/LvmThinPlugin.pm
index f342651c..13684b88 100644
--- a/src/PVE/Storage/LvmThinPlugin.pm
+++ b/src/PVE/Storage/LvmThinPlugin.pm
@@ -35,10 +35,13 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1, rootdir => 1 }],
         'advanced-properties' => {},
+        'hidden-properties' => {
+            bwlimit => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/NFSPlugin.pm b/src/PVE/Storage/NFSPlugin.pm
index 85497df6..4021543d 100644
--- a/src/PVE/Storage/NFSPlugin.pm
+++ b/src/PVE/Storage/NFSPlugin.pm
@@ -68,10 +68,20 @@ sub plugindata {
         format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'],
         'advanced-properties' => {
             preallocation => 1,
             'snapshot-as-volume-chain' => 1,
         },
+        'hidden-properties' => {
+            bwlimit => 1,
+            'create-base-path' => 1,
+            'create-subdirs' => 1,
+            'content-dirs' => 1,
+            format => 1,
+            mkdir => 1,
+            options => 1,
+            path => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/PBSPlugin.pm b/src/PVE/Storage/PBSPlugin.pm
index 83b6f89b..952e40ef 100644
--- a/src/PVE/Storage/PBSPlugin.pm
+++ b/src/PVE/Storage/PBSPlugin.pm
@@ -30,10 +30,13 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ backup => 1, none => 1 }, { backup => 1 }],
         'advanced-properties' => {},
+        'hidden-properties' => {
+            'master-pubkey' => 1,
+        },
         'sensitive-properties' => {
             'encryption-key' => 1,
             'master-pubkey' => 1,
             password => 1,
         },
diff --git a/src/PVE/Storage/RBDPlugin.pm b/src/PVE/Storage/RBDPlugin.pm
index 1022c8d6..f9a97069 100644
--- a/src/PVE/Storage/RBDPlugin.pm
+++ b/src/PVE/Storage/RBDPlugin.pm
@@ -417,10 +417,14 @@ sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1 }],
         'advanced-properties' => {
             namespace => 1,
         },
+        'hidden-properties' => {
+            bwlimit => 1,
+            'data-pool' => 1,
+        },
         'sensitive-properties' => { keyring => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ZFSPlugin.pm b/src/PVE/Storage/ZFSPlugin.pm
index ac8e7539..effee359 100644
--- a/src/PVE/Storage/ZFSPlugin.pm
+++ b/src/PVE/Storage/ZFSPlugin.pm
@@ -193,10 +193,15 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ images => 1 }, { images => 1 }],
         'advanced-properties' => {},
+        'hidden-properties' => {
+            bwlimit => 1,
+            content => 1,
+            'zfs-base-path' => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ZFSPoolPlugin.pm b/src/PVE/Storage/ZFSPoolPlugin.pm
index 522fee8b..55665642 100644
--- a/src/PVE/Storage/ZFSPoolPlugin.pm
+++ b/src/PVE/Storage/ZFSPoolPlugin.pm
@@ -63,10 +63,14 @@ sub type {
 sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1, rootdir => 1 }],
         format => [{ raw => 1, subvol => 1 }, 'raw'],
         'advanced-properties' => {},
+        'hidden-properties' => {
+            bwlimit => 1,
+            mountpoint => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
-- 
2.47.3





  parent reply	other threads:[~2026-11-13 20:35 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-13 20:33 [PATCH common/manager/proxmox-widget-toolkit/storage/storage-plugin-examples v5 00/19] GUI Support for Custom Storage Plugins Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-common v5 01/19] json schema: add multiline validation keyword Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 02/19] api: plugins/storage: add initial routes and endpoints Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 03/19] api: plugins/storage/plugin: include schema in plugin metadata Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 04/19] api: plugins/storage/plugin: handle sensitive properties in schema Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 05/19] api: plugins/storage/plugin: factor plugin metadata code into helper Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 06/19] api: plugins/storage/plugin: add plugins' 'content' to their metadata Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 07/19] all plugins: add 'title' to properties, adapt 'description's Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage v5 08/19] all plugins, api: mark certain properties as advanced in plugindata() Max R. Carrara
2026-11-13 20:33 ` Max R. Carrara [this message]
2026-11-13 20:33 ` [PATCH pve-storage v5 10/19] api: plugins/storage/plugin: allow plugins to have display names Max R. Carrara
2026-11-13 20:33 ` [PATCH proxmox-widget-toolkit v5 11/19] form: introduce new 'proxmoxtextarea' field Max R. Carrara
2026-11-13 20:33 ` [PATCH proxmox-widget-toolkit v5 12/19] utils: introduce helper function getFieldDefFromPropertySchema Max R. Carrara
2026-11-13 20:33 ` [PATCH proxmox-widget-toolkit v5 13/19] acme: use helper to construct ExtJS fields from property schemas Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-manager v5 14/19] api: sort modules and API method registrations Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-manager v5 15/19] ui: storage: remove entry of the removed DRBD plugin Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-manager v5 16/19] api: add API routes 'plugins' and 'plugins/storage' Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-manager v5 17/19] ui: storage view: display error when no editor for storage type exists Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-manager v5 18/19] ui: storage: add basic UI integration for custom storage plugins Max R. Carrara
2026-11-13 20:33 ` [PATCH pve-storage-plugin-examples v5 19/19] sshfs: Update SSHFS plugin Max R. Carrara
2026-11-16  2:20 ` applied: [PATCH common/manager/proxmox-widget-toolkit/storage/storage-plugin-examples v5 00/19] GUI Support for Custom Storage Plugins Thomas Lamprecht
2026-11-17  8:07 ` Roland Kammerer

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=20261113203330.932813-10-m.carrara@proxmox.com \
    --to=m.carrara@proxmox.com \
    --cc=gerencia@idkmanager.com \
    --cc=j.klocker@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=t.ellmenreich@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