lustre/doc/mkfs.lustre.8

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