| 1 | '\" t
|
|---|
| 2 | .\" Title: vfs_glusterfs
|
|---|
| 3 | .\" Author: [see the "AUTHOR" section]
|
|---|
| 4 | .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
|
|---|
| 5 | .\" Date: 10/25/2016
|
|---|
| 6 | .\" Manual: System Administration tools
|
|---|
| 7 | .\" Source: Samba 4.4
|
|---|
| 8 | .\" Language: English
|
|---|
| 9 | .\"
|
|---|
| 10 | .TH "VFS_GLUSTERFS" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
|
|---|
| 11 | .\" -----------------------------------------------------------------
|
|---|
| 12 | .\" * Define some portability stuff
|
|---|
| 13 | .\" -----------------------------------------------------------------
|
|---|
| 14 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 15 | .\" http://bugs.debian.org/507673
|
|---|
| 16 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|---|
| 17 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|---|
| 18 | .ie \n(.g .ds Aq \(aq
|
|---|
| 19 | .el .ds Aq '
|
|---|
| 20 | .\" -----------------------------------------------------------------
|
|---|
| 21 | .\" * set default formatting
|
|---|
| 22 | .\" -----------------------------------------------------------------
|
|---|
| 23 | .\" disable hyphenation
|
|---|
| 24 | .nh
|
|---|
| 25 | .\" disable justification (adjust text to left margin only)
|
|---|
| 26 | .ad l
|
|---|
| 27 | .\" -----------------------------------------------------------------
|
|---|
| 28 | .\" * MAIN CONTENT STARTS HERE *
|
|---|
| 29 | .\" -----------------------------------------------------------------
|
|---|
| 30 | .SH "NAME"
|
|---|
| 31 | vfs_glusterfs \- Utilize features provided by GlusterFS
|
|---|
| 32 | .SH "SYNOPSIS"
|
|---|
| 33 | .HP \w'\ 'u
|
|---|
| 34 | vfs objects = glusterfs
|
|---|
| 35 | .SH "DESCRIPTION"
|
|---|
| 36 | .PP
|
|---|
| 37 | This VFS module is part of the
|
|---|
| 38 | \fBsamba\fR(8)
|
|---|
| 39 | suite\&.
|
|---|
| 40 | .PP
|
|---|
| 41 | GlusterFS (http://www\&.gluster\&.org) 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\&.
|
|---|
| 42 | .PP
|
|---|
| 43 | The
|
|---|
| 44 | vfs_glusterfs
|
|---|
| 45 | 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
|
|---|
| 46 | libgfapi, thereby omitting the expensive kernel\-userspace context switches and taking advantage of some of the more advanced features of GlusterFS\&.
|
|---|
| 47 | .PP
|
|---|
| 48 | This module can be combined with other modules, but it should be the last module in the
|
|---|
| 49 | vfs objects
|
|---|
| 50 | list\&. Modules added to this list to the right of the glusterfs entry may not have any effect at all\&.
|
|---|
| 51 | .SH "CONFIGURATION"
|
|---|
| 52 | .PP
|
|---|
| 53 | A basic configuration looks like this\&.
|
|---|
| 54 | .sp
|
|---|
| 55 | .if n \{\
|
|---|
| 56 | .RS 4
|
|---|
| 57 | .\}
|
|---|
| 58 | .nf
|
|---|
| 59 | \fI[share]\fR
|
|---|
| 60 | \m[blue]\fBvfs objects = glusterfs\fR\m[]
|
|---|
| 61 | \m[blue]\fBpath = /relative/base/path\fR\m[]
|
|---|
| 62 | \m[blue]\fBglusterfs:volume = gv0\fR\m[]
|
|---|
| 63 | \m[blue]\fBkernel share modes = no\fR\m[]
|
|---|
| 64 |
|
|---|
| 65 | .fi
|
|---|
| 66 | .if n \{\
|
|---|
| 67 | .RE
|
|---|
| 68 | .\}
|
|---|
| 69 | .PP
|
|---|
| 70 | Note that since
|
|---|
| 71 | vfs_glusterfs
|
|---|
| 72 | does not require a Gluster mount, the share
|
|---|
| 73 | path
|
|---|
| 74 | 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
|
|---|
| 75 | CTDB_SAMBA_SKIP_SHARE_CHECK=yes
|
|---|
| 76 | in ctdb\*(Aqs configuration file\&. Otherwise ctdb will not get healthy\&.
|
|---|
| 77 | .PP
|
|---|
| 78 | 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\&.
|
|---|
| 79 | .SH "OPTIONS"
|
|---|
| 80 | .PP
|
|---|
| 81 | glusterfs:logfile = path
|
|---|
| 82 | .RS 4
|
|---|
| 83 | 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\&.
|
|---|
| 84 | .sp
|
|---|
| 85 | Example: glusterfs:logfile = /var/log/samba/glusterfs\-vol2\&.%M\&.log
|
|---|
| 86 | .RE
|
|---|
| 87 | .PP
|
|---|
| 88 | glusterfs:loglevel = 0\-9
|
|---|
| 89 | .RS 4
|
|---|
| 90 | Defines the level of logging, with higher numbers corresponding to more verbosity\&. 0 \- No logs; 9 \- Trace log level; 7 being the info log level is preferred\&.
|
|---|
| 91 | .sp
|
|---|
| 92 | If this option is not defined with an explicit loglevel, the glusterfs default is used (currently loglevel 7)\&.
|
|---|
| 93 | .RE
|
|---|
| 94 | .PP
|
|---|
| 95 | glusterfs:volfile_server = servername
|
|---|
| 96 | .RS 4
|
|---|
| 97 | Defines which volfile server to use, defaults to localhost\&.
|
|---|
| 98 | .RE
|
|---|
| 99 | .PP
|
|---|
| 100 | glusterfs:volume = volumename
|
|---|
| 101 | .RS 4
|
|---|
| 102 | Defines the glusterfs volumename to use for this share\&.
|
|---|
| 103 | .RE
|
|---|
| 104 | .SH "VERSION"
|
|---|
| 105 | .PP
|
|---|
| 106 | This man page is correct for version 4\&.2\&.0 of the Samba suite\&.
|
|---|
| 107 | .SH "AUTHOR"
|
|---|
| 108 | .PP
|
|---|
| 109 | The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
|
|---|
