[PATCH pve-storage v4 08/17] all plugins, api: mark certain properties as advanced in plugindata()

["Max R. Carrara" <m.carrara@proxmox.com>]

Add a new 'advanced-properties' hash in `plugindata()` of all plugins.
For each plugin, mark every property that is used in the "Advanced"
section of the create / edit panel in the UI in that hash.

This results in the following properties being marked as advanced if
they do appear in a given plugin's `properties()` or `options()`:
- preallocation
- snapshot-as-volume-chain

Additionally, expose whether a property is advanced or not through a
new 'x-advanced' 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         | 3 +++
 src/PVE/Storage/CIFSPlugin.pm          | 4 ++++
 src/PVE/Storage/CephFSPlugin.pm        | 1 +
 src/PVE/Storage/DirPlugin.pm           | 4 ++++
 src/PVE/Storage/ESXiPlugin.pm          | 1 +
 src/PVE/Storage/ISCSIDirectPlugin.pm   | 1 +
 src/PVE/Storage/ISCSIPlugin.pm         | 1 +
 src/PVE/Storage/LVMPlugin.pm           | 3 +++
 src/PVE/Storage/LvmThinPlugin.pm       | 1 +
 src/PVE/Storage/NFSPlugin.pm           | 4 ++++
 src/PVE/Storage/PBSPlugin.pm           | 1 +
 src/PVE/Storage/RBDPlugin.pm           | 1 +
 src/PVE/Storage/ZFSPlugin.pm           | 1 +
 src/PVE/Storage/ZFSPoolPlugin.pm       | 1 +
 15 files changed, 29 insertions(+)

diff --git a/src/PVE/API2/Plugins/Storage/Plugin.pm b/src/PVE/API2/Plugins/Storage/Plugin.pm
index 906724ba..33efc138 100644
--- a/src/PVE/API2/Plugins/Storage/Plugin.pm
+++ b/src/PVE/API2/Plugins/Storage/Plugin.pm
@@ -63,20 +63,22 @@ my sub get_schema_for_plugin : prototype($) ($plugin) {
     return $PLUGIN_SCHEMAS->{$type} if defined($PLUGIN_SCHEMAS->{$type});
 
     my $options = $plugin->options();
     # also covers the fallback for plugins without 'sensitive-properties' in their plugindata()
     my $sensitive = { map { $_ => 1 } PVE::Storage::Plugin::sensitive_properties($type)->@* };
+    my $advanced = $plugin->plugindata()->{'advanced-properties'} // {};
 
     my $schema = {};
     $PLUGIN_SCHEMAS->{$type} = $schema;
 
     for my $option (keys $options->%*) {
         my $prop_schema = PVE::RESTHandler::api_dump_remove_refs(
             PVE::Storage::Plugin->get_property_schema($type, $option));
 
         # shallow copy
         my $property = { $prop_schema->%* };
+        $property->{'x-advanced'} = $advanced->{$option} ? 1 : 0;
         $property->{'x-sensitive'} = $sensitive->{$option} ? 1 : 0;
 
         $schema->{$option} = $property;
 
         for my $opt_key (keys $options->{$option}->%*) {
diff --git a/src/PVE/Storage/BTRFSPlugin.pm b/src/PVE/Storage/BTRFSPlugin.pm
index 166bf815..0108e03d 100644
--- a/src/PVE/Storage/BTRFSPlugin.pm
+++ b/src/PVE/Storage/BTRFSPlugin.pm
@@ -43,10 +43,13 @@ sub plugindata {
                 import => 1,
             },
             { images => 1, rootdir => 1 },
         ],
         format => [{ raw => 1, subvol => 1 }, 'raw'],
+        'advanced-properties' => {
+            preallocation => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/CIFSPlugin.pm b/src/PVE/Storage/CIFSPlugin.pm
index 23b505cd..5a04154a 100644
--- a/src/PVE/Storage/CIFSPlugin.pm
+++ b/src/PVE/Storage/CIFSPlugin.pm
@@ -123,10 +123,14 @@ sub plugindata {
                 import => 1,
             },
             { images => 1 },
         ],
         format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'],
+        'advanced-properties' => {
+            preallocation => 1,
+            'snapshot-as-volume-chain' => 1,
+        },
         'sensitive-properties' => { password => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/CephFSPlugin.pm b/src/PVE/Storage/CephFSPlugin.pm
index fcb8a9e6..59cb57c3 100644
--- a/src/PVE/Storage/CephFSPlugin.pm
+++ b/src/PVE/Storage/CephFSPlugin.pm
@@ -116,10 +116,11 @@ sub type {
 
 sub plugindata {
     return {
         content =>
             [{ vztmpl => 1, iso => 1, backup => 1, snippets => 1, import => 1 }, { backup => 1 }],
+        'advanced-properties' => {},
         'sensitive-properties' => { keyring => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/DirPlugin.pm b/src/PVE/Storage/DirPlugin.pm
index cc52feae..8e923077 100644
--- a/src/PVE/Storage/DirPlugin.pm
+++ b/src/PVE/Storage/DirPlugin.pm
@@ -36,10 +36,14 @@ sub plugindata {
                 import => 1,
             },
             { images => 1, rootdir => 1 },
         ],
         format => [{ raw => 1, qcow2 => 1, vmdk => 1, subvol => 1 }, 'raw'],
+        'advanced-properties' => {
+            preallocation => 1,
+            'snapshot-as-volume-chain' => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ESXiPlugin.pm b/src/PVE/Storage/ESXiPlugin.pm
index e0ea2837..82f64650 100644
--- a/src/PVE/Storage/ESXiPlugin.pm
+++ b/src/PVE/Storage/ESXiPlugin.pm
@@ -30,10 +30,11 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ import => 1 }, { import => 1 }],
         format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'],
+        'advanced-properties' => {},
         'sensitive-properties' => { password => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ISCSIDirectPlugin.pm b/src/PVE/Storage/ISCSIDirectPlugin.pm
index fb732850..72bad793 100644
--- a/src/PVE/Storage/ISCSIDirectPlugin.pm
+++ b/src/PVE/Storage/ISCSIDirectPlugin.pm
@@ -64,10 +64,11 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ images => 1, none => 1 }, { images => 1 }],
         select_existing => 1,
+        'advanced-properties' => {},
         'sensitive-properties' => {},
     };
 }
 
 sub options {
diff --git a/src/PVE/Storage/ISCSIPlugin.pm b/src/PVE/Storage/ISCSIPlugin.pm
index aa187d85..2f148935 100644
--- a/src/PVE/Storage/ISCSIPlugin.pm
+++ b/src/PVE/Storage/ISCSIPlugin.pm
@@ -348,10 +348,11 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ images => 1, none => 1 }, { images => 1 }],
         select_existing => 1,
+        'advanced-properties' => {},
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/LVMPlugin.pm b/src/PVE/Storage/LVMPlugin.pm
index ced87234..2619a7b9 100644
--- a/src/PVE/Storage/LVMPlugin.pm
+++ b/src/PVE/Storage/LVMPlugin.pm
@@ -713,10 +713,13 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1 }],
         format => [{ raw => 1, qcow2 => 1 }, 'raw'],
