LU-15743 utils: add --xattr option to lfs find

[fs/lustre-release.git] / lustre / doc / mount.lustre.8

diff --git a/lustre/doc/mount.lustre.8 b/lustre/doc/mount.lustre.8
index 2b77c23..a95c05b 100644 (file)
--- a/lustre/doc/mount.lustre.8
+++ b/lustre/doc/mount.lustre.8
@@ -1,52 +1,60 @@
 .\" -*- nroff -*-
 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 .\"
 .\" -*- nroff -*-
 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
 .\"

-.\" Copyright (c) 2012, 2016, Intel Corporation.
+.\" Copyright (c) 2012, 2017, Intel Corporation.

 .\"
 .\" This file may be copied under the terms of the GNU Public License v2.
 .\"
 .\"
 .\" This file may be copied under the terms of the GNU Public License v2.
 .\"

-.TH mount.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
+.TH mount.lustre 8 "2019 Jul 30" Lustre "configuration utilities"

 .SH NAME
 .SH NAME

-mount.lustre \- start a Lustre client or target service
+mount.lustre \- mount helper for Lustre client
+mount.lustre_tgt \- mount helper for Lustre target service

 .SH SYNOPSIS
 .br
 .SH SYNOPSIS
 .br

-.BI "mount \-t lustre [\-o " options "] " "device mountpoint"
+.BI "mount -t lustre [-o " options "] " "<mgsname>:/<fsname> <client_mountpoint>"
+.br
+.BI "mount -t lustre_tgt [-o " options "] " "<block_device> <server_mountpoint>"

 .SH DESCRIPTION
 .B mount.lustre
 .SH DESCRIPTION
 .B mount.lustre

-is used to start a Lustre client or target service.  This program should not be
-called directly; rather it is a helper program invoked through
+and
+.B mount.lustre_tgt
+are used to start a Lustre client or target service, respectively.  They
+should not be called directly; rather they are helper programs invoked through

 .BR mount (8)
 .BR mount (8)

-as above.  Lustre clients and targets are stopped by using the
+as above when the
+.B lustre
+or
+.B lustre_tgt
+filesystem type is used.  Lustre clients and targets are stopped by using the

 .BR umount (8)
 command.
 .br
 
 .BR umount (8)
 command.
 .br
 

-There are two forms for the
-.I device
-option, depending on whether a client or a target service is started:
+There are two forms for the device option passed to the
+.I mount
+command, depending on whether a client or a target service is started:

 .TP
 .IR <mgsname> :/ <fsname>[/<subdir>]
 .TP
 .IR <mgsname> :/ <fsname>[/<subdir>]

-mounts the Lustre filesystem named
+mounts the Lustre client filesystem named

 .I fsname
 (optionally starting at subdirectory
 .I subdir
 within the filesystem, if specified) on the client at the directory
 .I fsname
 (optionally starting at subdirectory
 .I subdir
 within the filesystem, if specified) on the client at the directory

-.IR mountpoint ,
+.IR client_mountpoint ,

 by contacting the Management Service at
 .IR mgsname .
 The format for
 .I mgsname
 by contacting the Management Service at
 .IR mgsname .
 The format for
 .I mgsname

-is defined below.  A client filesystem can be listed in
+is defined below.  A client filesystem will typically be listed in

 .BR fstab (5)
 for automatic mount at boot time, is usable like any local filesystem, and
 provides a full POSIX-compilant interface.
 .TP
 .I block_device
 .BR fstab (5)
 for automatic mount at boot time, is usable like any local filesystem, and
 provides a full POSIX-compilant interface.
 .TP
 .I block_device

-starts the target service defined by the
+specifies the phyisical disk or ZFS dataset uses to start the target service
+formatted by the

 .IR mkfs.lustre (8)
 .IR mkfs.lustre (8)

-command on the physical disk
-.IR block_device .
-The
+command.  The

 .I block_device
 may be specified using
 .BI -L label
 .I block_device
 may be specified using
 .BI -L label


@@ -62,7 +70,7 @@ or similar.  The mounted target service filesystem at
 .I mountpoint
 is only useful for
 .BR df (1)
 .I mountpoint
 is only useful for
 .BR df (1)

