glusterfs

1
.\"  Copyright (c) 2008-2013 Red Hat, Inc. <http://www.redhat.com>
2
.\"  This file is part of GlusterFS.
3
.\"
4
.\"  This file is licensed to you under your choice of the GNU Lesser
5
.\"  General Public License, version 3 or any later version (LGPLv3 or
6
.\"  later), or the GNU General Public License, version 2 (GPLv2), in all
7
.\"  cases as published by the Free Software Foundation.
8
.\"
9
.\"
10
.\"
11
.TH GlusterFS 8 "Cluster Filesystem" "14 September 2013" "Red Hat, Inc."
12
.SH NAME
13
.B mount.glusterfs - script to mount native GlusterFS volume
14
.SH SYNOPSIS
15
.B mount -t glusterfs [-o <options>] <volumeserver>:/<volume>[/<subdir>]
16
.B         <mountpoint>
17
.TP
18
.B mount -t glusterfs [-o <options>] <server1>,<server2>,
19
.B        <server3>,..<serverN>:/<volname>[/<subdir>] <mount_point>
20
.TP
21
.TP
22
.B mount -t glusterfs [-o <options>] <path/to/volumefile> <mountpoint>
23
.PP
24
.SH DESCRIPTION
25
This tool is part of \fBglusterfs\fR(8) package, which is used to mount using
26
GlusterFS native binary.
27

28
\fBmount.glusterfs\fR is meant to be used by the mount(8) command for mounting
29
native GlusterFS client. This subcommand, however, can also be used as a
30
standalone command with limited functionality.
31

32
.SH OPTIONS
33
.PP
34
.SS "Basic options"
35
.PP
36
.TP
37
\fBlog\-file=\fRLOG-FILE
38
File to use for logging [default:/var/log/glusterfs/glusterfs.log]
39
.TP
40
\fBlog\-level=\fRLOG-LEVEL
41
Logging severity.  Valid options are TRACE, DEBUG, WARNING, ERROR, CRITICAL
42
INFO and NONE [default: INFO]
43
.TP
44
\fBacl
45
Mount the filesystem with POSIX ACL support
46
.TP
47
\fBfopen\-keep\-cache[=BOOL]
48
Do not purge the cache on file open (default: false)
49
.TP
50
\fBworm
51
Mount the filesystem in 'worm' mode
52
.TP
53
\fBaux\-gfid\-mount
54
Enable access to filesystem through gfid directly
55
.TP
56
\fBro\fR
57
Mount the filesystem read-only
58
.TP
59
\fBenable\-ino32=\fRBOOL
60
Use 32-bit inodes when mounting to workaround broken applications that don't
61
support 64-bit inodes
62
.TP
63
\fBmem\-accounting
64
Enable internal memory accounting
65
.TP
66
\fBcapability
67
Enable file capability setting and retrival
68
.TP
69
\fBthin-client
70
Enables thin mount and connects via gfproxyd daemon
71
.TP
72
\fBlocaltime-logging
73
Use local timestamps instead of UTC in mount log entries
74

75
.PP
76
.SS "Advanced options"
77
.PP
78
.TP
79
\fBattribute\-timeout=\fRSECONDS
80
Set attribute timeout to SECONDS for inodes in fuse kernel module [default: 1]
81
.TP
82
\fBentry\-timeout=\fRSECONDS
83
Set entry timeout to SECONDS in fuse kernel module [default: 1]
84
.TP
85
\fBbackground\-qlen=\fRN
86
Set fuse module's background queue length to N [default: 64]
87
.TP
88
\fBgid\-timeout=\fRSECONDS
89
Set auxiliary group list timeout to SECONDS for fuse translator [default: 0]
90
.TP
91
\fBnegative\-timeout=\fRSECONDS
92
Set negative timeout to SECONDS in fuse kernel module [default: 0]
93
.TP
94
\fBvolume\-name=\fRVOLUME-NAME
95
Volume name to be used for MOUNT-POINT [default: top most volume in
96
VOLUME-FILE]
97
.TP
98
\fBdirect\-io\-mode=\fRBOOL|auto
99
Specify fuse direct I/O strategy [default: auto]
100
.TP
101
\fBcongestion\-threshold=\fRN
102
Set fuse module's congestion threshold to N [default: 48]
103
.TP
104
\fsubdir\-mount=\fRN
105
Set the subdirectory mount option [default: NULL, ie, no subdirectory mount]
106
.TP
107
.TP
108
\fBbackup\-volfile\-servers=\fRSERVERLIST
109
Provide list of backup volfile servers in the following format [default: None]
110
If use IPv6 address in SERVERLIST, it is required to use '[' and ']' to surround IPv6 address.
111

