lustre/doc/mount.lustre.8

   1 .\" -*- nroff -*-
   2 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Copyright (c) 2012, 2017, Intel Corporation.
   5 .\"
   6 .\" This file may be copied under the terms of the GNU Public License v2.
   7 .\"
   8 .TH mount.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
   9 .SH NAME
  10 mount.lustre \- start a Lustre client or target service
  11 .SH SYNOPSIS
  12 .br
  13 .BI "mount \-t lustre [\-o " options "] " "<block_device> <server_mountpoint>"
  14 .br
  15 .BI "mount \-t lustre [\-o " options "] " "<mgsname>:/<fsname> <client_mountpoint>"
  16 .SH DESCRIPTION
  17 .B mount.lustre
  18 is used to start a Lustre client or target service.  This program should not
  19 be called directly; rather it is a helper program invoked through
  20 .BR mount (8)
  21 as above when the
  22 .B lustre
  23 filesystem type is used.  Lustre clients and targets are stopped by using the
  24 .BR umount (8)
  25 command.
  26 .br
  27
  28 There are two forms for the device option passed to the
  29 .I mount
  30 command, depending on whether a client or a target service is started:
  31 .TP
  32 .IR <mgsname> :/ <fsname>[/<subdir>]
  33 mounts the Lustre filesystem named
  34 .I fsname
  35 (optionally starting at subdirectory
  36 .I subdir
  37 within the filesystem, if specified) on the client at the directory
  38 .IR client_mountpoint ,
  39 by contacting the Management Service at
  40 .IR mgsname .
  41 The format for
  42 .I mgsname
  43 is defined below.  A client filesystem will typically be listed in
  44 .BR fstab (5)
  45 for automatic mount at boot time, is usable like any local filesystem, and
  46 provides a full POSIX-compilant interface.
  47 .TP
  48 .I block_device
  49 starts the target service defined by the
  50 .IR mkfs.lustre (8)
  51 command on the physical disk or ZFS dataset given by
  52 .IR block_device .
  53 The
  54 .I block_device
  55 may be specified using
  56 .BI -L label
  57 to find the first block device with that label (e.g.
  58 .BR testfs-MDT0000 ),
  59 or by UUID using the
  60 .BI -U uuid
  61 option. Care should be taken if there is a device-level backup of
  62 the target filesystem, which would have a duplicate label and UUID if it is
  63 not changed with
  64 .BR tune2fs (8)
  65 or similar.  The mounted target service filesystem at
  66 .I mountpoint
  67 is only useful for
  68 .BR df (1)
  69 operations and appears in
  70 .BR /proc/mounts
  71 to show the device is in use.
  72 .SH OPTIONS
  73 .TP
  74 .BI <mgsname>:= <mgsnode>[:<mgsnode>]
  75 The
  76 .I mgsname
  77 may be a colon-separated list of
  78 .I mgsnode
  79 names where the MGS service may run.  Multiple
  80 .I mgsnode
  81 values can be specified if the MGS service is configures for HA failover
  82 and may be running on any one of the nodes.
  83 .TP
  84 .BI <mgsnode>:= <mgsnid>[,<mgsnid>]
  85 Each
  86 .I mgsnode
  87 may specify a comma-separated list of NIDs, if there are different
  88 LNet interfaces for the same
  89 .IR mgsnode .
  90 .TP
  91 .BI mgssec= flavor
  92 Specifies the encryption flavour for the initial network RPC connection to
  93 the MGS node.  Non-security flavors are:
  94 .BR null ,
  95 .BR plain ,
  96 and
  97 .BR gssnull ,
  98 which respectively disable, or have no encryption or integrity features for
  99 testing purposes.  Kerberos flavors are:
 100 .BR krb5n ,
 101 .BR krb5a ,
 102 .BR krb5i ,
 103 and
 104 .BR krb5p .
 105 Shared-secret key flavors are:
 106 .BR skn ,
 107 .BR ska ,
 108 .BR ski ,
 109 and
 110 .BR skpi ,
 111 see
 112 .BR lgss_sk (8)
 113 for more details.  The security flavour for client-to-server connections is
 114 specified in the filesystem configuration that the client fetches from the MGS.
 115 .TP
 116 .BI skpath= file|directory
 117 Path to a file or directory with the keyfile(s) to load for this mount command.
 118 Keys are inserted into the KEY_SPEC_SESSION_KEYRING keyring with a description
 119 containing "lustre:" and a suffix which depends on whether the context of the
 120 mount command is for an MGS, MDT/OST, or client.
 121 This option is only available when built with --enable-gss.
 122 .TP
 123 .BI exclude= ostlist
 124 Start a client or MDT with a (colon-separated) list of known inactive OSTs.
 125 .SH CLIENT OPTIONS
 126 In addition to the standard options listed in
 127 .BR mount (8),
 128 Lustre understands the following
 129 .B client-specific
 130 options:
 131 .TP
 132 .BI flock
 133 Enable full distributed
 134 .BI flock (2)
 135 support, coherent across all client nodes also using this mount option.  This
 136 is useful if applications need coherent userspace file locking across multiple
 137 client nodes, but also imposes communications overhead in order to maintain
 138 locking consistency between client nodes.
 139 .TP
 140 .BI localflock
 141 Enable local
 142 .BR flock (2)
 143 support, using only client-local file locking.  This is faster than mounting
 144 with the
 145 .B flock
 146 option, and can be used for applications that depend on functioning
 147 .BI flock (2)
 148 but run only on a single node.
 149 .TP
 150 .BI noflock
 151 Disables
 152 .BR flock(2)
 153 support entirely, and is the default option.  Applications calling
 154 .BR flock(2)
 155 will get an
 156 .B ENOSYS
 157 error.  It is up to the administrator to choose either the
 158 .B localflock
 159 or
 160 .B flock
 161 mount option based on their requirements.  It is possible to mount clients
 162 with different options, and only those mounted with
 163 .B flock
 164 will be coherent amongst each other.
 165 .TP
 166 .BI lazystatfs
 167 Allows
 168 .BR statfs (2)
 169 (as used by
 170 .BR df (1)
 171 and
 172 .BR lfs-df (1))
 173 to return even if some OST or MDT is unresponsive or has been temporarily
 174 or permanently disabled in the configuration.  This avoids blocking until
 175 all of the targets are available.  This is the default since Lustre 2.9.0.
 176 .TP
 177 .BI nolazystatfs
 178 Requires that
 179 .BR statfs (2)
 180 block until all OSTs and MDTs are available and have returned space usage.
 181 .TP
 182 .BI user_xattr
 183 Enable get/set of extended attributes by regular users.  See the
 184 .BR attr (5)
 185 manual page.
 186 .TP
 187 .BI nouser_xattr
 188 Disable use of extended attributes by regular users.  Root and system processes can still use extended attributes.
 189 .TP
 190 .BI always_ping
 191 Force a client to keep pinging even if servers have enabled suppress_pings.
 192 .TP
 193 .BI verbose
 194 Enable mount/remount/umount console messages.
 195 .TP
 196 .BI noverbose
 197 Disable mount/remount/umount console messages.
 198 .TP
 199 .BI user_fid2path
 200 Enable FID to path translation by regular users via
 201 .BR "lfs fid2path" .
 202 .TP
 203 .BI nouser_fid2path
 204 Disable FID to path translation by regular users.  Root and process with
 205 CAP_DAC_READ_SEARCH can still perform FID to path translation.
 206 .TP
 207 .BI network= net
 208 Limit connections from the client to be on the network NID specified by 'net'.
 209 \'net\' designates a single network NID, like 'o2ib2' or 'tcp1'.
 210 This option can be useful in case of several Lustre client mount
 211 points on the same node, with each mount point using a different
 212 network. It is also interesting when running Lustre clients from
 213 containers, by restricting each container to a specific network.
 214 .PP
 215 .RS
 216 Warning! 'network' option is incompatible with LNet Dynamic Peer Discovery.
 217 If you want to restrict client NID, please make sure LNet Dynamic Peer Discovery
 218 is disabled.
 219 .RE
 220 .SH SERVER OPTIONS
 221 In addition to the standard mount options and backing disk type
 222 (e.g. ldiskfs) options listed in
 223 .BR mount (8),
 224 Lustre understands the following
 225 .B server-specific
 226 options:
 227 .TP
 228 .BI acl
 229 Enable POSIX Access Control List support for all clients.  See the
 230 .BR acl (5)
 231 manual page.
 232 .TP
 233 .BI nosvc
 234 Only start the MGC (and MGS, if co-located) for a target service,
 235 and not the actual MDS or OSS service.
 236 .TP
 237 .BI nomgs
 238 Start an MDT with a co-located MGS without starting the MGS service.
 239 .TP
 240 .BI noscrub
 241 Do not trigger OI scrub automatically when an inconsistency is detected.
 242 It is still possible to start explicitly using the
 243 .BR "lctl lfsck_start" .
 244 .TP
 245 .BI skip_lfsck
 246 Do not resume the former paused/crashed LFSCK automatically when mounting.
 247 .TP
 248 .BI abort_recov
 249 Abort client recovery and start the target service immediately.
 250 .TP
 251 .BI md_stripe_cache_size
 252 Sets the stripe cache size for server side disk with a striped raid
 253 configuration.
 254 .TP
 255 .BI max_sectors_kb
 256 Automatically Sets the block device parameter of 'max_sectors_kb' for the
 257 MDT or OST target. When max_sectors_kb isn't specified, that parameter for
 258 block device will be set to same as it's own 'max_hw_sectors_kb' (up to a
 259 maximum of 16M), this is default behavior suited for most users. When
 260 max_sectors_kb is specified as zero, the old parameter value will be kept.
 261 When max_sectors_kb is specified as a positive number, the parameter will
 262 be set to this number arbitrarily.
 263 .TP
 264 .BI recovery_time_soft= timeout
 265 Allow 'timeout' seconds for clients to reconnect for recovery after a server
 266 crash.  This timeout will be incrementally extended if it is about to expire
 267 and the server is still handling new connections from recoverable clients.
 268 The default soft recovery timeout is set to 300 seconds (5 minutes).
 269 .TP
 270 .BI recovery_time_hard= timeout
 271 The server will be allowed to incrementally extend its timeout up to a hard
 272 maximum of 'timeout' seconds.  The default hard recovery timeout is set to
 273 900 seconds (15 minutes).
 274 .SH EXAMPLES
 275 .TP
 276 .B mount -t lustre cfs21@tcp0:/testfs /mnt/myfilesystem
 277 Start a client for the Lustre filesystem
 278 .B testfs
 279 at the mount point
 280 .BR /mnt/myfilesystem .
 281 The Management Service is running on a node reachable via NID
 282 .BR cfs21@tcp0 .
 283 .TP
 284 .B mount -t lustre cfs21@tcp0:/testfs/dir /mnt/myfilesystem
 285 Like above example, but mount subdirectory
 286 .B dir
 287 as fileset.
 288 .TP
 289 .B mount -t lustre mgs1@tcp0,mgs1ib@o2ib0:mgs2@tcp0,mgs2ib@o2ib0:/testfs /mnt/fs
 290 Like above example, but the Management Service is running on one of the service
 291 nodes
 292 .B mgs1
 293 and
 294 .B mgs2, which are two different hosts separated by a colon and
 295 served as a failover pair. Lustre tries the first one, and if that fails, it
 296 tries the second one. On each service node, the comma-separated NIDs refer to
 297 different interfaces on the same host, and the Lustre client chooses the best
 298 one for communication based on which network interfaces are available locally.
 299 .TP
 300 .B mount -t lustre /dev/sda1 /mnt/test/mdt
 301 Start the Lustre metadata target service from
 302 .B /dev/sda1
 303 on mountpoint
 304 .BR /mnt/test/mdt .
 305 .TP
 306 .B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
 307 Start the
 308 .B testfs-MDT0000
 309 service (by using the disk label), but aborts the recovery process if
 310 all of the clients are known to be unavailable.
 311 .SH BUGS
 312 Not very many mount options can be changed with
 313 .BR "-o remount" .
 314 .SH AVAILABILITY
 315 .B mount.lustre
 316 is part of the
 317 .BR Lustre (7)
 318 filesystem package.
 319 .SH SEE ALSO
 320 .BR lustre (7),
 321 .BR mount (8),
 322 .BR mkfs.lustre (8),
 323 .BR tunefs.lustre (8),
 324 .BR lctl (8),
 325 .BR lfs (1)