-operations and appears in
+operations to show the current space usage, and appears in

 .BR /proc/mounts
 to show the device is in use.
 .SH OPTIONS
 .BR /proc/mounts
 to show the device is in use.
 .SH OPTIONS


@@ -80,8 +88,8 @@ and may be running on any one of the nodes.
 .BI <mgsnode>:= <mgsnid>[,<mgsnid>]
 Each
 .I mgsnode
 .BI <mgsnode>:= <mgsnid>[,<mgsnid>]
 Each
 .I mgsnode

-may be specify a comma-separated list of NIDs, if there are different
-LNet interfaces for that
+may specify a comma-separated list of NIDs, if there are different
+LNet interfaces for the same

 .IR mgsnode .
 .TP
 .BI mgssec= flavor
 .IR mgsnode .
 .TP
 .BI mgssec= flavor


@@ -127,11 +135,12 @@ options:
 .TP
 .BI flock
 Enable full distributed
 .TP
 .BI flock
 Enable full distributed

-.BI flock (2)
+.BR flock (2)

 support, coherent across all client nodes also using this mount option.  This
 is useful if applications need coherent userspace file locking across multiple
 support, coherent across all client nodes also using this mount option.  This
 is useful if applications need coherent userspace file locking across multiple

-client nodes, but also imposes communications overhead in order to maintain
-locking consistency between client nodes.
+client nodes, has no measurable performance impact in modern (2.x) versions of
+Lustre, is therefore the recommended mode, and is enabled by default in Lustre
+2.12.3 and newer.

 .TP
 .BI localflock
 Enable local
 .TP
 .BI localflock
 Enable local


@@ -140,21 +149,17 @@ support, using only client-local file locking.  This is faster than mounting
 with the
 .B flock
 option, and can be used for applications that depend on functioning
 with the
 .B flock
 option, and can be used for applications that depend on functioning

-.BI flock (2)
+.BR flock (2)

 but run only on a single node.
 .TP
 .BI noflock
 Disables
 but run only on a single node.
 .TP
 .BI noflock
 Disables

-.BR flock(2)
-support entirely, and is the default option.  Applications calling
-.BR flock(2)
+.BR flock (2)
+support entirely.  Applications calling
+.BR flock (2)

 will get an
 .B ENOSYS
 will get an
 .B ENOSYS

-error.  It is up to theadministrator to choose either the
-.B localflock
-or
-.B flock
-mount option based on their requirements.  It is possible to mount clients
+error.  It is possible to mount clients

 with different options, and only those mounted with
 .B flock
 will be coherent amongst each other.
 with different options, and only those mounted with
 .B flock
 will be coherent amongst each other.


@@ -187,13 +192,14 @@ Disable use of extended attributes by regular users.  Root and system processes
 Force a client to keep pinging even if servers have enabled suppress_pings.
 .TP
 .BI verbose
 Force a client to keep pinging even if servers have enabled suppress_pings.
 .TP
 .BI verbose

-Enable mount/umount console messages.
+Enable mount/remount/umount console messages.

 .TP
 .BI noverbose
 .TP
 .BI noverbose

-Disable mount/umount console messages.
+Disable mount/remount/umount console messages.

 .TP
 .BI user_fid2path
 .TP
 .BI user_fid2path

-Enable FID to path translation by regular users.
+Enable FID to path translation by regular users via
+.BR "lfs fid2path" .

 .TP
 .BI nouser_fid2path
 Disable FID to path translation by regular users.  Root and process with
 .TP
 .BI nouser_fid2path
 Disable FID to path translation by regular users.  Root and process with


@@ -206,7 +212,23 @@ This option can be useful in case of several Lustre client mount
 points on the same node, with each mount point using a different
 network. It is also interesting when running Lustre clients from
 containers, by restricting each container to a specific network.
 points on the same node, with each mount point using a different
 network. It is also interesting when running Lustre clients from
 containers, by restricting each container to a specific network.

