lustre/doc/mkfs.lustre.8

   1 .\" -*- nroff -*-
   2 .\" Copyright 2006 by Cluster FileSystems.  All Rights Reserved.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\"
   5 .TH mkfs.lustre 8 "2006 Jun 15" Lustre "configuration utilities"
   6 .SH NAME
   7 mkfs.lustre \- format a disk for a Lustre service
   8 .SH SYNOPSIS
   9 .br
  10 .B mkfs.lustre
  11 <target_type> [options]
  12 .I device
  13 .br
  14 where
  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 \--failnode= nid,...
  47 Set the NID(s) of a failover partner. This option can be repeated as desired.
  48 .TP
  49 .BI \--fsname= filesystem_name
  50 The Lustre filesystem this service will be part of.  Default is 'lustre'
  51 .TP
  52 .BI \--index= index
  53 Force a particular OST or MDT index
  54 .TP
  55 .BI \--mkfsoptions= opts
  56 Format options for the backing fs. For example, ext3 options could be set here.
  57 .TP
  58 .BI \--mountfsoptions= opts
  59 Set permanent mount options, equivalent to setting in /etc/fstab
  60 .TP
  61 .BI \--mgsnode= nid,...
  62 Set the NID(s) of the MGS node, required for all targets other than the MGS.
  63 .TP
  64 .BI \--noformat
  65 Only print what would be done; does not affect the disk
  66 .TP
  67 .BI \--param " key=value"
  68 Set permanent parameter
  69 .I key
  70 to value
  71 .I value.
  72 This option can be repeated as desired.  Typical options might include:
  73 .RS
  74 .I \--param sys.timeout=40
  75 .RS
  76 System obd timeout
  77 .RE
  78 .I \--param lov.stripe.size=2097152
  79 .RS
  80 Default stripe size
  81 .RE
  82 .I \--param lov.stripe.count=2
  83 .RS
  84 Default stripe count
  85 .RE
  86 .I \--param failover.mode=failout
  87 .RS
  88 Return errs instead of waiting for recovery
  89 .RE
  90 .RE
  91 .TP
  92 .BI \--quiet
  93 Print less information.
  94 .TP
  95 .BI \--reformat
  96 Reformat an existing Lustre disk
  97 .TP
  98 .BI \--stripe-count-hint= stripes
  99 Used for optizing MDT inode size
 100 .TP
 101 .BI \--verbose
 102 Print more information.
 103
 104 .SH EXAMPLES
 105 .TP
 106 .B mkfs.lustre --fsname=testfs --mdt --mgs /dev/sda1
 107 Combined MGS and MDT for filesystem 'testfs' on node e.g. cfs21
 108 .TP
 109 .B mkfs.lustre --fsname=testfs --ost --mgsnode=cfs21@tcp0 /dev/sdb
 110 OST for filesystem 'testfs' on any node using the above MGS.
 111 .TP
 112 .B mkfs.lustre --mgs /dev/sda1
 113 Standalone MGS on e.g. node cfs22
 114 .TP
 115 .B mkfs.lustre --fsname=myfs1 --mdt --mgsnode=cfs22@tcp0 /dev/sda2
 116 MDT for filesystem 'myfs1' on any node, using the above MGS
 117
 118 .SH BUGS
 119 Please report all bugs to Cluster FileSystems, support@clusterfs.com
 120 .SH AVAILABILITY
 121 .B mkfs.lustre
 122 is part of the
 123 .BR Lustre (7)
 124 filesystem package and is available from CFS
 125 .br
 126 http://clusterfs.com
 127 .SH SEE ALSO
 128 .BR Lustre (7),
 129 .BR mount.lustre (8),
 130 .BR tunefs.lustre (8),
 131 .BR lctl (8),
 132 .BR lfs (1)