summaryrefslogtreecommitdiffstats
path: root/doc/glusterfs.vol.sample
diff options
context:
space:
mode:
Diffstat (limited to 'doc/glusterfs.vol.sample')
-rw-r--r--doc/glusterfs.vol.sample61
1 files changed, 61 insertions, 0 deletions
diff --git a/doc/glusterfs.vol.sample b/doc/glusterfs.vol.sample
new file mode 100644
index 00000000000..e126f66b3dc
--- /dev/null
+++ b/doc/glusterfs.vol.sample
@@ -0,0 +1,61 @@
+### file: client-volume.vol.sample
+
+#####################################
+### GlusterFS Client Volume File ##
+#####################################
+
+#### CONFIG FILE RULES:
+### "#" is comment character.
+### - Config file is case sensitive
+### - Options within a volume block can be in any order.
+### - Spaces or tabs are used as delimitter within a line.
+### - Each option should end within a line.
+### - Missing or commented fields will assume default values.
+### - Blank/commented lines are allowed.
+### - Sub-volumes should already be defined above before referring.
+
+### Add client feature and attach to remote subvolume
+volume client
+ type protocol/client
+ option transport-type tcp
+# option transport-type unix
+# option transport-type ib-sdp
+ option remote-host 127.0.0.1 # IP address of the remote brick
+# option transport.socket.remote-port 6996 # default server port is 6996
+
+# option transport-type ib-verbs
+# option transport.ib-verbs.remote-port 6996 # default server port is 6996
+# option transport.ib-verbs.work-request-send-size 1048576
+# option transport.ib-verbs.work-request-send-count 16
+# option transport.ib-verbs.work-request-recv-size 1048576
+# option transport.ib-verbs.work-request-recv-count 16
+
+# option transport-timeout 30 # seconds to wait for a reply
+ # from server for each request
+ option remote-subvolume brick # name of the remote volume
+end-volume
+
+### Add readahead feature
+#volume readahead
+# type performance/read-ahead
+# option page-size 1MB # unit in bytes
+# option page-count 2 # cache per file = (page-count x page-size)
+# subvolumes client
+#end-volume
+
+### Add IO-Cache feature
+#volume iocache
+# type performance/io-cache
+# option page-size 256KB
+# option page-count 2
+# subvolumes readahead
+#end-volume
+
+### Add writeback feature
+#volume writeback
+# type performance/write-behind
+# option aggregate-size 1MB
+# option window-size 2MB
+# option flush-behind off
+# subvolumes iocache
+#end-volume