glusterfs

1
.\"  Copyright (c) 20088888888-2012 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" "19 March 2010" "Gluster Inc."
12
.SH NAME
13
GlusterFS \- Clustered Filesystem.
14
.SH SYNOPSIS
15
.B glusterfsd
16
.I [options] [mountpoint]
17
.PP
18
.SH DESCRIPTION
19
GlusterFS is a clustered file-system capable of scaling to several peta-bytes.
20
It aggregates various storage bricks over Infiniband RDMA or TCP/IP
21
interconnect into one large parallel network file system. Storage bricks can
22
be made of any commodity hardware such as x86-64 server with SATA-II RAID and
23
Infiniband HBA.
24

25
GlusterFS is fully POSIX compliant FileSystem. On client side, it has dependency
26
on FUSE package, on server side, it works seemlessly on different OSes.
27
(Currently supported on GNU/Linux, Solaris).
28

29
.SH OPTIONS
30
.PP
31
Mandatory or optional arguments to long options are also mandatory or optional
32
for any corresponding short options.
33
.SS "Basic options"
34
.PP
35
.TP
36

37
\fB\-f, \fB\-\-volfile=VOLUME-FILE\fR
38
File to use as VOLUME-FILE [default:/etc/glusterfs/glusterfs.vol]
39
.TP
40
\fB\-l, \fB\-\-log\-file=LOGFILE\fR
41
File to use for logging [default:/var/log/glusterfs/glusterfs.log]
42
.TP
43
\fB\-L, \fB\-\-log\-level=LOGLEVEL\fR
44
Logging severity.  Valid options are TRACE, DEBUG, INFO, WARNING, ERROR and
45
CRITICAL [default: WARNING]
46
.TP
47
\fB\-s, \fB\-\-volfile\-server=SERVER\fR
48
Server to get the volume from.  This option overrides \fB\-\-volfile option
49

50
.SS "Advanced options"
51
.PP
52
.TP
53

54
\fB\-\-localtime\-logging\fR
55
Enable localtime log timestamps.
56
.TP
57
\fB\-\-debug\fR
58
Run in debug mode.  This option sets \fB\-\-no\-daemon\fR, \fB\-\-log\-level\fR to DEBUG
59
and \fB\-\-log\-file\fR to console
60
.TP
61
\fB\-N, \fB\-\-no\-daemon\fR
62
Run in foreground
63
.TP
64
\fB\-\-read\-only\fR
65
Makes the filesystem read-only
66
.TP
67
\fB\-p, \fB\-\-pid\-file=PIDFILE\fR
68
File to use as pid file
69
.TP
70
\fB\-S SOCKFILE
71
Socket file to used for inter-process communication
72
.TP
73
\fB\-\-brick\-name DIRECTORY
74
Directory to be used as export directory for GlusterFS
75
.TP
76
\fB\-\-brick\-port PORT
77
Brick Port to be registered with Gluster portmapper
78
.TP
79
\fB\-\-volfile\-id=KEY\fR
80
KEY of the volume file to be fetched from server
81
.TP
82
\fB\-\-volfile\-server\-port=PORT\fR
83
Port number of volfile server
84
.TP
85
\fB\-\-volfile\-server\-transport=TRANSPORT\fR
86
Transport type to get volume file from server [default: tcp]
87
.TP
88
\fB\-\-volume\-name=VOLUME\-NAME\fR
89
Volume name to be used for MOUNT-POINT [default: top most volume in
90
VOLUME-FILE]
91
.TP
92
\fB\-\-xlator\-option=VOLUME\-NAME.OPTION=VALUE\fR
93
Add/override a translator option for a volume with the specified value
94

95
.SS "Fuse options"
96
.PP
97
.TP
98

99
\fB\-\-attribute\-timeout=SECONDS\fR
100
Set attribute timeout to SECONDS for inodes in fuse kernel module [default: 1]
101
.TP
102
\fB\-\-entry\-timeout=SECONDS\fR
103
Set entry timeout to SECONDS in fuse kernel module [default: 1]
104
.TP
105
\fB\-\-direct\-io\-mode=BOOL\fR
106
Enable/Disable direct-io mode in fuse module [default: enable]
107
.TP
108
\fB\-\-resolve-gids\fR
109
Resolve all auxiliary groups in fuse translator (max 32 otherwise)
110
.TP
111
\fB\-\-auto\-invalidation=BOOL\fR
112
controls whether fuse-kernel can auto-invalidate attribute, dentry and
113
page-cache. Disable this only if same files/directories are not
114
accessed across two different mounts concurrently [default: on]
115

116
.SS "Miscellaneous Options"
117
.PP
118
.TP
119

120
\fB\-?, \fB\-\-help\fR
121
Give this help list
122
.TP
123
\fB\-\-usage\fR
124
Give a short usage message
125
.TP
126
\fB\-V, \fB\-\-version\fR
127
Print program version
128

129
.PP
130
.SH FILES
131
/etc/glusterfs/*.vol
132

133
.SH EXAMPLES
134
Start a GlusterFS server on localhost with volume name foo
135

136
glusterfsd \-s localhost \-\-volfile\-id foo.server.media-disk\-1 \-p /var/lib/glusterd/vols/foo/run/server\-media\-disk\-1.pid \-S /tmp/<uniqueid>.socket \-\-brick-name /media/disk\-1 \-l /var/log/glusterfs/bricks/media\-disk\-1.log \-\-brick\-port 24009 \-\-xlator\-option foo\-server.listen-port=24009
137

138
.SH SEE ALSO
139
.nf
140
\fBfusermount\fR(1), \fBmount.glusterfs\fR(8), \fBgluster\fR(8)
141
\fR
142
.fi
143
.SH COPYRIGHT
144
.nf
145
Copyright(c) 2006-2011  Gluster, Inc.  <http://www.gluster.com>
146
\fR
147
.fi
148