[pve-devel] [PATCH v2 storage] plugin schema: improve description of 'shared' property

[Fiona Ebner]

It's not clear to users what this property does otherwise. Latest
report from the community forum:

https://forum.proxmox.com/threads/134393

Signed-off-by: Fiona Ebner <f.ebner at proxmox.com>
---

Changes in v2:
    * improve wording based on Fabian's suggestions, thanks!

@Fabian: I didn't want to drop the "single" and I felt like the "on
all nodes that can access it" might leave some users thinking when
there's nothing to think about: the storage has to be accessible from
all nodes (or all configured 'nodes'). "It will not automatically make
a local storage shared" also didn't feel super helpful while we're
still trying to explain what "shared" means.

I'll send a patch for pve-docs once the wording is accepted.

 src/PVE/Storage/Plugin.pm | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/PVE/Storage/Plugin.pm b/src/PVE/Storage/Plugin.pm
index fbbf491..e086de9 100644
--- a/src/PVE/Storage/Plugin.pm
+++ b/src/PVE/Storage/Plugin.pm
@@ -170,7 +170,10 @@ my $defaultData = {
 	    default => "Unlimited for users with Datastore.Allocate privilege, 5 for other users",
 	},
 	shared => {
-	    description => "Mark storage as shared.",
+	    description => "Indicate that this is a single storage with the same contents on all "
+		."nodes (or all listed in the 'nodes' option). It will not make the contents of a "
+		."local storage automatically accessible to other nodes, it just marks an already "
+		."shared storage as such!",
 	    type => 'boolean',
 	    optional => 1,
 	},
-- 
2.39.2