lustre/doc/mkfs.lustre.8

   1 .\" -*- nroff -*-
   2 .\" Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Copyright (c) 2011, 2014, Intel Corporation.
   5 .\"
   6 .\" This file may be copied under the terms of the GNU Public License.
   7 .\"
   8 .TH mkfs.lustre 8 "2014 Jun 10" Lustre "configuration utilities"
   9 .SH NAME
  10 mkfs.lustre \- format a disk for a Lustre service
  11 .SH SYNOPSIS
  12 .br
  13 .B mkfs.lustre
  14 .RB { --ost | --mdt | --mgs }
  15 .BR --fsname= <\fIname\fR>
  16 .RI [ options ]
  17 .I device
  18 .br
  19 .B mkfs.lustre
  20 .RB { --ost | --mdt | --mgs }
  21 .B --backfstype=zfs
  22 .BR --fsname= <\fIname\fR>
  23 .RI [ options "] <" pool_name >/< dataset_name "> [<" zpool_specification >]
  24
  25 .SH DESCRIPTION
  26 .B mkfs.lustre
  27 is used to format a disk device for use as part of a Lustre
  28 filesystem. After formatting, a disk can be mounted with
  29 .B mount -t lustre ...
  30 to start the Lustre service defined by this command.
  31
  32 .SH OPTIONS
  33 .TP
  34 .BI \--ost
  35 object storage target
  36 .TP
  37 .BI \--mdt
  38 metadata storage target
  39 .TP
  40 .BI \--mgs
  41 configuration management service, one per site or filesystem.  This service can
  42 be combined with one
  43 .BI \--mdt
  44 service by specifying both types.
  45 .TP
  46 .BI \--backfstype= fstype
  47 Force a particular format for the backing fs (ldiskfs, zfs).
  48 .br
  49 .IR zpool_specification " = [[<" vdev_type ">] <" device "> [<" device "> ...] [<" vdev_type ">] ...]"
  50 .br
  51 .IR vdev_type " ="
  52 .RB { mirror , raidz , raidz2 , raidz3 , cache }
  53 .br
  54 .IR device " = { " "Linux block device" " }"
  55
  56 If no vdev_type is given, then the devices are used in a round-robin
  57 (striped) manner. See
  58 .BR zpool (8)
  59 for more details.
  60 .TP
  61 .BI \--comment= comment
  62 Set user comment about this disk, ignored by Lustre.
  63 .TP
  64 .BI \--device-size= KB
  65 Set device size for loop devices
  66 .TP
  67 .BI \--dryrun
  68 Only print what would be done; does not affect the disk
  69 .TP
  70 .BI \--failnode= nid,...
  71 Set the NID(s) of a failover partner. This option can be repeated as desired.
  72 Cannot be used with --servicenode.
  73 .TP
  74 .BI \--servicenode= nid,....
  75 Set the NID(s) of all service partner. This option treats all nodes as equal
  76 service nodes. Cannot be used with --failnode.
  77 .TP
  78 .BI \--fsname= filesystem_name
  79 The Lustre filesystem this service will be part of. The maximum filesystem_name
  80 length is 8 characters. Required for all targets other than MGS.
  81 .TP
  82 .BI \--index= index
  83 Specify a particular OST or MDT index. Required for all targets other than the MGS.
  84 The index parameter may either be a decimal number or a hexadecimal number
  85 starting with '0x'.
  86 .TP
  87 .BI \--mkfsoptions= opts
  88 Format options for the backing fs. For example, ext3 options could be set here.
  89 .TP
  90 .BI \--mountfsoptions= opts
  91 Set the persistent mount options that will be used when mounting Lustre fs.
  92 WARNING: unlike earlier versions of \fBmkfs.lustre\fR, this version completely
  93 replaces the default mount options with those specified on the command line,
  94 issuing a warning on stderr if any of the default mount options are omitted.
  95 The defaults for \fIldiskfs\fR are
  96 OST: \fIerrors=remount-ro,mballoc,extents\fR;
  97 MGS/MDT: \fIerrors=remount-ro,user_xattr\fR.
  98 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
  99 .TP
 100 .BI \--backfs-mount-opts=opts
 101 Use these options for mounting backing fs while mkfs.lustre is working.
 102 .TP
 103 .BI \--network= net,...
 104 Network(s) to restrict this ost/mdt to. This option can be repeated as desired.
 105 .TP
 106 .BI \--mgsnode= nid,...
 107 Set the NID(s) of the MGS node, required for all targets other than the MGS.
 108 .TP
 109 .BI \--param " key=value"
 110 Set permanent parameter
 111 .I key
 112 to value
 113 .IR value .
 114 This option can be repeated as desired.  Typical options might include:
 115 .RS
 116 .I \--param sys.timeout=40
 117 .RS
 118 System obd timeout
 119 .RE
 120 .I \--param lov.stripesize=2M
 121 .RS
 122 Default stripe size
 123 .RE
 124 .I \--param lov.stripecount=2
 125 .RS
 126 Default stripe count
 127 .RE
 128 .I \--param failover.mode=failout
 129 .RS
 130 Return errors instead of waiting for recovery
 131 .RE
 132 .RE
 133 .TP
 134 .BI \--quiet
 135 Print less information.
 136 .TP
 137 .BI \--reformat
 138 Reformat an existing Lustre disk as a new target
 139 .TP
 140 .BI \--replace
 141 Used to initialize a target with the same
 142 .I --index
 143 as a previously used target if the old target was permanently lost for
 144 some reason (e.g. multiple disk failure or massive corruption).  This
 145 avoids having the target try to register as a new target with the MGS.
 146 .TP
 147 .BI \--stripe-count-hint= stripes
 148 Used for optizing MDT inode size
 149 .TP
 150 .BI \--force-nohostid
 151 Ignore unset hostid for ZFS import protection. To set hostid either set
 152 spl_hostid parameter for spl.ko or set /etc/hostid, see genhostid(1).  To
 153 populate the spl_hostid parameter, spl.ko must be (re)loaded after /etc/hostid is
 154 created.
 155
 156 .TP
 157 .BI \--verbose
 158 Print more information.
 159 .TP
 160 .BI \--version
 161 Output build version of the mkfs.lustre utiltiy.
 162
 163 .SH NID
 164 A Lustre network identifier (NID) is used to uniquely identify a Lustre network
 165 endpoint by node ID and network type. The format of the NID is:
 166 \fInetwork_id@network_type\fR.
 167 If a node has multiple network interfaces, it may have multiple NIDs, which must
 168 all be identified so other nodes can choose the NID that is appropriate for
 169 their network interfaces. Typically, NIDs are specified in a list delimited by
 170 commas (,). However, when failover nodes are specified, the NIDs are delimited
 171 by a colon (:) or by repeating a keyword such as \fI--mgsnode=\fR or
 172 \fI--servicenode=\fR.
 173
 174 .SH EXAMPLES
 175 .TP
 176 .B mkfs.lustre --fsname=testfs --index=0 --mdt --mgs /dev/sda1
 177 Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
 178 .TP
 179 .B mkfs.lustre --fsname=testfs --index=0 --ost --mgsnode=cfs21@tcp0 /dev/sdb
 180 OST for filesystem 'testfs' on any node using the above MGS.
 181 .TP
 182 .B mkfs.lustre --fsname=testfs --index=0 --mdt --mgs --servicenode=cfs21@tcp0,cfs21ib@o2ib0 --servicenode=cfs22@tcp0,cfs22ib@o2ib0 /dev/sda1
 183 Combined MGS and MDT for filesystem 'testfs' on failover pair cfs21 and cfs22.
 184 .TP
 185 .B mkfs.lustre --fsname=testfs --index=0 --ost --mgsnode=cfs21@tcp0,cfs21ib@o2ib0:cfs22@tcp0,cfs22ib@o2ib0 --failnode=cfs24@tcp0,cfs24ib@o2ib0 /dev/sdb
 186 OST for filesystem 'testfs' using the above MGS and having a failover partner
 187 cfs24.
 188 .TP
 189 .B mkfs.lustre --mgs /dev/sda1
 190 Standalone MGS on e.g. node cfs22
 191 .TP
 192 .B mkfs.lustre --fsname=myfs1 --index=0 --mdt --mgsnode=cfs22@tcp0 /dev/sda2
 193 MDT for filesystem 'myfs1' on any node, using the above MGS
 194 .TP
 195 .B mkfs.lustre --fsname=testfs --index=0 --mdt --mgs zfspool/mdt1 mirror /dev/sdb /dev/sdc mirror /dev/sdd /dev/sde
 196 Create zfs pool 'zfspool' on two root vdevs each a mirror of two disks and create mdt/mgs on
 197 filesystem 'zfspool/mdt1'.
 198
 199 .SH AVAILABILITY
 200 .B mkfs.lustre
 201 is part of the
 202 .BR lustre (7)
 203 filesystem package.
 204 .SH SEE ALSO
 205 .BR lustre (7),
 206 .BR mount.lustre (8),
 207 .BR tunefs.lustre (8),
 208 .BR lctl (8),
 209 .BR lfs (1),
 210 .BR zpool (8)