docs-xml/manpages/vfs_glusterfs_fuse.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_fuse.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_glusterfs_fuse</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_glusterfs_fuse</refname>
  16         <refpurpose>
  17                 Utilize features provided by GlusterFS
  18         </refpurpose>
  19 </refnamediv>
  20
  21 <refsynopsisdiv>
  22         <cmdsynopsis>
  23                 <command>vfs objects = glusterfs_fuse</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_fuse</command> VFS module provides an enhanced way
  45                 to access a Gluster filesystem using a Gluster FUSE mount. It provides support
  46                 for the <command>get_real_filename</command> VFS call which enhances file access performance
  47                 by avoiding multiple expensive case folding lookup calls to detect the appropriate
  48                 case of an exisiting filename.
  49         </para>
  50
  51         <para>
  52                 Furthermore, this module implements a substitute file-id
  53                 mechanism. The default file-id mechanism is not working
  54                 correctly for gluster fuse mount re-exports, so in order to
  55                 avoid data loss, users exporting gluster fuse mounts with
  56                 Samba should enable this module.
  57         </para>
  58
  59         <para>
  60                 This module can be combined with other modules, but it
  61                 should be the last module in the <command>vfs objects</command>
  62                 list. Modules added to this list to the right of the glusterfs
  63                 entry may not have any effect at all.
  64         </para>
  65 </refsect1>
  66
  67 <refsect1>
  68         <title>CONFIGURATION</title>
  69
  70         <para>
  71                 A basic configuration looks like this.
  72         </para>
  73
  74         <programlisting>
  75                 <smbconfsection name="[share]"/>
  76                 <smbconfoption name="vfs objects">glusterfs_fuse</smbconfoption>
  77                 <smbconfoption name="path">/absolute/path_of_fusemount</smbconfoption>
  78         </programlisting>
  79
  80         <para>
  81                 Note that <command>vfs_glusterfs_fuse</command> requires a Gluster mount. For accessing glusterfs directly
  82                 over the GFAPI library please use the <command>vfs_glusterfs</command> module.
  83         </para>
  84 </refsect1>
  85
  86 <refsect1>
  87         <title>OPTIONS</title>
  88         <para>
  89                 This module does currently have no further options.
  90         </para>
  91 </refsect1>
  92
  93 <refsect1>
  94         <title>VERSION</title>
  95
  96         <para>
  97                 This man page is part of version &doc.version; of the Samba suite.
  98         </para>
  99 </refsect1>
 100
 101 <refsect1>
 102         <title>AUTHOR</title>
 103
 104         <para>The original Samba software and related utilities
 105         were created by Andrew Tridgell. Samba is now developed
 106         by the Samba Team as an Open Source project similar
 107         to the way the Linux kernel is developed.</para>
 108
 109 </refsect1>
 110
 111 </refentry>