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  echo_client, or cobd.
 123
 124 \series default
 125 We describe the arguments required for the addition of each
 126 \emph on
 127 objecttype
 128 \emph default
 129 .
 130
 131 \layout Standard
 132
 133 To generate configuration data associated with systems in a Lustre cluster:
 134 \layout Description
 135
 136
 137 \emph on
 138 -
 139 \emph default
 140 -add\SpecialChar ~
 141 node Adds a new node in the cluster configuration.
 142
 143 \begin_deeper
 144 \layout Standard
 145
 146 The arguments required are:
 147 \layout Description
 148
 149 --node\SpecialChar ~
 150 ''node_name'' This will create a new node with the given name if not
 151  already present.
 152 \layout Description
 153
 154 --timeout\SpecialChar ~
 155 <num> Timeout before going into recovery
 156 \layout Description
 157
 158 --lustre_upcall\SpecialChar ~
 159 <path> Set the location of the Lustre upcall scripts used
 160  by the client for recovery
 161 \layout Description
 162
 163 --portals_upcall\SpecialChar ~
 164 <path> Specify the location of the Portals upcall scripts
 165  used by the client for recovery
 166 \layout Description
 167
 168 --upcall\SpecialChar ~
 169 <path> Specify the location of both (Lustre and Portals) upcall
 170  scripts used by the client for recovery
 171 \layout Description
 172
 173 --ptldebug\SpecialChar ~
 174 <debug_level> Set the portals debug level.
 175 \layout Description
 176
 177 --subsytem\SpecialChar ~
 178 <subsystem_name> Specify which Lustre subsystems have debug output
 179  recorded in the log.
 180 \end_deeper
 181 \layout Description
 182
 183
 184 \emph on
 185 -
 186 \emph default
 187 -add\SpecialChar ~
 188 net Adds a network device descriptor for the given node, with parameters
 189  as indicated.
 190 \begin_deeper
 191 \layout Standard
 192
 193 The arguments required are:
 194 \layout Description
 195
 196 --node\SpecialChar ~
 197 ''node_name'' This will create a new node with the given name if not
 198  already present.
 199  This is also used to specify a specific node for other elements.
 200 \layout Description
 201
 202 --nettype\SpecialChar ~
 203 <type> Specify the network type.This can be
 204 \series bold
 205 tcp, elan, gm.
 206 \layout Description
 207
 208 --nid\SpecialChar ~
 209 nid The network
 210 \emph on
 211 id
 212 \emph default
 213 , e.g.
 214  ElanID or IP address as used by Portals.
 215  If
 216 \emph on
 217 nid
 218 \emph default
 219  is '*', then the local address of the interface with specified
 220 \series bold
 221 nettype
 222 \series default
 223 is will be substituted when the node is configured with lconf.
 224  An
 225 \emph on
 226 nid
 227 \emph default
 228  of
 229 \emph on
 230 '*'
 231 \emph default
 232  should be used only for the generic
 233 \emph on
 234 client
 235 \emph default
 236  configuration.
 237 \layout Description
 238
 239 --cluster_id\SpecialChar ~
 240 id Specify the cluster ID.
 241 \layout Description
 242
 243 --hostaddr\SpecialChar ~
 244 addr Specify the host address.
 245  lconf will transfer it to the real host address.
 246 \layout Description
 247
 248 --router Optional flag to mark this node as a router
 249 \layout Description
 250
 251 --port\SpecialChar ~
 252 [port] Optional arguement to indicate the tcp port.
 253  The default is 988.
 254
 255 \layout Description
 256
 257 --tcpbuf\SpecialChar ~
 258 <size> Optional arguement.
 259  The default TCP buffer size is 1MB.
 260 \layout Description
 261
 262 --irq_affinity\SpecialChar ~
 263 0|1 Optional arguement.
 264  Default is 0.
 265 \layout Description
 266
 267 --nid_exchange\SpecialChar ~
 268 0|1 Optional arguement since some OSTs might not have the
 269  required support.
 270  This is turned off by default, value of 1 will turn it ON.
 271
 272 \end_deeper
 273 \layout Description
 274
 275 --add\SpecialChar ~
 276 mds
 277 \begin_deeper
 278 \layout Description
 279
 280 --node\SpecialChar ~
 281 <node\SpecialChar ~
 282 name> Name of the node on which the MDS resides
 283 \layout Description
 284
 285 --mds\SpecialChar ~
 286 <mds_name> Specify MDS name.
 287 \layout Description
 288
 289 --failover Enable failover support on MDS.
 290 \layout Description
 291
 292 --dev\SpecialChar ~
 293 <pathname> Path of device on local system.
 294  If the is a file, then a loop device is created and used as the block device.
 295 \layout Description
 296
 297 --backdev\SpecialChar ~
 298 <pathname> Path of the device for backing storage on local system.
 299 \layout Description
 300
 301 --size\SpecialChar ~
 302 <size> Optional argument indicating the size (in KB) of the device
 303  to be created (used typically for loop devices).
 304 \layout Description
 305
 306 --node\SpecialChar ~
 307 <nodename> Adds an MDS to the specified node.
 308  This requires a
 309 \emph on
 310 --node
 311 \emph default
 312  argument, and it must not be a profile node.
 313 \layout Description
 314
 315 --fstype\SpecialChar ~
 316 extN|ext3 Optional argument used to specify the file system type.
 317  Default is ext3.
 318 \layout Description
 319
 320 --backfstype\SpecialChar ~
 321 ext3|tmpfs Optional argument to specify the backing filesystem
 322  type.
 323 \layout Description
 324
 325 --nspath Local mount point of server namespace.
 326 \layout Description
 327
 328 --inode_size\SpecialChar ~
 329 <size> Specify new inode size for underlying ext3 file system.
 330 \layout Description
 331
 332 --mkfsoptions\SpecialChar ~
 333 <options> Optional argument to mkfs.
 334 \layout Description
 335
 336 --mountfsoptions\SpecialChar ~
 337 <options> Optional argument to mount fs.
 338  Mount options will be passed by this argument.
 339  For example, extents are to be enabled by adding ",extents" to the --mountfsopt
 340 ions option.
 341
 342 \begin_inset Quotes eld
 343 \end_inset
 344
 345 errors=remount-ro
 346 \begin_inset Quotes erd
 347 \end_inset
 348
 349  and
 350 \begin_inset Quotes eld
 351 \end_inset
 352
 353 asyncdel
 354 \begin_inset Quotes erd
 355 \end_inset
 356
 357  can also be added to it.
 358 \layout Description
 359
 360 --journal_size\SpecialChar ~
 361 <size> Optional arguement to specify the journal size for
 362  the ext2/ext3 file system.
 363  The size should be in the units expected by
 364 \series bold
 365 mkfs
 366 \series default
 367 , so for ext3 it should be in MB.
 368  If this is option is not used, the ext2/ext3 filesystem will be configured
 369  with the default journal size.
 370 \end_deeper
 371 \layout Description
 372
 373 --add\SpecialChar ~
 374 lov Creates an LOV with the specified parameters.
 375  The
 376 \emph on
 377 mds_name
 378 \emph default
 379  must already exist in the descriptor.
 380 \begin_deeper
 381 \layout Description
 382
 383 --lov\SpecialChar ~
 384 <name> Specify LOV name.
 385 \layout Description
 386
 387 --mds\SpecialChar ~
 388 <name> Specify the mds name.
 389 \layout Description
 390
 391 --stripe_sz\SpecialChar ~
 392 <size> Specify the stripe size in bytes.
 393 \layout Description
 394
 395 --stripe_cnt\SpecialChar ~
 396 <count> A value of 0 for this means to stripe on all available
 397  OSTs.
 398  Default is 0.
 399 \layout Description
 400
 401 --stripe_pattern\SpecialChar ~
 402 <pattern> Only Pattern 0 (RAID 0) is supported currently.
 403 \end_deeper
 404 \layout Description
 405
 406 --add\SpecialChar ~
 407 ost Creates an OBD, OST, and OSC.
 408  The OST and OBD are created on the specified node.
 409 \begin_deeper
 410 \layout Description
 411
 412 --ost\SpecialChar ~
 413 <name> Assign a name to the OST device.
 414 \layout Description
 415
 416 --node\SpecialChar ~
 417 <nodename> Node on which the OST service is run, can not be a profile
 418  node.
 419 \layout Description
 420
 421 --failover Enable failover support on OST.
 422 \layout Description
 423
 424 --dev\SpecialChar ~
 425 <pathname> Path of device on local system.
 426  If this is a file, then a loop device is created and used as the block
 427  device.
 428 \layout Description
 429
 430 --backdev\SpecialChar ~
 431 <pathname> Path of the device for backing storage on local system.
 432 \layout Description
 433
 434 --size\SpecialChar ~
 435 [size] Optional argument indicating the size (in KB) of the device
 436  to be created (used typically for loop devices).
 437 \layout Description
 438
 439 --osdtype\SpecialChar ~
 440 obdfilter|obdecho Specify the type of OSD.
 441 \layout Description
 442
 443 --lov\SpecialChar ~
 444 <name> Optional arguement.
 445  Name of LOV to which this OSC will be attached.
 446
 447 \layout Description
 448
 449 --ostuuid\SpecialChar ~
 450 UUID Specify the UUID of the OST device.
 451
 452 \layout Description
 453
 454 --fstype\SpecialChar ~
 455 extN|ext3 Optional arguement used to specify the file system type.
 456  Default is ext3.
 457 \layout Description
 458
 459 --backfstype\SpecialChar ~
 460 ext3|tmpfs Optional argument to specify the backing filesystem
 461  type.
 462 \layout Description
 463
 464 --inode_size\SpecialChar ~
 465 <size> Specify new inode size for underlying ext3 file system.
 466 \layout Description
 467
 468 --nspath Local mount point of server namespace.
 469 \layout Description
 470
 471 --mkfsoptions\SpecialChar ~
 472 <options> Optional argument to mkfs.
 473 \layout Description
 474
 475 --mountfsoptions\SpecialChar ~
 476 <options> Optional argument to mount fs.
 477  Mount options will be passed by this argument.
 478  For example, extents are to be enabled by adding ",extents" to the --mountfsopt
 479 ions option.
 480
 481 \begin_inset Quotes eld
 482 \end_inset
 483
 484 errors=remount-ro
 485 \begin_inset Quotes erd
 486 \end_inset
 487
 488  and
 489 \begin_inset Quotes eld
 490 \end_inset
 491
 492 asyncdel
 493 \begin_inset Quotes erd
 494 \end_inset
 495
 496  can also be added to it.
 497 \layout Description
 498
 499 --journal_size\SpecialChar ~
 500 <size> Optional arguement to specify the journal size for
 501  the ext2/ext3 file system.
 502  The size should be in the units expected by
 503 \series bold
 504 mkfs
 505 \series default
 506 , so for ext3 it should be in MB.
 507  If this is option is not used, the ext2/ext3 filesystem will be configured
 508  with the default journal size.
 509 \end_deeper
 510 \layout Description
 511
 512 --add\SpecialChar ~
 513 mtpt Creates a mount-point on the specified node.
 514  Either an LOV or OSC name can be used.
 515 \begin_deeper
 516 \layout Description
 517
 518 --node\SpecialChar ~
 519 node Node or profile node that will use the
 520 \emph on
 521 mtpt
 522 \emph default
 523 .
 524 \layout Description
 525
 526 --path\SpecialChar ~
 527 /mnt/path Specify the mountpoint for Lustre.
 528 \layout Description
 529
 530 --mds\SpecialChar ~
 531 mds_name Specify the mds name, which will provide service for this
 532  client.
 533 \layout Description
 534
 535 --ost\SpecialChar ~
 536 ost_name\SpecialChar ~
 537 |\SpecialChar ~
 538 --lov\SpecialChar ~
 539 lov_name Specify the ost or lov, which will provide service
 540  for this client.
 541 \end_deeper
 542 \layout Description
 543
 544 --add\SpecialChar ~
 545 route Creates a static route through a gateway to a specific
 546 \emph on
 547 nid
 548 \emph default
 549  or a range of
 550 \emph on
 551 nid
 552 \emph default
 553 's.
 554 \begin_deeper
 555 \layout Description
 556
 557 --node\SpecialChar ~
 558 node Node to add the route to.
 559 \layout Description
 560
 561 --router Optional flag to mark a node as router.
 562 \layout Description
 563
 564 --gw\SpecialChar ~
 565 nid The
 566 \emph on
 567 nid
 568 \emph default
 569  of the gateway (must be a local interface or a peer).
 570 \layout Description
 571
 572 --gateway_cluster_id\SpecialChar ~
 573 id Specify the id of the cluster, to which the gateway
 574  belongs.
 575 \layout Description
 576
 577 --target_cluster_id\SpecialChar ~
 578 id Specify the id of the cluster, to which the target
 579  of the route belongs.
 580 \layout Description
 581
 582 --lo\SpecialChar ~
 583 nid For a range route, this is the lo value
 584 \emph on
 585 nid.
 586 \layout Description
 587
 588 --hi\SpecialChar ~
 589 nid For a range route, this is the hi value
 590 \emph on
 591 nid.
 592 \end_deeper
 593 \layout Description
 594
 595 --add\SpecialChar ~
 596 echo-client Used for testing purpose only.
 597
 598 \begin_deeper
 599 \layout Description
 600
 601 --node\SpecialChar ~
 602 nodename
 603 \emph on
 604
 605 \emph default
 606 Node on which the echo-client resides.
 607 \end_deeper
 608 \layout List
 609 \labelwidthstring 00.00.0000
 610
 611
 612 \series bold
 613 --add\SpecialChar ~
 614 cobd
 615 \series default
 616 Create the cobd on the specified node.
 617 \begin_deeper
 618 \layout Description
 619 \noindent \align left
 620 --node\SpecialChar ~
 621 nodename
 622 \emph on
 623
 624 \emph default
 625 Node on which the cobd resides.
 626 \layout Description
 627
 628 --cache_obd\SpecialChar ~
 629 obd_name Specify the cache device for the cache obd system.
 630 \layout Description
 631
 632 --real_obd\SpecialChar ~
 633 obd_name
 634 \emph on
 635
 636 \emph default
 637 Specify the real device for the cache obd system.
 638 \end_deeper
 639 \layout List
 640 \labelwidthstring 00.00.0000
 641
 642
 643 \series bold
 644 Options
 645 \layout Description
 646
 647 --reference Print short reference for commands.
 648 \layout Description
 649
 650 --verbose Print system commands as they are run.
 651 \layout Description
 652
 653 --batch\SpecialChar ~
 654 filename Used to execute lmc commands in batch mode.
 655 \layout Description
 656
 657 --output\SpecialChar ~
 658 filename Send output to the file.
 659  If the file exists, it will be overwritten.
 660 \layout Description
 661
 662 --merge\SpecialChar ~
 663 filename
 664 \emph on
 665
 666 \emph default
 667 Add the new element to an existing file.
 668
 669 \layout Subsection
 670
 671 EXAMPLES
 672 \layout Standard
 673
 674 Real life examples are given in the Lustre-conf manual page.
 675 \layout Subsection
 676
 677 BUGS
 678 \layout Standard
 679
 680 None are known.
 681 \the_end