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.2</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                 The <command>vfs_glusterfs</command> VFS module exposes
  36                 GlusterFS specific features for use by Samba.
  37         </para>
  38
  39         <para>
  40                 GlusterFS is a clustered file system, capable of scaling
  41                 to several peta-bytes. It aggregates various storage bricks
  42                 over Infiniband RDMA or TCP/IP and interconnect into one large
  43                 parallel network file system. Storage bricks can be made of any
  44                 commodity hardware, such as x86-64 server with SATA-II RAID and
  45                 Infiniband HBA.
  46
  47                 GlusterFS is fully POSIX compliant file system. It supports
  48                 standard clients running standard applications over any standard
  49                 IP network and also FUSE. It works seemlessly on
  50                 different operating systems, currently supported on GNU/Linux
  51                 and Solaris.
  52         </para>
  53
  54         <para>
  55                 This module is stackable, provided glusterfs lies in the bottom
  56                 of the stack.
  57         </para>
  58 </refsect1>
  59
  60 <refsect1>
  61         <title>CONFIGURATION</title>
  62
  63         <para>
  64                 <command>vfs_glusterfs</command> requires that the underlying share
  65                 path is a Gluster filesystem.
  66         </para>
  67
  68         <programlisting>
  69                 <smbconfsection name="[share]"/>
  70                 <smbconfoption name="vfs objects">glusterfs</smbconfoption>
  71         </programlisting>
  72 </refsect1>
  73
  74 <refsect1>
  75         <title>OPTIONS</title>
  76
  77         <variablelist>
  78
  79                 <varlistentry>
  80                 <term>glusterfs:logfile = path</term>
  81                 <listitem>
  82                 <para>
  83                         Defines whether and where to store a vfs_glusterfs specific
  84                         logfile. Client variable substitution is supported (i.e.
  85                         %M, %m, %I), hence per client log file can be
  86                         %specified.
  87                 </para>
  88                 <para>
  89                         Example: glusterfs:logfile =
  90                         %/var/log/samba/glusterfs-vol2.%M.log
  91                 </para>
  92                 </listitem>
  93                 </varlistentry>
  94
  95                 <varlistentry>
  96                 <term>glusterfs:loglevel = 0-9</term>
  97                 <listitem>
  98                 <para>
  99                         Defines the level of logging, with higher numbers corresponding to more verbosity.
 100                         0 - No logs; 9 - Trace log level; 7 being the info log level is preferred.
 101                 </para>
 102                 <para>
 103                         If this option is not defined with an explicit loglevel,
 104                         the glusterfs default is used (currently loglevel 7).
 105                 </para>
 106                 </listitem>
 107                 </varlistentry>
 108
 109
 110                 <varlistentry>
 111                 <term>glusterfs:volfile_server = servername</term>
 112                 <listitem>
 113                 <para>
 114                         Defines which volfile server to use, defaults to
 115                         localhost.
 116                 </para>
 117                 </listitem>
 118                 </varlistentry>
 119
 120                 <varlistentry>
 121                 <term>glusterfs:volume = volumename</term>
 122                 <listitem>
 123                 <para>
 124                         Defines the glusterfs volumename to use for this share.
 125                 </para>
 126                 </listitem>
 127
 128                 </varlistentry>
 129         </variablelist>
 130
 131 </refsect1>
 132
 133 <refsect1>
 134         <title>VERSION</title>
 135
 136         <para>
 137                 This man page is correct for version 4.2.0 of the Samba suite.
 138         </para>
 139 </refsect1>
 140
 141 <refsect1>
 142         <title>AUTHOR</title>
 143
 144         <para>The original Samba software and related utilities
 145         were created by Andrew Tridgell. Samba is now developed
 146         by the Samba Team as an Open Source project similar
 147         to the way the Linux kernel is developed.</para>
 148
 149 </refsect1>
 150
 151 </refentry>