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, ibnal.
 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 --mdsuuid\SpecialChar ~
 290 <uuid> Specify MDS uuid.
 291 \layout Description
 292
 293 --failover Enable failover support on MDS.
 294 \layout Description
 295
 296 --dev\SpecialChar ~
 297 <pathname> Path of device on local system.
 298  If the is a file, then a loop device is created and used as the block device.
 299 \layout Description
 300
 301 --backdev\SpecialChar ~
 302 <pathname> Path of the device for backing storage on local system.
 303 \layout Description
 304
 305 --size\SpecialChar ~
 306 <size> Optional argument indicating the size (in KB) of the device
 307  to be created (used typically for loop devices).
 308 \layout Description
 309
 310 --node\SpecialChar ~
 311 <nodename> Adds an MDS to the specified node.
 312  This requires a
 313 \emph on
 314 --node
 315 \emph default
 316  argument, and it must not be a profile node.
 317 \layout Description
 318
 319 --fstype\SpecialChar ~
 320 extN|ext3 Optional argument used to specify the file system type.
 321  Default is ext3.
 322 \layout Description
 323
 324 --backfstype\SpecialChar ~
 325 ext3|tmpfs Optional argument to specify the backing filesystem
 326  type.
 327 \layout Description
 328
 329 --nspath Local mount point of server namespace.
 330 \layout Description
 331
 332 --inode_size\SpecialChar ~
 333 <size> Specify new inode size for underlying ext3 file system.
 334 \layout Description
 335
 336 --mkfsoptions\SpecialChar ~
 337 <options> Optional argument to mkfs.
 338 \layout Description
 339
 340 --mountfsoptions\SpecialChar ~
 341 <options> Optional argument to mount fs.
 342  Mount options will be passed by this argument.
 343  For example, extents are to be enabled by adding ",extents" to the --mountfsopt
 344 ions option.
 345
 346 \begin_inset Quotes eld
 347 \end_inset
 348
 349 errors=remount-ro
 350 \begin_inset Quotes erd
 351 \end_inset
 352
 353  and
 354 \begin_inset Quotes eld
 355 \end_inset
 356
 357 asyncdel
 358 \begin_inset Quotes erd
 359 \end_inset
 360
 361  can also be added to it.
 362 \layout Description
 363
 364 --journal_size\SpecialChar ~
 365 <size> Optional arguement to specify the journal size for
 366  the ext2/ext3 file system.
 367  The size should be in the units expected by
 368 \series bold
 369 mkfs
 370 \series default
 371 , so for ext3 it should be in MB.
 372  If this is option is not used, the ext2/ext3 filesystem will be configured
 373  with the default journal size.
 374 \end_deeper
 375 \layout Description
 376
 377 --add\SpecialChar ~
 378 lov Creates an LOV with the specified parameters.
 379  The
 380 \emph on
 381 mds_name
 382 \emph default
 383  must already exist in the descriptor.
 384 \begin_deeper
 385 \layout Description
 386
 387 --lov\SpecialChar ~
 388 <name> Specify LOV name.
 389 \layout Description
 390
 391 --mds\SpecialChar ~
 392 <name> Specify the mds name.
 393 \layout Description
 394
 395 --stripe_sz\SpecialChar ~
 396 <size> Specify the stripe size in bytes.
 397 \layout Description
 398
 399 --stripe_cnt\SpecialChar ~
 400 <count> A value of 0 for this means to stripe on all available
 401  OSTs.
 402  Default is 0.
 403 \layout Description
 404
 405 --stripe_pattern\SpecialChar ~
 406 <pattern> Only Pattern 0 (RAID 0) is supported currently.
 407 \end_deeper
 408 \layout Description
 409
 410 --add\SpecialChar ~
 411 ost Creates an OBD, OST, and OSC.
 412  The OST and OBD are created on the specified node.
 413 \begin_deeper
 414 \layout Description
 415
 416 --ost\SpecialChar ~
 417 <name> Assign a name to the OST device.
 418 \layout Description
 419
 420 --node\SpecialChar ~
 421 <nodename> Node on which the OST service is run, can not be a profile
 422  node.
 423 \layout Description
 424
 425 --failover Enable failover support on OST.
 426 \layout Description
 427
 428 --dev\SpecialChar ~
 429 <pathname> Path of device on local system.
 430  If this is a file, then a loop device is created and used as the block
 431  device.
 432 \layout Description
 433
 434 --backdev\SpecialChar ~
 435 <pathname> Path of the device for backing storage on local system.
 436 \layout Description
 437
 438 --size\SpecialChar ~
 439 [size] Optional argument indicating the size (in KB) of the device
 440  to be created (used typically for loop devices).
 441 \layout Description
 442
 443 --osdtype\SpecialChar ~
 444 obdfilter|obdecho Specify the type of OSD.
 445 \layout Description
 446
 447 --lov\SpecialChar ~
 448 <name> Optional arguement.
 449  Name of LOV to which this OSC will be attached.
 450
 451 \layout Description
 452
 453 --ostuuid\SpecialChar ~
 454 UUID Specify the UUID of the OST device.
 455
 456 \layout Description
 457
 458 --fstype\SpecialChar ~
 459 extN|ext3 Optional arguement used to specify the file system type.
 460  Default is ext3.
 461 \layout Description
 462
 463 --backfstype\SpecialChar ~
 464 ext3|tmpfs Optional argument to specify the backing filesystem
 465  type.
 466 \layout Description
 467
 468 --inode_size\SpecialChar ~
 469 <size> Specify new inode size for underlying ext3 file system.
 470 \layout Description
 471
 472 --nspath Local mount point of server namespace.
 473 \layout Description
 474
 475 --mkfsoptions\SpecialChar ~
 476 <options> Optional argument to mkfs.
 477 \layout Description
 478
 479 --mountfsoptions\SpecialChar ~
 480 <options> Optional argument to mount fs.
 481  Mount options will be passed by this argument.
 482  For example, extents are to be enabled by adding ",extents" to the --mountfsopt
 483 ions option.
 484
 485 \begin_inset Quotes eld
 486 \end_inset
 487
 488 errors=remount-ro
 489 \begin_inset Quotes erd
 490 \end_inset
 491
 492  and
 493 \begin_inset Quotes eld
 494 \end_inset
 495
 496 asyncdel
 497 \begin_inset Quotes erd
 498 \end_inset
 499
 500  can also be added to it.
 501 \layout Description
 502
 503 --journal_size\SpecialChar ~
 504 <size> Optional arguement to specify the journal size for
 505  the ext2/ext3 file system.
 506  The size should be in the units expected by
 507 \series bold
 508 mkfs
 509 \series default
 510 , so for ext3 it should be in MB.
 511  If this is option is not used, the ext2/ext3 filesystem will be configured
 512  with the default journal size.
 513 \end_deeper
 514 \layout Description
 515
 516 --add\SpecialChar ~
 517 mtpt Creates a mount-point on the specified node.
 518  Either an LOV or OSC name can be used.
 519 \begin_deeper
 520 \layout Description
 521
 522 --node\SpecialChar ~
 523 node Node or profile node that will use the
 524 \emph on
 525 mtpt
 526 \emph default
 527 .
 528 \layout Description
 529
 530 --path\SpecialChar ~
 531 /mnt/path Specify the mountpoint for Lustre.
 532 \layout Description
 533
 534 --mds\SpecialChar ~
 535 mds_name Specify the mds name, which will provide service for this
 536  client.
 537 \layout Description
 538
 539 --ost\SpecialChar ~
 540 ost_name\SpecialChar ~
 541 |\SpecialChar ~
 542 --lov\SpecialChar ~
 543 lov_name Specify the ost or lov, which will provide service
 544  for this client.
 545 \layout Description
 546
 547 --clientoptions Specify the options for Lustre, such as async.
 548 \end_deeper
 549 \layout Description
 550
 551 --add\SpecialChar ~
 552 route Creates a static route through a gateway to a specific
 553 \emph on
 554 nid
 555 \emph default
 556  or a range of
 557 \emph on
 558 nid
 559 \emph default
 560 's.
 561 \begin_deeper
 562 \layout Description
 563
 564 --node\SpecialChar ~
 565 node Node to add the route to.
 566 \layout Description
 567
 568 --router Optional flag to mark a node as router.
 569 \layout Description
 570
 571 --gw\SpecialChar ~
 572 nid The
 573 \emph on
 574 nid
 575 \emph default
 576  of the gateway (must be a local interface or a peer).
 577 \layout Description
 578
 579 --gateway_cluster_id\SpecialChar ~
 580 id Specify the id of the cluster, to which the gateway
 581  belongs.
 582 \layout Description
 583
 584 --target_cluster_id\SpecialChar ~
 585 id Specify the id of the cluster, to which the target
 586  of the route belongs.
 587 \layout Description
 588
 589 --lo\SpecialChar ~
 590 nid For a range route, this is the lo value
 591 \emph on
 592 nid.
 593 \layout Description
 594
 595 --hi\SpecialChar ~
 596 nid For a range route, this is the hi value
 597 \emph on
 598 nid.
 599 \end_deeper
 600 \layout Description
 601
 602 --add\SpecialChar ~
 603 echo-client Used for testing purpose only.
 604
 605 \begin_deeper
 606 \layout Description
 607
 608 --node\SpecialChar ~
 609 nodename
 610 \emph on
 611
 612 \emph default
 613 Node on which the echo-client resides.
 614 \end_deeper
 615 \layout Description
 616
 617 --add\SpecialChar ~
 618 mgmt Management/monitoring service.
 619 \begin_deeper
 620 \layout Description
 621
 622 --node\SpecialChar ~
 623 nodename
 624 \emph on
 625
 626 \emph default
 627 Node on which the mgmt service resides.
 628 \layout Description
 629
 630 --mgmt\SpecialChar ~
 631 <mgmt_service_name> Specify management/monitoring service name.
 632 \end_deeper
 633 \layout List
 634 \labelwidthstring 00.00.0000
 635
 636
 637 \series bold
 638 --add\SpecialChar ~
 639 cobd
 640 \series default
 641 Create the cobd on the specified node.
 642 \begin_deeper
 643 \layout Description
 644 \noindent \align left
 645 --node\SpecialChar ~
 646 nodename
 647 \emph on
 648
 649 \emph default
 650 Node on which the cobd resides.
 651 \layout Description
 652
 653 --cache_obd\SpecialChar ~
 654 obd_name Specify the cache device for the cache obd system.
 655 \layout Description
 656
 657 --real_obd\SpecialChar ~
 658 obd_name
 659 \emph on
 660
 661 \emph default
 662 Specify the real device for the cache obd system.
 663 \end_deeper
 664 \layout List
 665 \labelwidthstring 00.00.0000
 666
 667
 668 \series bold
 669 Options
 670 \layout Description
 671
 672 --reference Print short reference for commands.
 673 \layout Description
 674
 675 --verbose Print system commands as they are run.
 676 \layout Description
 677
 678 --batch\SpecialChar ~
 679 filename Used to execute lmc commands in batch mode.
 680 \layout Description
 681
 682 --output\SpecialChar ~
 683 filename Send output to the file.
 684  If the file exists, it will be overwritten.
 685 \layout Description
 686
 687 --merge\SpecialChar ~
 688 filename
 689 \emph on
 690
 691 \emph default
 692 Add the new element to an existing file.
 693
 694 \layout Subsection
 695
 696 EXAMPLES
 697 \layout Standard
 698
 699 Real life examples are given in the Lustre-conf manual page.
 700 \layout Subsection
 701
 702 BUGS
 703 \layout Standard
 704
 705 None are known.
 706 \the_end