112
\fB$ mount \-t glusterfs \-obackup\-volfile\-servers=<server2>:\fR
113
\fB       <server3>:...:<serverN> <server1>:/<volname> <mount_point>\fR
114
\fB$ mount \-t glusterfs \-obackup\-volfile\-servers=<[ipv6_addr2]>:\fR
115
\fB       <[ipv6_addr3]>:...:<[ipv6_addrN]> <ipv6_addr1>:/<volname> <mount_point>\fR
116

117
.TP
118
.TP
119
\fBbackupvolfile\-server=\fRSERVER
120
Provide list of backup volfile servers in the following format [default: None]
121

122
\fB $ mount \-t glusterfs \-obackupvolfile\-server=<server2>
123
\fB         <server1>:/<volname> <mount_point>
124

125
.TP
126
.TP
127
\fBfetch-attempts=\fRN
128
\fBDeprecated\fR option - placed here for backward compatibility [default: 1]
129
.TP
130
.TP
131
\fBlru-limit=\fRN
132
Set fuse module's limit for number of inodes kept in LRU list to N [default: 65536]
133
.TP
134
.TP
135
\fBinode-table-size=\fRN
136
Set the inode hash table size to N - this must be a power of 2 greater than or
137
equal to 65536 and will be rounded up if not [default: 65536]
138
.TP
139
.TP
140
\fBinvalidate-limit=\fRN
141
Suspend fuse invalidations implied by 'lru-limit' if  number of outstanding
142
invalidations reaches N
143
.TP
144
.TP
145
\fBbackground-qlen=\fRN
146
Set fuse module's background queue length to N [default: 64]
147
.TP
148
\fBno\-root\-squash=\fRBOOL
149
disable root squashing for the trusted client [default: off]
150
.TP
151
\fBroot\-squash=\fRBOOL
152
enable root squashing for the trusted client [default: on]
153
.TP
154
\fBuse\-readdirp=\fRBOOL
155
Use readdirp() mode in fuse kernel module [default: on]
156
.TP
157
\fBdump\-fuse=\fRPATH
158
Dump fuse traffic to PATH
159
.TP
160
\fBkernel\-writeback\-cache=\fRBOOL
161
Enable fuse in-kernel writeback cache [default: off]
162
.TP
163
\fBattr\-times\-granularity=\fRNS
164
Declare supported granularity of file attribute [default: 0]
165
.TP
166
\fBauto\-invalidation=\fRBOOL
167
controls whether fuse-kernel can auto-invalidate attribute, dentry and
168
page-cache. Disable this only if same files/directories are not
169
accessed across two different mounts concurrently [default: on]
170
.PP
171
.SH FILES
172
.TP
173
.I /etc/fstab
174
A typical GlusterFS entry in /etc/fstab looks like below
175

176
\fBserver1:/mirror  /mnt/mirror  glusterfs log-file=/var/log/mirror.log,acl   0  0\fR
177

178
.TP
179
.I /proc/mounts
180
An example entry of a GlusterFS mountpoint in /proc/mounts looks like below
181

182
\fBserver1:/mirror /mnt/glusterfs fuse.glusterfs rw,allow_other,default_permissions,max_read=131072 0 0\fR
183

184
.SH SEE ALSO
185
\fBglusterfs\fR(8), \fBmount\fR(8), \fBgluster\fR(8)
186

187
.SH COPYRIGHT
188
Copyright(c) 2006-2013   Red Hat, Inc.   <http://www.redhat.com>
189