+        'advanced-properties' => {
+            'snapshot-as-volume-chain' => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 my $on_volume_remove_format = {
diff --git a/src/PVE/Storage/LvmThinPlugin.pm b/src/PVE/Storage/LvmThinPlugin.pm
index 6cb0500d..7fed8af8 100644
--- a/src/PVE/Storage/LvmThinPlugin.pm
+++ b/src/PVE/Storage/LvmThinPlugin.pm
@@ -34,10 +34,11 @@ sub type {
 }
 
 sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1, rootdir => 1 }],
+        'advanced-properties' => {},
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/NFSPlugin.pm b/src/PVE/Storage/NFSPlugin.pm
index e54c4a4a..85497df6 100644
--- a/src/PVE/Storage/NFSPlugin.pm
+++ b/src/PVE/Storage/NFSPlugin.pm
@@ -64,10 +64,14 @@ sub plugindata {
                 import => 1,
             },
             { images => 1 },
         ],
         format => [{ raw => 1, qcow2 => 1, vmdk => 1 }, 'raw'],
+        'advanced-properties' => {
+            preallocation => 1,
+            'snapshot-as-volume-chain' => 1,
+        },
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/PBSPlugin.pm b/src/PVE/Storage/PBSPlugin.pm
index d1c94653..83b6f89b 100644
--- a/src/PVE/Storage/PBSPlugin.pm
+++ b/src/PVE/Storage/PBSPlugin.pm
@@ -29,10 +29,11 @@ sub type {
 }
 
 sub plugindata {
     return {
         content => [{ backup => 1, none => 1 }, { backup => 1 }],
+        'advanced-properties' => {},
         '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 ce88dc2c..970358ca 100644
--- a/src/PVE/Storage/RBDPlugin.pm
+++ b/src/PVE/Storage/RBDPlugin.pm
@@ -414,10 +414,11 @@ sub type {
 }
 
 sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1 }],
+        'advanced-properties' => {},
         'sensitive-properties' => { keyring => 1 },
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ZFSPlugin.pm b/src/PVE/Storage/ZFSPlugin.pm
index a722c773..81923494 100644
--- a/src/PVE/Storage/ZFSPlugin.pm
+++ b/src/PVE/Storage/ZFSPlugin.pm
@@ -192,10 +192,11 @@ sub type {
 }
 
 sub plugindata {
     return {
         content => [{ images => 1 }, { images => 1 }],
+        'advanced-properties' => {},
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
diff --git a/src/PVE/Storage/ZFSPoolPlugin.pm b/src/PVE/Storage/ZFSPoolPlugin.pm
index 8b6fa0ae..522fee8b 100644
--- a/src/PVE/Storage/ZFSPoolPlugin.pm
+++ b/src/PVE/Storage/ZFSPoolPlugin.pm
@@ -62,10 +62,11 @@ sub type {
 
 sub plugindata {
     return {
         content => [{ images => 1, rootdir => 1 }, { images => 1, rootdir => 1 }],
         format => [{ raw => 1, subvol => 1 }, 'raw'],
+        'advanced-properties' => {},
         'sensitive-properties' => {},
     };
 }
 
 sub properties {
-- 
2.47.3