aboutsummaryrefslogtreecommitdiff
path: root/deploy
diff options
context:
space:
mode:
authorAaron Madsen <amadsen@codifiant.com>2025-05-03 16:33:18 -0700
committerChris Lu <chrislusf@users.noreply.github.com>2025-05-04 05:23:16 -0700
commit4a6af64593bd8fec18c2628405b8ca8e16aa5130 (patch)
tree9455e25e7e51cf487ffa481354cd4f565f7ba0b9 /deploy
parentd8c22dfd98b9aa8a463cd5d6dffc2ea750dfcdf2 (diff)
downloadseaweedfs-csi-driver-4a6af64593bd8fec18c2628405b8ca8e16aa5130.tar.xz
seaweedfs-csi-driver-4a6af64593bd8fec18c2628405b8ca8e16aa5130.zip
Add a few more comments to deploy/nomad/example-seaweedfs-volume.hcl
Diffstat (limited to 'deploy')
-rw-r--r--deploy/nomad/example-seaweedfs-volume.hcl8
1 files changed, 8 insertions, 0 deletions
diff --git a/deploy/nomad/example-seaweedfs-volume.hcl b/deploy/nomad/example-seaweedfs-volume.hcl
index 145dd8b..ce2faac 100644
--- a/deploy/nomad/example-seaweedfs-volume.hcl
+++ b/deploy/nomad/example-seaweedfs-volume.hcl
@@ -26,7 +26,15 @@ mount_options {
parameters {
# Available options: https://github.com/seaweedfs/seaweedfs-csi-driver/blob/master/pkg/driver/mounter_seaweedfs.go
+ # By default, collection is the `volume ID` returned from the Create Volume gRPC call. Nomad calls this the
+ # External ID of the volume. "example" here overrides that.
collection = "example"
replication = "000"
+ # By default, path is "/buckets/<volume ID>", where `volume ID` is the value returned from the Create Volume gRPC
+ # call that Nomad calls the External ID. Do not use relative paths (paths that start with something other than /)
+ # They will will not work properly.
+ # When `path` is outside of the default path - `/buckets/<volume ID>` - the default path bucket will still be
+ # created, but remain empty. Since capabilities checks are tied to the default path of the volume, they may not
+ # provide the expected results.
path = "/buckets/example"
}