1VFS_GLUSTERFS(8) System Administration tools VFS_GLUSTERFS(8)
2
6 vfs_glusterfs - Utilize features provided by GlusterFS
7
9 vfs objects = glusterfs
10
12 This VFS module is part of the samba(8) suite.
13 GlusterFS (http://www.gluster.org) is an Open Source clustered file
15 system capable of scaling to several peta-bytes. With its FUSE based
16 native client, GlusterFS is available as a POSIX compliant file system
17 and can hence be shared by Samba without additional steps.
18 The vfs_glusterfs VFS module provides an alternative, and superior way
20 to access a Gluster filesystem from Samba for sharing. It does not
21 require a Gluster FUSE mount but directly accesses the GlusterFS daemon
22 through its library libgfapi, thereby omitting the expensive
23 kernel-userspace context switches and taking advantage of some of the
24 more advanced features of GlusterFS.
25 This module can be combined with other modules, but it should be the
27 last module in the vfs objects list. Modules added to this list to the
28 right of the glusterfs entry may not have any effect at all.
29
31 A basic configuration looks like this.
32 [share]
34 vfs objects = glusterfs
35 path = /relative/base/path
36 glusterfs:volume = gv0
37 kernel share modes = no
38 Note that since vfs_glusterfs does not require a Gluster mount, the
41 share path is treated differently than for other shares: It is
42 interpreted as the base path of the share relative to the gluster
43 volume used. Because this is usually not at the same time a system
44 path, in a ctdb cluster setup where ctdb manages Samba, you need to set
45 CTDB_SAMBA_SKIP_SHARE_CHECK=yes in ctdb's configuration file. Otherwise
46 ctdb will not get healthy.
47 Note that currently kernel share modes have to be disabled in a share
49 running with the glusterfs vfs module for file serving to work
50 properly.
51
53 glusterfs:logfile = path
54 Defines whether and where to store a vfs_glusterfs specific
55 logfile. Client variable substitution is supported (i.e. %M, %m,
56 %I), hence per client log file can be specified.
57 Example: glusterfs:logfile = /var/log/samba/glusterfs-vol2.%M.log
59 glusterfs:loglevel = 0-9
61 Defines the level of logging, with higher numbers corresponding to
62 more verbosity. 0 - No logs; 9 - Trace log level; 7 being the info
63 log level is preferred.
64 If this option is not defined with an explicit loglevel, the
66 glusterfs default is used (currently loglevel 7).
67 glusterfs:volfile_server = servername
69 Defines which volfile server to use, defaults to localhost. It
70 could be list of white space separated elements where each element
71 could be
72 1. unix+/path/to/socket/file
74 2. [tcp+]IP|hostname|\[IPv6\][:port]
76 Note the restriction on naming a IPv6 host, it follows the same
78 restriction that is based on IPv6 naming in URL as per RFC 2732.
79 glusterfs:volume = volumename
81 Defines the glusterfs volumename to use for this share.
82
84 The GlusterFS write-behind performance translator, when used with
85 Samba, could be a source of data corruption. The translator, while
86 processing a write call, immediately returns success but continues
87 writing the data to the server in the background. This can cause data
88 corruption when two clients relying on Samba to provide data
89 consistency are operating on the same file.
90 The write-behind translator is enabled by default on GlusterFS. The
92 vfs_glusterfs plugin will check for the presence of the translator and
93 refuse to connect if detected. Please disable the write-behind
94 translator for the GlusterFS volume to allow the plugin to connect to
95 the volume. The write-behind translator can easily be disabled via
96 calling
97 gluster volume set <volumename> performance.write-behind off
99 on the commandline.
102 With GlusterFS versions >= 9, we silently bypass write-behind
104 translator during initial connect and failure is avoided.
105
107 This man page is part of version 4.17.5 of the Samba suite.
108
110 The original Samba software and related utilities were created by
111 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
112 Source project similar to the way the Linux kernel is developed.
113Samba 4.17.5 01/26/2023 VFS_GLUSTERFS(8)