-.SH CLIENT OPTIONS
+.PP
+.RS
+Warning! 'network' option is incompatible with LNet Dynamic Peer Discovery.
+If you want to restrict client NID, please make sure LNet Dynamic Peer Discovery
+is disabled.
+.RE
+.TP
+.BI test_dummy_encryption
+Enable test dummy encryption mode.
+.RE
+.TP
+.BI noencrypt
+Disable Lustre client-side encryption. By default, Lustre client-side encryption
+is enabled, letting users define encryption policies on a per-directory basis.
+fscrypt userspace tool can be used for that purpose, see
+https://github.com/google/fscrypt
+.SH SERVER OPTIONS

 In addition to the standard mount options and backing disk type
 (e.g. ldiskfs) options listed in
 .BR mount (8),
 In addition to the standard mount options and backing disk type
 (e.g. ldiskfs) options listed in
 .BR mount (8),


@@ -215,24 +237,37 @@ Lustre understands the following
 options:
 .TP
 .BI acl
 options:
 .TP
 .BI acl

-Enable POSIX Access Control List support.  See the
+Enable POSIX Access Control List support for all clients.  See the

 .BR acl (5)
 manual page.
 .TP
 .BR acl (5)
 manual page.
 .TP

-.BI noacl
-Disable Access Control List support.
+.BI no_precreate
+Do not allow objects to be created on the OST after mounting.  This
+allows a (potentially newly-formatted) OST to be started without
+clients starting to use it immediately.  To allow the MDS to create
+objects on the OST mount without this option, or run
+.BI "lctl set_param obdfilter." fsname -OST nnnn .no_precreate=0
+on the OSS to re-enable object creation.
+.BR NOTE :
+this does not start the OST read-only, it only disables the
+creation of new objects on the OST.  This means existing objects
+can be read, modified, or deleted, but if the OST is new then it
+will not have any such objects.

 .TP
 .BI nosvc
 .TP
 .BI nosvc

-Only start the MGC (and MGS, if co-located) for a target service, and not the actual service.
+Only start the MGC (and MGS, if co-located) for a target service,
+and not the actual MDS or OSS service.

 .TP
 .BI nomgs
 .TP
 .BI nomgs

-Start a MDT with a co-located MGS without starting the MGS.
+Start an MDT with a co-located MGS without starting the MGS service.

 .TP
 .BI noscrub
 .TP
 .BI noscrub

-Not trigger OI scrub automatically when detect some inconsistency, unless it is started explicitly.
+Do not trigger OI scrub automatically when an inconsistency is detected.
+It is still possible to start explicitly using the
+.BR "lctl lfsck_start" .

 .TP
 .BI skip_lfsck
 .TP
 .BI skip_lfsck

-Not resume the former paused/crashed LFSCK automatically when mount.
+Do not resume the former paused/crashed LFSCK automatically when mounting.

 .TP
 .BI abort_recov
 Abort client recovery and start the target service immediately.
 .TP
 .BI abort_recov
 Abort client recovery and start the target service immediately.


@@ -286,17 +321,17 @@ tries the second one. On each service node, the comma-separated NIDs refer to
 different interfaces on the same host, and the Lustre client chooses the best
 one for communication based on which network interfaces are available locally.
 .TP
 different interfaces on the same host, and the Lustre client chooses the best
 one for communication based on which network interfaces are available locally.
 .TP

-.B mount -t lustre /dev/sda1 /mnt/test/mdt
+.B mount -t lustre_tgt /dev/sda1 /mnt/test/mdt

 Start the Lustre metadata target service from
 .B /dev/sda1
 on mountpoint
 .BR /mnt/test/mdt .
 .TP
 Start the Lustre metadata target service from
 .B /dev/sda1
 on mountpoint
 .BR /mnt/test/mdt .
 .TP

-.B mount -t lustre -L testfs-MDT0000 -o abort_recov /mnt/test/mdt
+.B mount -t lustre_tgt -L testfs-MDT0000 -o abort_recov /mnt/test/mdt

 Start the
 .B testfs-MDT0000
 Start the
 .B testfs-MDT0000

-service (by using the disk label), but aborts the recovery process if
-all of the clients are known to be unavailable.
+service (by using the disk label), but aborts the Lustre client recovery
+process for the case that clients are known to be unavailable.

 .SH BUGS
 Not very many mount options can be changed with
 .BR "-o remount" .
 .SH BUGS
 Not very many mount options can be changed with
 .BR "-o remount" .