lustre/doc/lmc.lyx

   1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 221
   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 Description
  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 lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]
  49 \layout Standard
  50
  51
  52 \series bold
  53 lmc [options] --convert [args] -- [NOT IMPLEMENTED]
  54 \layout Subsection
  55
  56 DESCRIPTION
  57 \layout Standard
  58
  59 At present
  60 \series bold
  61 \emph on
  62 lmc
  63 \series default
  64 \emph default
  65 , when invoked, adds configuration data to the config file.
  66  In future,
  67 \series bold
  68 \emph on
  69 lmc
  70 \series default
  71 \emph default
  72  will also be able to remove configuration data or convert its format.
  73  A Lustre cluster consists of several components - MDS's, mount-points,
  74  OSTs, LOVs and whatever those reference (e.g nets and profiles).
  75  A single configuration file would be generated for the complete cluster.
  76  In the
  77 \series bold
  78 \emph on
  79 lmc
  80 \series default
  81 \emph default
  82  command line interface, each of these components is associated with an
  83
  84 \emph on
  85 objecttype
  86 \emph default
  87 .
  88
  89 \layout Standard
  90
  91 The
  92 \emph on
  93 objecttype
  94 \emph default
  95  refers to a collection of related configuration entities and can be one
  96  of
  97 \series bold
  98 net
  99 \series default
 100 ,
 101 \series bold
 102  MDS
 103 \series default
 104 ,
 105 \series bold
 106  LOV
 107 \series default
 108 ,
 109 \series bold
 110  OST
 111 \series default
 112 ,
 113 \series bold
 114  mtpt
 115 \series default
 116 ,
 117 \series bold
 118  route
 119 \series default
 120 ,
 121 \series bold
 122
 123 \series default
 124 or
 125 \series bold
 126  echo_client.
 127
 128 \series default
 129 We describe the arguments required for the addition of each
 130 \emph on
 131 objecttype
 132 \emph default
 133 .
 134
 135 \layout Standard
 136
 137 To generate configuration data associated with systems in a Lustre cluster:
 138 \layout Description
 139
 140
 141 \emph on
 142 -
 143 \emph default
 144 -add\SpecialChar ~
 145 node Adds a new node in the cluster configuration.
 146
 147 \begin_deeper
 148 \layout Standard
 149
 150 The arguments required are:
 151 \layout Description
 152
 153 --node\SpecialChar ~
 154 ''node_name'' This will create a new node with the given name if not
 155  already present.
 156 \layout Description
 157
 158 --timeout\SpecialChar ~
 159 <num> Timeout before going into recovery
 160 \layout Description
 161
 162 --lustre_upcall\SpecialChar ~
 163 <path> Set the location of the Lustre upcall scripts used
 164  by the client for recovery
 165 \layout Description
 166
 167 --portals_upcall\SpecialChar ~
 168 <path> Specify the location of the Portals upcall scripts
 169  used by the client for recovery
 170 \layout Description
 171
 172 --upcall\SpecialChar ~
 173 <path> Specify the location of both (Lustre and Portals) upcall
 174  scripts used by the client for recovery
 175 \end_deeper
 176 \layout Description
 177
 178
 179 \emph on
 180 -
 181 \emph default
 182 -add\SpecialChar ~
 183 net Adds a network device descriptor for the given node, with parameters
 184  as indicated.
 185 \begin_deeper
 186 \layout Standard
 187
 188 The arguments required are:
 189 \layout Description
 190
 191 --node\SpecialChar ~
 192 ''node_name'' This will create a new node with the given name if not
 193  already present.
 194  This is also used to specify a specific node for other elements.
 195 \layout Description
 196
 197 --nettype\SpecialChar ~
 198 <type> This can be
 199 \series bold
 200 tcp, elan, gm.
 201 \layout Description
 202
 203 --nid\SpecialChar ~
 204 nid The network
 205 \emph on
 206 id
 207 \emph default
 208 , e.g.
 209  ElanID or IP address as used by Portals.
 210  If
 211 \emph on
 212 nid
 213 \emph default
 214  is '*', then the local address of the interface with specified
 215 \series bold
 216 nettype
 217 \series default
 218 is will be substituted when the node is configured with lconf.
 219  An
 220 \emph on
 221 nid
 222 \emph default
 223  of
 224 \emph on
 225 '*'
 226 \emph default
 227  should be used only for the generic
 228 \emph on
 229 client
 230 \emph default
 231  configuration.
 232 \layout Description
 233
 234 --hostaddr addr
 235 \layout Description
 236
 237 --router Optional flag to mark this node as a router
 238 \layout Description
 239
 240 --port\SpecialChar ~
 241 [port] Optional arguement to indicate the tcp port.
 242  The default is 988.
 243
 244 \layout Description
 245
 246 --tcpbuf\SpecialChar ~
 247 <size> Optional arguement.
 248  The default TCP buffer size is 1MB.
 249 \layout Description
 250
 251 --irq_affinity\SpecialChar ~
 252 0|1 Optional arguement.
 253  Default is 0.
 254 \layout Description
 255
 256 --nid_exchange\SpecialChar ~
 257 0|1 Optional arguement since some OSTs might not have the
 258  required support.
 259  This is turned off by default, value of 1 will turn it ON.
 260
 261 \end_deeper
 262 \layout Description
 263
 264 --add\SpecialChar ~
 265 mds
 266 \begin_deeper
 267 \layout Description
 268
 269 --node\SpecialChar ~
 270 <node\SpecialChar ~
 271 name> Name of the node on which the MDS resides
 272 \layout Description
 273
 274 --mds\SpecialChar ~
 275 <mds_name>
 276 \layout Description
 277
 278 --dev\SpecialChar ~
 279 <pathname> Path of device on local system.
 280  If the is a file, then a loop device is created and used as the block device.
 281 \layout Description
 282
 283 --size\SpecialChar ~
 284 <size> Optional argument indicating the size (in KB) of the device
 285  to be created (used typically for loop devices).
 286 \layout Description
 287
 288 --node\SpecialChar ~
 289 <nodename> Adds an MDS to the specified node.
 290  This requires a
 291 \emph on
 292 --node
 293 \emph default
 294  argument, and it must not be a profile node.
 295 \layout Description
 296
 297 --fstype\SpecialChar ~
 298 extN|ext3 Optional argument used to specify the file system type.
 299  Default is ext3.
 300 \layout Description
 301
 302 --journal_size\SpecialChar ~
 303 <size> Optional arguement to specify the journal size for
 304  the ext2/ext3 file system.
 305  The size should be in the units expected by
 306 \series bold
 307 mkfs
 308 \series default
 309 , so for ext3 it should be in MB.
 310  If this is option is not used, the ext2/ext3 filesystem will be configured
 311  with the default journal size.
 312 \end_deeper
 313 \layout Description
 314
 315 --add\SpecialChar ~
 316 lov Creates an LOV with the specified parameters.
 317  The
 318 \emph on
 319 mds_name
 320 \emph default
 321  must already exist in the descriptor.
 322 \begin_deeper
 323 \layout Description
 324
 325 --lov\SpecialChar ~
 326 <name>
 327 \layout Description
 328
 329 --mds\SpecialChar ~
 330 <name>
 331 \layout Description
 332
 333 --stripe_sz\SpecialChar ~
 334 <size>
 335 \layout Description
 336
 337 --stripe_cnt\SpecialChar ~
 338 <count> A value of 0 for this means to stripe on all available
 339  OSTs.
 340  Default is 0.
 341 \layout Description
 342
 343 --stripe_pattern\SpecialChar ~
 344 <pattern> Only Pattern 0 (RAID 0) is supported currently.
 345 \end_deeper
 346 \layout Description
 347
 348 --add\SpecialChar ~
 349 ost Creates an OBD, OST, and OSC.
 350  The OST and OBD are created on the specified node.
 351 \begin_deeper
 352 \layout Description
 353
 354 --ost\SpecialChar ~
 355 <name> Assign a name to the OST device.
 356 \layout Description
 357
 358 --node\SpecialChar ~
 359 <nodename> Node on which the OST service is run, can not be a profile
 360  node.
 361 \layout Description
 362
 363 --dev\SpecialChar ~
 364 <pathname> Path of device on local system.
 365  If this is a file, then a loop device is created and used as the block
 366  device.
 367 \layout Description
 368
 369 --size\SpecialChar ~
 370 [size] Optional argument indicating the size (in KB) of the device
 371  to be created (used typically for loop devices).
 372 \layout Description
 373
 374 --obdtype\SpecialChar ~
 375 obdfilter|obdecho
 376 \layout Description
 377
 378 --lov\SpecialChar ~
 379 <name> Optional arguement.
 380  Name of LOV to which this OSC will be attached.
 381
 382 \layout Description
 383
 384 --ostuuid\SpecialChar ~
 385 UUID Specify the UUID of the OST device.
 386
 387 \layout Description
 388
 389 --fstype\SpecialChar ~
 390 extN|ext3 Optional arguement used to specify the file system type.
 391  Default is ext3.
 392 \layout Description
 393
 394 --journal_size\SpecialChar ~
 395 <size> Optional arguement to specify the journal size for
 396  the ext2/ext3 file system.
 397  The size should be in the units expected by
 398 \series bold
 399 mkfs
 400 \series default
 401 , so for ext3 it should be in MB.
 402  If this is option is not used, the ext2/ext3 filesystem will be configured
 403  with the default journal size.
 404 \end_deeper
 405 \layout Description
 406
 407 --add\SpecialChar ~
 408 mtpt Creates a mount-point on the specified node.
 409  Either an LOV or OSC name can be used.
 410 \begin_deeper
 411 \layout Description
 412
 413 --node\SpecialChar ~
 414 node Node or profile node that will use the
 415 \emph on
 416 mtpt
 417 \emph default
 418 .
 419 \layout Description
 420
 421 --path\SpecialChar ~
 422 /mnt/path\SpecialChar ~
 423
 424 \layout Description
 425
 426 --mds\SpecialChar ~
 427 mds_name
 428 \layout Description
 429
 430 --ost\SpecialChar ~
 431 ost_name\SpecialChar ~
 432 |\SpecialChar ~
 433 --lov\SpecialChar ~
 434 lov_name
 435 \end_deeper
 436 \layout Description
 437
 438 --add\SpecialChar ~
 439 route Creates a static route through a gateway to a specific
 440 \emph on
 441 nid
 442 \emph default
 443  or a range of
 444 \emph on
 445 nid
 446 \emph default
 447 's.
 448 \begin_deeper
 449 \layout Description
 450
 451 --node\SpecialChar ~
 452 node Node to add the route to.
 453 \layout Description
 454
 455 --gw\SpecialChar ~
 456 nid The
 457 \emph on
 458 nid
 459 \emph default
 460  of the gateway (must be a local interface or a peer).
 461 \layout Description
 462
 463 --tgt\SpecialChar ~
 464 nid For a specific route, this is the target
 465 \emph on
 466 nid.
 467 \layout Description
 468
 469 --lo\SpecialChar ~
 470 nid For a range route, this is the lo value
 471 \emph on
 472 nid.
 473 \layout Description
 474
 475 --hi\SpecialChar ~
 476 nid For a range route, this is the hi value
 477 \emph on
 478 nid.
 479 \end_deeper
 480 \layout Description
 481
 482 --add\SpecialChar ~
 483 echo-client Used for testing purpose only.
 484
 485 \begin_deeper
 486 \layout Description
 487
 488 --node\SpecialChar ~
 489 node
 490 \emph on
 491
 492 \layout Description
 493
 494 --obd\SpecialChar ~
 495 obd_name
 496 \end_deeper
 497 \layout List
 498 \labelwidthstring 00.00.0000
 499
 500
 501 \series bold
 502 Options
 503 \layout Description
 504
 505 --output\SpecialChar ~
 506 filename Send output to the file.
 507  If the file exists, it will be overwritten.
 508 \layout Description
 509
 510 --merge\SpecialChar ~
 511 filename
 512 \emph on
 513
 514 \emph default
 515 Add the new element to an existing file.
 516
 517 \layout Subsection
 518
 519 EXAMPLES
 520 \layout Standard
 521
 522 Real life examples are given in the Lustre-conf manual page.
 523 \layout Subsection
 524
 525 BUGS
 526 \layout Standard
 527
 528 None are known.
 529 \the_end