[PATCHES] updates to vfs_glusterfs manpage
Michael Adam
obnox at samba.org
Fri Feb 20 02:01:29 MST 2015
Some clarifications and corrections.
Review/push appreciated.
Cheers - Michael
-------------- next part --------------
From 01f208fc672a7937a65828ede7f82a5cfdbd7e36 Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox at samba.org>
Date: Fri, 13 Feb 2015 01:03:21 +0100
Subject: [PATCH 1/3] doc:man:vfs_glusterfs: remove extra % signs.
Signed-off-by: Michael Adam <obnox at samba.org>
Reviewed-by: Guenther Deschner <gd at samba.org>
---
docs-xml/manpages/vfs_glusterfs.8.xml | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/docs-xml/manpages/vfs_glusterfs.8.xml b/docs-xml/manpages/vfs_glusterfs.8.xml
index 83032cc..363ee74 100644
--- a/docs-xml/manpages/vfs_glusterfs.8.xml
+++ b/docs-xml/manpages/vfs_glusterfs.8.xml
@@ -82,12 +82,11 @@
<para>
Defines whether and where to store a vfs_glusterfs specific
logfile. Client variable substitution is supported (i.e.
- %M, %m, %I), hence per client log file can be
- %specified.
+ %M, %m, %I), hence per client log file can be specified.
</para>
<para>
Example: glusterfs:logfile =
- %/var/log/samba/glusterfs-vol2.%M.log
+ /var/log/samba/glusterfs-vol2.%M.log
</para>
</listitem>
</varlistentry>
--
2.1.0
From 8132219530071687cb3349329e3cba5cd0ea2f64 Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox at samba.org>
Date: Fri, 13 Feb 2015 01:04:11 +0100
Subject: [PATCH 2/3] doc:man:vfs_glusterfs: improve and update description.
Signed-off-by: Michael Adam <obnox at samba.org>
---
docs-xml/manpages/vfs_glusterfs.8.xml | 33 +++++++++++++++++----------------
1 file changed, 17 insertions(+), 16 deletions(-)
diff --git a/docs-xml/manpages/vfs_glusterfs.8.xml b/docs-xml/manpages/vfs_glusterfs.8.xml
index 363ee74..f569201 100644
--- a/docs-xml/manpages/vfs_glusterfs.8.xml
+++ b/docs-xml/manpages/vfs_glusterfs.8.xml
@@ -32,28 +32,29 @@
<manvolnum>8</manvolnum></citerefentry> suite.</para>
<para>
- The <command>vfs_glusterfs</command> VFS module exposes
- GlusterFS specific features for use by Samba.
+ GlusterFS
+ (<ulink url="http://www.gluster.org/">http://www.gluster.org</ulink>)
+ is an Open Source clustered file system capable of scaling to
+ several peta-bytes. With its FUSE based native client,
+ GlusterFS is available as a POSIX compliant file system and can
+ hence be shared by Samba without additional steps.
</para>
<para>
- GlusterFS is a clustered file system, capable of scaling
- to several peta-bytes. It aggregates various storage bricks
- over Infiniband RDMA or TCP/IP and interconnect into one large
- parallel network file system. Storage bricks can be made of any
- commodity hardware, such as x86-64 server with SATA-II RAID and
- Infiniband HBA.
-
- GlusterFS is fully POSIX compliant file system. It supports
- standard clients running standard applications over any standard
- IP network and also FUSE. It works seemlessly on
- different operating systems, currently supported on GNU/Linux
- and Solaris.
+ The <command>vfs_glusterfs</command> VFS module provides an
+ alternative, and superior way to access a Gluster filesystem
+ from Samba for sharing. It does not require a Gluster FUSE mount
+ but directly accesses the GlusterFS daemon through its library
+ <command>libgfapi</command>, thereby omitting the expensive
+ kernel-userspace context switches and taking advantage of some
+ of the more advanced features of GlusterFS.
</para>
<para>
- This module is stackable, provided glusterfs lies in the bottom
- of the stack.
+ This module can be combined with other modules, but it
+ should be the last module in the <command>vfs objects</command>
+ list. Modules added to this list to the right of the glusterfs
+ entry may not have any effect at all.
</para>
</refsect1>
--
2.1.0
From 69acba17aff7cafbb9d36b3df935f0d5415f8308 Mon Sep 17 00:00:00 2001
From: Michael Adam <obnox at samba.org>
Date: Thu, 19 Feb 2015 16:59:00 +0100
Subject: [PATCH 3/3] doc:man:vfs_glusterfs: improve the configuration section.
Signed-off-by: Michael Adam <obnox at samba.org>
---
docs-xml/manpages/vfs_glusterfs.8.xml | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/docs-xml/manpages/vfs_glusterfs.8.xml b/docs-xml/manpages/vfs_glusterfs.8.xml
index f569201..c0c320c 100644
--- a/docs-xml/manpages/vfs_glusterfs.8.xml
+++ b/docs-xml/manpages/vfs_glusterfs.8.xml
@@ -62,14 +62,33 @@
<title>CONFIGURATION</title>
<para>
- <command>vfs_glusterfs</command> requires that the underlying share
- path is a Gluster filesystem.
+ A basic configuration looks like this.
</para>
<programlisting>
<smbconfsection name="[share]"/>
<smbconfoption name="vfs objects">glusterfs</smbconfoption>
+ <smbconfoption name="path">/relative/base/path</smbconfoption>
+ <smbconfoption name="glusterfs:volume">gv0</smbconfoption>
+ <smbconfoption name="kernel share modes">no</smbconfoption>
</programlisting>
+
+ <para>
+ Note that since <command>vfs_glusterfs</command> does not
+ require a Gluster mount, the share <command>path</command> is
+ treated differently than for other shares: It is interpreted as
+ the base path of the share relative to the gluster volume used.
+ Because this is usually not at the same time a system path, in a
+ ctdb cluster setup where ctdb manages Samba, you need to set
+ <command>CTDB_SAMBA_SKIP_SHARE_CHECK=yes</command> in ctdb's
+ configuration file. Otherwise ctdb will not get healthy.
+ </para>
+
+ <para>
+ Note that currently kernel share modes have to be disabled
+ in a share running with the glusterfs vfs module for file
+ serving to work properly.
+ </para>
</refsect1>
<refsect1>
--
2.1.0
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: not available
URL: <http://lists.samba.org/pipermail/samba-technical/attachments/20150220/b4c90e94/attachment.pgp>
More information about the samba-technical
mailing list