docs: Bump version up to 4.6.
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_glusterfs.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_glusterfs.8">
4
5 <refmeta>
6         <refentrytitle>vfs_glusterfs</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_glusterfs</refname>
16         <refpurpose>
17                 Utilize features provided by GlusterFS
18         </refpurpose>
19 </refnamediv>
20
21 <refsynopsisdiv>
22         <cmdsynopsis>
23                 <command>vfs objects = glusterfs</command>
24         </cmdsynopsis>
25 </refsynopsisdiv>
26
27 <refsect1>
28         <title>DESCRIPTION</title>
29
30         <para>This VFS module is part of the
31         <citerefentry><refentrytitle>samba</refentrytitle>
32         <manvolnum>8</manvolnum></citerefentry> suite.</para>
33
34         <para>
35                 GlusterFS
36                 (<ulink url="http://www.gluster.org/">http://www.gluster.org</ulink>)
37                 is an Open Source clustered file system capable of scaling to
38                 several peta-bytes.  With its FUSE based native client,
39                 GlusterFS is available as a POSIX compliant file system and can
40                 hence be shared by Samba without additional steps.
41         </para>
42
43         <para>
44                 The <command>vfs_glusterfs</command> VFS module provides an
45                 alternative, and superior way to access a Gluster filesystem
46                 from Samba for sharing. It does not require a Gluster FUSE mount
47                 but directly accesses the GlusterFS daemon through its library
48                 <command>libgfapi</command>, thereby omitting the expensive
49                 kernel-userspace context switches and taking advantage of some
50                 of the more advanced features of GlusterFS.
51         </para>
52
53         <para>
54                 This module can be combined with other modules, but it
55                 should be the last module in the <command>vfs objects</command>
56                 list. Modules added to this list to the right of the glusterfs
57                 entry may not have any effect at all.
58         </para>
59 </refsect1>
60
61 <refsect1>
62         <title>CONFIGURATION</title>
63
64         <para>
65                 A basic configuration looks like this.
66         </para>
67
68         <programlisting>
69                 <smbconfsection name="[share]"/>
70                 <smbconfoption name="vfs objects">glusterfs</smbconfoption>
71                 <smbconfoption name="path">/relative/base/path</smbconfoption>
72                 <smbconfoption name="glusterfs:volume">gv0</smbconfoption>
73                 <smbconfoption name="kernel share modes">no</smbconfoption>
74         </programlisting>
75
76         <para>
77                 Note that since <command>vfs_glusterfs</command> does not
78                 require a Gluster mount, the share <command>path</command> is
79                 treated differently than for other shares: It is interpreted as
80                 the base path of the share relative to the gluster volume used.
81                 Because this is usually not at the same time a system path, in a
82                 ctdb cluster setup where ctdb manages Samba, you need to set
83                 <command>CTDB_SAMBA_SKIP_SHARE_CHECK=yes</command> in ctdb's
84                 configuration file. Otherwise ctdb will not get healthy.
85         </para>
86
87         <para>
88                 Note that currently kernel share modes have to be disabled
89                 in a share running with the glusterfs vfs module for file
90                 serving to work properly.
91         </para>
92 </refsect1>
93
94 <refsect1>
95         <title>OPTIONS</title>
96
97         <variablelist>
98
99                 <varlistentry>
100                 <term>glusterfs:logfile = path</term>
101                 <listitem>
102                 <para>
103                         Defines whether and where to store a vfs_glusterfs specific
104                         logfile. Client variable substitution is supported (i.e.
105                         %M, %m, %I), hence per client log file can be specified.
106                 </para>
107                 <para>
108                         Example: glusterfs:logfile =
109                         /var/log/samba/glusterfs-vol2.%M.log
110                 </para>
111                 </listitem>
112                 </varlistentry>
113
114                 <varlistentry>
115                 <term>glusterfs:loglevel = 0-9</term>
116                 <listitem>
117                 <para>
118                         Defines the level of logging, with higher numbers corresponding to more verbosity.
119                         0 - No logs; 9 - Trace log level; 7 being the info log level is preferred.
120                 </para>
121                 <para>
122                         If this option is not defined with an explicit loglevel,
123                         the glusterfs default is used (currently loglevel 7).
124                 </para>
125                 </listitem>
126                 </varlistentry>
127
128
129                 <varlistentry>
130                 <term>glusterfs:volfile_server = servername</term>
131                 <listitem>
132                 <para>
133                         Defines which volfile server to use, defaults to
134                         localhost.
135                 </para>
136                 </listitem>
137                 </varlistentry>
138
139                 <varlistentry>
140                 <term>glusterfs:volume = volumename</term>
141                 <listitem>
142                 <para>
143                         Defines the glusterfs volumename to use for this share.
144                 </para>
145                 </listitem>
146
147                 </varlistentry>
148         </variablelist>
149
150 </refsect1>
151
152 <refsect1>
153         <title>VERSION</title>
154
155         <para>
156                 This man page is correct for version 4.2.0 of the Samba suite.
157         </para>
158 </refsect1>
159
160 <refsect1>
161         <title>AUTHOR</title>
162
163         <para>The original Samba software and related utilities
164         were created by Andrew Tridgell. Samba is now developed
165         by the Samba Team as an Open Source project similar
166         to the way the Linux kernel is developed.</para>
167
168 </refsect1>
169
170 </refentry>