Documentation for using shared filesystem tunable

(cherry picked from commit 66bd2d9)
rancher · Oct 25, 2022 · b7e5266 · b7e5266
1 parent 9f18bde
commit b7e5266
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -186,6 +186,13 @@ data:
     1. If one node is listed but with `paths` set to `[]`, the provisioner will refuse to provision on this node.
     2. If more than one path was specified, the path would be chosen randomly when provisioning.
 
+`sharedFileSystemPath` allows the provisioner to use a filesystem that is mounted on all nodes at the same time.
+In this case all access modes are supported: `ReadWriteOnce`, `ReadOnlyMany` and `ReadWriteMany` for storage claims.
+
+In addition `volumeBindingMode: Immediate` can be used in  StorageClass definition.
+
+Please note that `nodePathMap` and `sharedFileSystemPath` are mutually exclusive. If `sharedFileSystemPath` is used, then `nodePathMap` must be set to `[]`.
+
 ##### Rules
 The configuration must obey following rules:
 1. `config.json` must be a valid json file.

diff --git a/deploy/chart/local-path-provisioner/values.yaml b/deploy/chart/local-path-provisioner/values.yaml
@@ -58,6 +58,14 @@ nodePathMap:
     paths:
       - /opt/local-path-provisioner
 
+# `sharedFileSystemPath` allows the provisioner to use a filesystem that is mounted on all
+# nodes at the same time. In this case all access modes are supported: `ReadWriteOnce`,
+# `ReadOnlyMany` and `ReadWriteMany` for storage claims. In addition
+# `volumeBindingMode: Immediate` can be used in  StorageClass definition.
+# Please note that `nodePathMap` and `sharedFileSystemPath` are mutually exclusive.
+# If `sharedFileSystemPath` is used, then `nodePathMap` must be set to `[]`.
+# sharedFileSystemPath: ""
+
 resources: {}
   # We usually recommend not to specify default resources and to leave this as a conscious
   # choice for the user. This also increases chances charts run on environments with little