lustre/doc/lmc.lyx

   1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 220
   3 \textclass amsart
   4 \language english
   5 \inputencoding auto
   6 \fontscheme times
   7 \graphics default
   8 \paperfontsize default
   9 \spacing single
  10 \papersize letterpaper
  11 \paperpackage a4
  12 \use_geometry 0
  13 \use_amsmath 0
  14 \use_natbib 0
  15 \use_numerical_citations 0
  16 \paperorientation portrait
  17 \secnumdepth 3
  18 \tocdepth 3
  19 \paragraph_separation skip
  20 \defskip medskip
  21 \quotes_language english
  22 \quotes_times 2
  23 \papercolumns 1
  24 \papersides 1
  25 \paperpagestyle default
  26
  27 \layout Section
  28
  29 lmc
  30 \layout Subsection
  31
  32 NAME
  33 \layout Standard
  34
  35 lmc - lustre configuration maker.
  36 \layout Subsection
  37
  38 SYNOPSIS
  39 \layout Standard
  40
  41
  42 \series bold
  43 lmc [options] --add <objectype> [args]
  44 \layout Standard
  45
  46
  47 \series bold
  48 NOT IMPLEMENTED -- lmc [options] --remove <objecttype> [args]
  49 \layout Standard
  50
  51
  52 \series bold
  53 NOT IMPLEMENTED -- lmc [options] --convert [args]
  54 \layout Subsection
  55
  56 DESCRIPTION
  57 \layout Standard
  58
  59 At present lmc when invoked adds configuration data to the config file.
  60  lmc will also be able to remove configuration data or convert its forma.
  61  One generates a single config file for the cluster at present including
  62  at the minimum mds's, mtpt's and ost's and whatever those reference (e.g.
  63  net's and profiles)
  64 \layout Standard
  65
  66 The objecttype refers to a collection of related configuration entities
  67  and can be one of
  68 \series bold
  69 net, mds, lov, ost, mtpt, route, oscref.
  70
  71 \series default
  72 We describe the arguments required for the addition of each objecttype.
  73  [NOT implemented] Lmc can also remove items from or convert the format
  74  of configuration data.
  75 \layout Standard
  76
  77 to generate configuration data associated with systems in a Lustre cluster.
  78
  79 \layout Description
  80
  81 --add\SpecialChar ~
  82 net Adds a network device descriptor for the given node, with parameters
  83  as indicated.
  84 \begin_deeper
  85 \layout Standard
  86
  87 The arguments required are
  88 \layout Description
  89
  90 --node\SpecialChar ~
  91 ''node_name'' If not present this will create a new node with the
  92  given name.
  93  This is also used to specify a specific node for other elements, and the
  94 \layout Description
  95
  96 --nettype\SpecialChar ~
  97 <type> this can be
  98 \series bold
  99 tcp, elan, gm
 100 \layout Description
 101
 102 --nid\SpecialChar ~
 103 nid the network id, e.g.
 104  ElanID or IP address as used by portals.
 105  If host_name is '*', then the local address while be substituted when the
 106  node is configured with lconf.
 107 \layout Description
 108
 109 --router optional flag to mark this node as a router
 110 \layout Description
 111
 112 --profile optional flag to mark this node as a profile node.
 113  This is automatically true if the the --nid argument contains a '*'.
 114 \layout Description
 115
 116 --port\SpecialChar ~
 117 [port] optional argument to indicate the tcp port.
 118  The default is 988.
 119
 120 \layout Description
 121
 122 --tcpbuf\SpecialChar ~
 123 <size> optional argument
 124 \end_deeper
 125 \layout Description
 126
 127 --add\SpecialChar ~
 128 mds
 129 \begin_deeper
 130 \layout Description
 131
 132 --mds\SpecialChar ~
 133 <mds_name>
 134 \layout Description
 135
 136 --dev\SpecialChar ~
 137 <pathname> Path of device on local system.
 138  If the is a file, then a loop device is created and used as the block device.
 139 \layout Description
 140
 141 --size\SpecialChar ~
 142 <size> optional argument indicating the size of the device to be created
 143  (used typically for loop devices).
 144 \layout Description
 145
 146 --node\SpecialChar ~
 147 <nodename> Adds an MDS to the specified node.
 148  This requires a --node argument, and it must not be a profile node.
 149 \end_deeper
 150 \layout Description
 151
 152 --add\SpecialChar ~
 153 lov Creates an LOV with the specified parameters.
 154  The mds_name must already exist in the descriptor.
 155 \begin_deeper
 156 \layout Description
 157
 158 --lov_<name>
 159 \layout Description
 160
 161 --mds_<name>
 162 \layout Description
 163
 164 --stripe_sz\SpecialChar ~
 165 <size>
 166 \layout Description
 167
 168 --stripe_cnt\SpecialChar ~
 169 <count>
 170 \layout Description
 171
 172 --stripe_pattern\SpecialChar ~
 173 <pattern> Pattern can be 0.
 174 \end_deeper
 175 \layout Description
 176
 177 --add\SpecialChar ~
 178 ost Creates an OBD, OST, and OSC.
 179  The OST and OBD are created on the specified node.
 180 \begin_deeper
 181 \layout Description
 182
 183 --obd\SpecialChar ~
 184 <name> Assign a name to the OBD device.
 185 \layout Description
 186
 187 --node\SpecialChar ~
 188 <nodename> Node on which the OST service is run, can not be a profile
 189  node.
 190 \layout Description
 191
 192 --dev\SpecialChar ~
 193 <pathname> Path of device on local system.
 194  If the is a file, then a loop device is created and used as the block device.
 195 \layout Description
 196
 197 --size\SpecialChar ~
 198 [size]
 199 \layout Description
 200
 201 --lov\SpecialChar ~
 202 <name> Name of LOV to which this OSC will be attached.
 203
 204 \layout Description
 205
 206 --obduuid\SpecialChar ~
 207 UUID specify the UUID of the OBD device.
 208  The default value is OBD_nodename_UUID.
 209 \end_deeper
 210 \layout Description
 211
 212 --add\SpecialChar ~
 213 mtpt Creates a mount point on the specified node.
 214  Either an LOV or OSC name can be used.
 215 \begin_deeper
 216 \layout Description
 217
 218 --node\SpecialChar ~
 219 node node or profile node that will use the mtpt
 220 \layout Description
 221
 222 --path\SpecialChar ~
 223 /mnt/path\SpecialChar ~
 224
 225 \layout Description
 226
 227 --mds\SpecialChar ~
 228 mds_name
 229 \layout Description
 230
 231 --obd\SpecialChar ~
 232 lov_name|osc_name
 233 \end_deeper
 234 \layout Description
 235
 236 --add\SpecialChar ~
 237 route Creates a static route through a gateway to a specific nid or
 238  a range of nids.
 239 \begin_deeper
 240 \layout Description
 241
 242 --node\SpecialChar ~
 243 node node or profile node to add the route to
 244 \layout Description
 245
 246 --gw\SpecialChar ~
 247 nid the nid of the gateway (must be a local interface or a peer)
 248 \layout Description
 249
 250 --tgt\SpecialChar ~
 251 nid for a specific route, this is the target nid
 252 \layout Description
 253
 254 --lo\SpecialChar ~
 255 nid for a range route, this is the lo value nid
 256 \layout Description
 257
 258 --hi\SpecialChar ~
 259 nid for a range route, this is the hi value nid
 260 \end_deeper
 261 \layout Description
 262
 263 --add\SpecialChar ~
 264 oscref Adds an OSC reference to a node.
 265  This is only necessary when the the OSC will be used without a mountpoint.
 266 \begin_deeper
 267 \layout Description
 268
 269 --node\SpecialChar ~
 270 node node or profile node to add the OSC ref to
 271 \layout Description
 272
 273 --osc\SpecialChar ~
 274 osc_name Name of the OSC to add a reference to.
 275  The --add ost command automatically creates the OSC, and the name will
 276  be OSC_<node>, where node is the name of node the OST is on.
 277 \end_deeper
 278 \layout Description
 279
 280 Options:
 281 \begin_deeper
 282 \layout Description
 283
 284 --output\SpecialChar ~
 285 filename Sends output to the file.
 286  If the file exists, it will be overwritten.
 287 \layout Description
 288
 289 --merge\SpecialChar ~
 290 filename Add the new element to an existing file.
 291
 292 \end_deeper
 293 \layout Subsection
 294
 295 EXAMPLES
 296 \layout Standard
 297
 298 Real life examples are given in the lustre-conf man page.
 299 \layout Subsection
 300
 301 BUGS
 302 \layout Standard
 303
 304 None are known.
 305 \layout Subsection
 306
 307 AUTHOR
 308 \layout Standard
 309
 310 Cluster File Systems, Inc.
 311  2002 - created
 312 \the_end