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, v2.
   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 Cannot be used with --servicenode.
  51 .TP
  52 .BI \--servicenode= nid,....
  53 Set the NID(s) of all service partner. This option treats all nodes as equal
  54 service nodes. Cannot be used with --failnode.
  55 .TP
  56 .BI \--fsname= filesystem_name
  57 The Lustre filesystem this service will be part of.  The maximum
  58 filesystem_name length is 8 characters. Default is 'lustre'
  59 .TP
  60 .BI \--index= index
  61 Force a particular OST or MDT index
  62 .TP
  63 .BI \--mkfsoptions= opts
  64 Format options for the backing fs. For example, ext3 options could be set here.
  65 .TP
  66 .BI \--mountfsoptions= opts
  67 Set the mount options that will be used when mounting the backing fs.
  68 WARNING: unlike earlier versions of \fBmkfs.lustre\fR, this version completely
  69 replaces the default mount options with those specified on the command line,
  70 issuing a warning on stderr if any of the default mount options are omitted.
  71 The defaults for \fIldiskfs\fR are
  72 OST: \fIerrors=remount-ro,mballoc,extents\fR;
  73 MGS/MDT: \fIerrors=remount-ro,iopen_nopriv,user_xattr\fR.
  74 \fBDO NOT\fR alter the default mount options unless you know what you are doing.
  75 .TP
  76 .BI \--mgsnode= nid,...
  77 Set the NID(s) of the MGS node, required for all targets other than the MGS.
  78 .TP
  79 .BI \--param " key=value"
  80 Set permanent parameter
  81 .I key
  82 to value
  83 .IR value .
  84 This option can be repeated as desired.  Typical options might include:
  85 .RS
  86 .I \--param sys.timeout=40
  87 .RS
  88 System obd timeout
  89 .RE
  90 .I \--param lov.stripesize=2M
  91 .RS
  92 Default stripe size
  93 .RE
  94 .I \--param lov.stripecount=2
  95 .RS
  96 Default stripe count
  97 .RE
  98 .I \--param failover.mode=failout
  99 .RS
 100 Return errors instead of waiting for recovery
 101 .RE
 102 .RE
 103 .TP
 104 .BI \--quiet
 105 Print less information.
 106 .TP
 107 .BI \--reformat
 108 Reformat an existing Lustre disk
 109 .TP
 110 .BI \--stripe-count-hint= stripes
 111 Used for optizing MDT inode size
 112 .TP
 113 .BI \--verbose
 114 Print more information.
 115
 116 .SH EXAMPLES
 117 .TP
 118 .B mkfs.lustre --fsname=testfs --mdt --mgs /dev/sda1
 119 Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
 120 .TP
 121 .B mkfs.lustre --fsname=testfs --ost --mgsnode=cfs21@tcp0 /dev/sdb
 122 OST for filesystem 'testfs' on any node using the above MGS.
 123 .TP
 124 .B mkfs.lustre --mgs /dev/sda1
 125 Standalone MGS on e.g. node cfs22
 126 .TP
 127 .B mkfs.lustre --fsname=myfs1 --mdt --mgsnode=cfs22@tcp0 /dev/sda2
 128 MDT for filesystem 'myfs1' on any node, using the above MGS
 129
 130 .SH BUGS
 131 Please report all bugs to Sun Microsystems via http://bugzilla.lustre.org/
 132 .SH AVAILABILITY
 133 .B mkfs.lustre
 134 is part of the
 135 .BR Lustre (7)
 136 filesystem package and is available from Sun Microsystems via
 137 .br
 138 http://downloads.lustre.org/
 139 .SH SEE ALSO
 140 .BR lustre (7),
 141 .BR mount.lustre (8),
 142 .BR tunefs.lustre (8),
 143 .BR lctl (8),
 144 .BR lfs (1)