lustre/doc/mkfs.lustre.8

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