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, 2012, Intel Corporation.
   5 .\"
   6 .\" This file may be copied under the terms of the GNU Public License.
   7 .\"
   8 .TH mkfs.lustre 8 "2008 Mar 15" Lustre "configuration utilities"
   9 .SH NAME
  10 mkfs.lustre \- format a disk for a Lustre service
  11 .SH SYNOPSIS
  12 .br
  13 .BR mkfs.lustre { --ost | --mdt | --mgs }
  14 .I [options]
  15 .I device
  16 .br
  17 .B <target_type>
  18 is one of
  19 .TP
  20 .BI \--ost
  21 object storage target
  22 .TP
  23 .BI \--mdt
  24 metadata storage target
  25 .TP
  26 .BI \--mgs
  27 configuration management service - one per site.  This service can be
  28 combined with one
  29 .BI \--mdt
  30 service by specifying both types
  31 .SH DESCRIPTION
  32 .B mkfs.lustre
  33 is used to format a disk device for use as part of a Lustre
  34 filesystem. After formatting, a disk can be mounted to start the Lustre
  35 service defined by this command.
  36
  37 .SH OPTIONS
  38 .TP
  39 .BI \--backfstype= fstype
  40 Force a particular format for the backing fs (ext3, ldiskfs)
  41 .TP
  42 .BI \--comment= comment
  43 Set user comment about this disk, ignored by Lustre.
  44 .TP
  45 .BI \--device-size= KB
  46 Set device size for loop devices
  47 .TP
  48 .BI \--dryrun
  49 Only print what would be done; does not affect the disk
  50 .TP
  51 .BI \--failnode= nid,...
  52 Set the NID(s) of a failover partner. This option can be repeated as desired.
  53 Cannot be used with --servicenode.
  54 .TP
  55 .BI \--servicenode= nid,....
  56 Set the NID(s) of all service partner. This option treats all nodes as equal
  57 service nodes. Cannot be used with --failnode.
  58 .TP
  59 .BI \--fsname= filesystem_name
  60 The Lustre filesystem this service will be part of.  The maximum
  61 filesystem_name length is 8 characters. Default is 'lustre'
  62 .TP
  63 .BI \--index= index
  64 Force a particular OST or MDT index
  65 .TP
  66 .BI \--mkfsoptions= opts
  67 Format options for the backing fs. For example, ext3 options could be set here.
  68 .TP
  69 .BI \--mountfsoptions= opts
  70 Set the mount options that will be used when mounting the backing fs.
  71 WARNING: unlike earlier versions of \fBmkfs.lustre\fR, this version completely
  72 replaces the default mount options with those specified on the command line,
  73 issuing a warning on stderr if any of the default mount options are omitted.
  74 The defaults for \fIldiskfs\fR are
  75 OST: \fIerrors=remount-ro,mballoc,extents\fR;
  76 MGS/MDT: \fIerrors=remount-ro,user_xattr\fR.
  77 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
  78 .TP
  79 .BI \--network= net,...
  80 Network(s) to restrict this ost/mdt to. This option can be repeated as desired.
  81 .TP
  82 .BI \--mgsnode= nid,...
  83 Set the NID(s) of the MGS node, required for all targets other than the MGS.
  84 .TP
  85 .BI \--param " key=value"
  86 Set permanent parameter
  87 .I key
  88 to value
  89 .IR value .
  90 This option can be repeated as desired.  Typical options might include:
  91 .RS
  92 .I \--param sys.timeout=40
  93 .RS
  94 System obd timeout
  95 .RE
  96 .I \--param lov.stripesize=2M
  97 .RS
  98 Default stripe size
  99 .RE
 100 .I \--param lov.stripecount=2
 101 .RS
 102 Default stripe count
 103 .RE
 104 .I \--param failover.mode=failout
 105 .RS
 106 Return errors instead of waiting for recovery
 107 .RE
 108 .RE
 109 .TP
 110 .BI \--quiet
 111 Print less information.
 112 .TP
 113 .BI \--reformat
 114 Reformat an existing Lustre disk
 115 .TP
 116 .BI \--stripe-count-hint= stripes
 117 Used for optizing MDT inode size
 118 .TP
 119 .BI \--verbose
 120 Print more information.
 121
 122 .SH EXAMPLES
 123 .TP
 124 .B mkfs.lustre --fsname=testfs --mdt --mgs /dev/sda1
 125 Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
 126 .TP
 127 .B mkfs.lustre --fsname=testfs --ost --mgsnode=cfs21@tcp0 /dev/sdb
 128 OST for filesystem 'testfs' on any node using the above MGS.
 129 .TP
 130 .B mkfs.lustre --mgs /dev/sda1
 131 Standalone MGS on e.g. node cfs22
 132 .TP
 133 .B mkfs.lustre --fsname=myfs1 --mdt --mgsnode=cfs22@tcp0 /dev/sda2
 134 MDT for filesystem 'myfs1' on any node, using the above MGS
 135
 136 .SH AVAILABILITY
 137 .B mkfs.lustre
 138 is part of the
 139 .BR Lustre (7)
 140 filesystem package.
 141 .SH SEE ALSO
 142 .BR lustre (7),
 143 .BR mount.lustre (8),
 144 .BR tunefs.lustre (8),
 145 .BR lctl (8),
 146 .BR lfs (1)