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-plugin-examples v5 19/19] sshfs: Update SSHFS plugin
Date: Fri, 13 Nov 2026 21:33:23 +0100 [thread overview]
Message-ID: <20261113203330.932813-20-m.carrara@proxmox.com> (raw)
In-Reply-To: <20261113203330.932813-1-m.carrara@proxmox.com>
Change the API version from 11 to 16.
Add a display name.
Support the `import` volume type, since it's already in ::Plugin for
directory-based storage plugins.
Add `title` keys for the custom 'remote-path' and 'sshfs-private-key'
properties. Add the `multiline` keyword to 'sshfs-private-key' as
well.
Mark common advanced and hidden properties in the
'advanced-properties' and 'hidden-properties' hashes in `plugindata()`
respectively.
Use `on_update_hook_full()` instead of `on_update_hook()`.
Adapt the signature of `activate_storage()`, adding `$hints` as new
parameter. Mark the `$cache` and `$hints` parameters as optional, by
assigning `undef` to them by default.
Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
.../src/PVE/Storage/Custom/SSHFSPlugin.pm | 29 +++++++++++++++----
1 file changed, 23 insertions(+), 6 deletions(-)
diff --git a/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm b/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm
index 2d1612b..f4c6a18 100644
--- a/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm
+++ b/plugin-sshfs/src/PVE/Storage/Custom/SSHFSPlugin.pm
@@ -20,27 +20,31 @@ use PVE::Tools qw(
use base qw(PVE::Storage::Plugin);
# Plugin Definition
sub api {
- return 11;
+ return 16;
}
sub type {
return 'sshfs';
}
sub plugindata {
return {
+ meta => {
+ 'display-name' => "SSHFS",
+ },
content => [
{
images => 1,
rootdir => 1,
vztmpl => 1,
iso => 1,
backup => 1,
snippets => 1,
+ import => 1,
},
{
images => 1,
rootdir => 1,
},
@@ -51,26 +55,39 @@ sub plugindata {
qcow2 => 1,
vmdk => 1,
},
'qcow2',
],
+ 'advanced-properties' => {
+ preallocation => 1,
+ },
+ 'hidden-properties' => {
+ bwlimit => 1,
+ 'content-dirs' => 1,
+ 'create-base-path' => 1,
+ 'create-subdirs' => 1,
+ format => 1,
+ },
'sensitive-properties' => {
'sshfs-private-key' => 1,
},
};
}
sub properties {
return {
'remote-path' => {
description => "Path on the remote filesystem used for SSHFS. Must be absolute.",
type => 'string',
format => 'pve-storage-path',
+ title => 'Remote Path',
},
'sshfs-private-key' => {
description => "The private key to use for SSHFS.",
type => 'string',
+ multiline => 1,
+ title => 'Private Key',
},
};
}
sub options {
@@ -246,14 +263,14 @@ sub on_add_hook($class, $storeid, $scfg, %sensitive) {
die "error while adding SSHFS storage '${storeid}': $@\n" if $@;
return undef;
}
-sub on_update_hook($class, $storeid, $scfg, %sensitive) {
- if (exists($sensitive{'sshfs-private-key'})) {
- if (defined($sensitive{'sshfs-private-key'})) {
- eval { sshfs_set_private_key($storeid, $sensitive{'sshfs-private-key'}) };
+sub on_update_hook_full($class, $storeid, $scfg, $update, $delete, $sensitive) {
+ if (exists($sensitive->{'sshfs-private-key'})) {
+ if (defined($sensitive->{'sshfs-private-key'})) {
+ eval { sshfs_set_private_key($storeid, $sensitive->{'sshfs-private-key'}) };
die $@ if $@;
} else {
warn "removing private key for SSHFS storage '${storeid}'";
warn "the storage might not be mountable without a private key!";
@@ -303,11 +320,11 @@ sub check_connection($class, $storeid, $scfg) {
}
return 1;
}
-sub activate_storage($class, $storeid, $scfg, $cache) {
+sub activate_storage($class, $storeid, $scfg, $cache = undef, $hints = undef) {
my $mountpoint = $scfg->{path};
if (!sshfs_is_mounted($scfg)) {
if ($scfg->{'create-base-path'} // 1) {
make_path($mountpoint);
--
2.47.3
next prev parent reply other threads:[~2026-11-13 20:36 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 ` [PATCH pve-storage v5 09/19] all plugins, api: mark certain properties as hidden " Max R. Carrara
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 ` Max R. Carrara [this message]
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-20-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.