aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--cmd/seaweedfs-csi-driver/swarm/README.md2
-rw-r--r--deploy/swarm/README.md45
2 files changed, 46 insertions, 1 deletions
diff --git a/cmd/seaweedfs-csi-driver/swarm/README.md b/cmd/seaweedfs-csi-driver/swarm/README.md
index 117fb99..8b92899 100644
--- a/cmd/seaweedfs-csi-driver/swarm/README.md
+++ b/cmd/seaweedfs-csi-driver/swarm/README.md
@@ -74,3 +74,5 @@ docker plugin create ${PREFIX}/${PLUGIN_NAME}:${PLUGIN_TAG} ./plugin
docker plugin push ${PREFIX}/${PLUGIN_NAME}:${PLUGIN_TAG}
rm -rf ./plugin/
```
+
+Volumes are store in the "/buckets" folder on the Seaweed server.
diff --git a/deploy/swarm/README.md b/deploy/swarm/README.md
index 304ae22..03191a5 100644
--- a/deploy/swarm/README.md
+++ b/deploy/swarm/README.md
@@ -1 +1,44 @@
-# swarm-csi-swaweedfs
+# SeaweedFS CSI-Driver Docker Plugin
+
+This Docker plugin integrates the SeaweedFS CSI-Driver with Docker. It allows you to use SeaweedFS as a volume driver in Docker environments.
+
+## Environment Variables
+
+| Variable | Description |
+|-----------------------|-------------------------------------------------------------------------------------------------------|
+| `FILER` | Filer endpoint(s), format: `<IP1>:<PORT>,<IP2>:<PORT2>` |
+| `CACHE_SIZE` | The size of the cache to use in MB. Default: 256MB |
+| `CACHE_DIR` | The cache directory. |
+| `C_WRITER` | Limit concurrent goroutine writers if not 0. Default 32 |
+| `DATACENTER` | Data center this node is running in (locality-definition). Default: `DefaultDataCenter` |
+| `UID_MAP` | Map local UID to UID on filer, comma-separated `<local_uid>:<filer_uid>` |
+| `GID_MAP` | Map local GID to GID on filer, comma-separated `<local_gid>:<filer_gid>` |
+
+## Mounts
+
+| Mount Destination | Source Path | Description |
+|---------------------|-----------------|------------------------------|
+| `/node_hostname` | `/etc/hostname` | Used to get the nodename |
+| `/tmp` | `/tmp` | Used for caching |
+
+## Usag
+
+```bash
+docker plugin install --disable --alias seaweedfs-csi:swarm --grant-all-permissions gradlon/swarm-csi-swaweedfs:v1.2.0
+docker plugin set seaweedfs-csi:swarm FILER=<IP>:8888,<IP>:8888
+docker plugin set seaweedfs-csi:swarm CACHE_SIZE=512
+docker plugin enable seaweedfs-csi:swarm
+docker volume create --driver seaweedfs-csi:swarm --availability active --scope single --sharing none --type mount --opt path="/docker/volumes/teste1" test-volume
+
+docker volume create \
+ --driver seaweedfs-csi:swarm \
+ --availability active \
+ --scope multi \
+ --sharing all \
+ --type mount \
+ testVolume
+
+ docker service create --name testService --mount type=cluster,src=testVolume,dst=/usr/share/nginx/html --publish 2080:80 nginx
+```
+
+Volumes are store in the "/buckets" folder on the Seaweed server.