lustre/doc/lmc.lyx

   1 #LyX 1.3 created this file. For more info see http://www.lyx.org/\r
   2 \lyxformat 221\r
   3 \textclass amsart\r
   4 \language english\r
   5 \inputencoding auto\r
   6 \fontscheme times\r
   7 \graphics default\r
   8 \paperfontsize default\r
   9 \spacing single \r
  10 \papersize letterpaper\r
  11 \paperpackage a4\r
  12 \use_geometry 0\r
  13 \use_amsmath 0\r
  14 \use_natbib 0\r
  15 \use_numerical_citations 0\r
  16 \paperorientation portrait\r
  17 \secnumdepth 3\r
  18 \tocdepth 3\r
  19 \paragraph_separation skip\r
  20 \defskip medskip\r
  21 \quotes_language english\r
  22 \quotes_times 2\r
  23 \papercolumns 1\r
  24 \papersides 1\r
  25 \paperpagestyle default\r
  26 \r
  27 \layout Section\r
  28 \r
  29 lmc\r
  30 \layout Subsection\r
  31 \r
  32 NAME\r
  33 \layout Description\r
  34 \r
  35 lmc Lustre configuration maker.\r
  36 \layout Subsection\r
  37 \r
  38 SYNOPSIS\r
  39 \layout Standard\r
  40 \r
  41 \r
  42 \series bold \r
  43 lmc [options] --add <objectype> [args] \r
  44 \layout Standard\r
  45 \r
  46 \r
  47 \series bold \r
  48 lmc [options] --remove <objecttype> [args] -- [NOT IMPLEMENTED]\r
  49 \layout Standard\r
  50 \r
  51 \r
  52 \series bold \r
  53 lmc [options] --convert [args] -- [NOT IMPLEMENTED]\r
  54 \layout Subsection\r
  55 \r
  56 DESCRIPTION\r
  57 \layout Standard\r
  58 \r
  59 At present \r
  60 \series bold \r
  61 \emph on \r
  62 lmc\r
  63 \series default \r
  64 \emph default \r
  65 , when invoked, adds configuration data to the config file.\r
  66  In future, \r
  67 \series bold \r
  68 \emph on \r
  69 lmc\r
  70 \series default \r
  71 \emph default \r
  72  will also be able to remove configuration data or convert its format.\r
  73  A Lustre cluster consists of several components - MDS's, mount-points,\r
  74  OSTs, LOVs and whatever those reference (e.g nets and profiles).\r
  75  A single configuration file would be generated for the complete cluster.\r
  76  In the \r
  77 \series bold \r
  78 \emph on \r
  79 lmc\r
  80 \series default \r
  81 \emph default \r
  82  command line interface, each of these components is associated with an\r
  83  \r
  84 \emph on \r
  85 objecttype\r
  86 \emph default \r
  87 .\r
  88  \r
  89 \layout Standard\r
  90 \r
  91 The \r
  92 \emph on \r
  93 objecttype\r
  94 \emph default \r
  95  refers to a collection of related configuration entities and can be one\r
  96  of \r
  97 \series bold \r
  98 net\r
  99 \series default \r
 100 ,\r
 101 \series bold \r
 102  MDS\r
 103 \series default \r
 104 ,\r
 105 \series bold \r
 106  LOV\r
 107 \series default \r
 108 ,\r
 109 \series bold \r
 110  OST\r
 111 \series default \r
 112 ,\r
 113 \series bold \r
 114  mtpt\r
 115 \series default \r
 116 ,\r
 117 \series bold \r
 118  route\r
 119 \series default \r
 120 ,\r
 121 \series bold \r
 122  echo_client, or cobd.\r
 123  \r
 124 \series default \r
 125 We describe the arguments required for the addition of each \r
 126 \emph on \r
 127 objecttype\r
 128 \emph default \r
 129 .\r
 130  \r
 131 \layout Standard\r
 132 \r
 133 To generate configuration data associated with systems in a Lustre cluster:\r
 134 \layout Description\r
 135 \r
 136 \r
 137 \emph on \r
 138 -\r
 139 \emph default \r
 140 -add\SpecialChar ~\r
 141 node Adds a new node in the cluster configuration.\r
 142  \r
 143 \begin_deeper \r
 144 \layout Standard\r
 145 \r
 146 The arguments required are:\r
 147 \layout Description\r
 148 \r
 149 --node\SpecialChar ~\r
 150 ''node_name'' This will create a new node with the given name if not\r
 151  already present.\r
 152 \layout Description\r
 153 \r
 154 --timeout\SpecialChar ~\r
 155 <num> Timeout before going into recovery\r
 156 \layout Description\r
 157 \r
 158 --lustre_upcall\SpecialChar ~\r
 159 <path> Set the location of the Lustre upcall scripts used\r
 160  by the client for recovery\r
 161 \layout Description\r
 162 \r
 163 --portals_upcall\SpecialChar ~\r
 164 <path> Specify the location of the Portals upcall scripts\r
 165  used by the client for recovery\r
 166 \layout Description\r
 167 \r
 168 --upcall\SpecialChar ~\r
 169 <path> Specify the location of both (Lustre and Portals) upcall\r
 170  scripts used by the client for recovery\r
 171 \layout Description\r
 172 \r
 173 --ptldebug\SpecialChar ~\r
 174 <debug_level> Set the portals debug level.\r
 175 \layout Description\r
 176 \r
 177 --subsytem\SpecialChar ~\r
 178 <subsystem_name> Specify which Lustre subsystems have debug output\r
 179  recorded in the log.\r
 180 \end_deeper \r
 181 \layout Description\r
 182 \r
 183 \r
 184 \emph on \r
 185 -\r
 186 \emph default \r
 187 -add\SpecialChar ~\r
 188 net Adds a network device descriptor for the given node, with parameters\r
 189  as indicated.\r
 190 \begin_deeper \r
 191 \layout Standard\r
 192 \r
 193 The arguments required are:\r
 194 \layout Description\r
 195 \r
 196 --node\SpecialChar ~\r
 197 ''node_name'' This will create a new node with the given name if not\r
 198  already present.\r
 199  This is also used to specify a specific node for other elements.\r
 200 \layout Description\r
 201 \r
 202 --nettype\SpecialChar ~\r
 203 <type> Specify the network type.This can be \r
 204 \series bold \r
 205 tcp, elan, gm.\r
 206 \layout Description\r
 207 \r
 208 --nid\SpecialChar ~\r
 209 nid The network \r
 210 \emph on \r
 211 id\r
 212 \emph default \r
 213 , e.g.\r
 214  ElanID or IP address as used by Portals.\r
 215  If \r
 216 \emph on \r
 217 nid\r
 218 \emph default \r
 219  is '*', then the local address of the interface with specified \r
 220 \series bold \r
 221 nettype \r
 222 \series default \r
 223 is will be substituted when the node is configured with lconf.\r
 224  An \r
 225 \emph on \r
 226 nid\r
 227 \emph default \r
 228  of \r
 229 \emph on \r
 230 '*'\r
 231 \emph default \r
 232  should be used only for the generic \r
 233 \emph on \r
 234 client\r
 235 \emph default \r
 236  configuration.\r
 237 \layout Description\r
 238 \r
 239 --cluster_id\SpecialChar ~\r
 240 id Specify the cluster ID.\r
 241 \layout Description\r
 242 \r
 243 --hostaddr\SpecialChar ~\r
 244 addr Specify the host address.\r
 245  lconf will transfer it to the real host address.\r
 246 \layout Description\r
 247 \r
 248 --router Optional flag to mark this node as a router\r
 249 \layout Description\r
 250 \r
 251 --port\SpecialChar ~\r
 252 [port] Optional arguement to indicate the tcp port.\r
 253  The default is 988.\r
 254  \r
 255 \layout Description\r
 256 \r
 257 --tcpbuf\SpecialChar ~\r
 258 <size> Optional arguement.\r
 259  The default TCP buffer size is 1MB.\r
 260 \layout Description\r
 261 \r
 262 --irq_affinity\SpecialChar ~\r
 263 0|1 Optional arguement.\r
 264  Default is 0.\r
 265 \layout Description\r
 266 \r
 267 --nid_exchange\SpecialChar ~\r
 268 0|1 Optional arguement since some OSTs might not have the\r
 269  required support.\r
 270  This is turned off by default, value of 1 will turn it ON.\r
 271  \r
 272 \end_deeper \r
 273 \layout Description\r
 274 \r
 275 --add\SpecialChar ~\r
 276 mds\r
 277 \begin_deeper \r
 278 \layout Description\r
 279 \r
 280 --node\SpecialChar ~\r
 281 <node\SpecialChar ~\r
 282 name> Name of the node on which the MDS resides\r
 283 \layout Description\r
 284 \r
 285 --mds\SpecialChar ~\r
 286 <mds_name> Specify MDS name.\r
 287 \layout Description\r
 288 \r
 289 --mdsuuid\SpecialChar ~\r
 290 <uuid> Specify MDS uuid.\r
 291 \layout Description\r
 292 \r
 293 --failover Enable failover support on MDS.\r
 294 \layout Description\r
 295 \r
 296 --dev\SpecialChar ~\r
 297 <pathname> Path of device on local system.\r
 298  If the is a file, then a loop device is created and used as the block device.\r
 299 \layout Description\r
 300 \r
 301 --backdev\SpecialChar ~\r
 302 <pathname> Path of the device for backing storage on local system.\r
 303 \layout Description\r
 304 \r
 305 --size\SpecialChar ~\r
 306 <size> Optional argument indicating the size (in KB) of the device\r
 307  to be created (used typically for loop devices).\r
 308 \layout Description\r
 309 \r
 310 --node\SpecialChar ~\r
 311 <nodename> Adds an MDS to the specified node.\r
 312  This requires a \r
 313 \emph on \r
 314 --node\r
 315 \emph default \r
 316  argument, and it must not be a profile node.\r
 317 \layout Description\r
 318 \r
 319 --fstype\SpecialChar ~\r
 320 extN|ext3 Optional argument used to specify the file system type.\r
 321  Default is ext3.\r
 322 \layout Description\r
 323 \r
 324 --backfstype\SpecialChar ~\r
 325 ext3|tmpfs Optional argument to specify the backing filesystem\r
 326  type.\r
 327 \layout Description\r
 328 \r
 329 --nspath Local mount point of server namespace.\r
 330 \layout Description\r
 331 \r
 332 --inode_size\SpecialChar ~\r
 333 <size> Specify new inode size for underlying ext3 file system.\r
 334 \layout Description\r
 335 \r
 336 --mkfsoptions\SpecialChar ~\r
 337 <options> Optional argument to mkfs.\r
 338 \layout Description\r
 339 \r
 340 --mountfsoptions\SpecialChar ~\r
 341 <options> Optional argument to mount fs.\r
 342  Mount options will be passed by this argument.\r
 343  For example, extents are to be enabled by adding ",extents" to the --mountfsopt\r
 344 ions option.\r
 345  \r
 346 \begin_inset Quotes eld\r
 347 \end_inset \r
 348 \r
 349 errors=remount-ro\r
 350 \begin_inset Quotes erd\r
 351 \end_inset \r
 352 \r
 353  and \r
 354 \begin_inset Quotes eld\r
 355 \end_inset \r
 356 \r
 357 asyncdel\r
 358 \begin_inset Quotes erd\r
 359 \end_inset \r
 360 \r
 361  can also be added to it.\r
 362 \layout Description\r
 363 \r
 364 --journal_size\SpecialChar ~\r
 365 <size> Optional arguement to specify the journal size for\r
 366  the ext2/ext3 file system.\r
 367  The size should be in the units expected by \r
 368 \series bold \r
 369 mkfs\r
 370 \series default \r
 371 , so for ext3 it should be in MB.\r
 372  If this is option is not used, the ext2/ext3 filesystem will be configured\r
 373  with the default journal size.\r
 374 \end_deeper \r
 375 \layout Description\r
 376 \r
 377 --add\SpecialChar ~\r
 378 lov Creates an LOV with the specified parameters.\r
 379  The \r
 380 \emph on \r
 381 mds_name\r
 382 \emph default \r
 383  must already exist in the descriptor.\r
 384 \begin_deeper \r
 385 \layout Description\r
 386 \r
 387 --lov\SpecialChar ~\r
 388 <name> Specify LOV name.\r
 389 \layout Description\r
 390 \r
 391 --mds\SpecialChar ~\r
 392 <name> Specify the mds name.\r
 393 \layout Description\r
 394 \r
 395 --stripe_sz\SpecialChar ~\r
 396 <size> Specify the stripe size in bytes.\r
 397 \layout Description\r
 398 \r
 399 --stripe_cnt\SpecialChar ~\r
 400 <count> A value of 0 for this means to stripe on all available\r
 401  OSTs.\r
 402  Default is 0.\r
 403 \layout Description\r
 404 \r
 405 --stripe_pattern\SpecialChar ~\r
 406 <pattern> Only Pattern 0 (RAID 0) is supported currently.\r
 407 \end_deeper \r
 408 \layout Description\r
 409 \r
 410 --add\SpecialChar ~\r
 411 ost Creates an OBD, OST, and OSC.\r
 412  The OST and OBD are created on the specified node.\r
 413 \begin_deeper \r
 414 \layout Description\r
 415 \r
 416 --ost\SpecialChar ~\r
 417 <name> Assign a name to the OST device.\r
 418 \layout Description\r
 419 \r
 420 --node\SpecialChar ~\r
 421 <nodename> Node on which the OST service is run, can not be a profile\r
 422  node.\r
 423 \layout Description\r
 424 \r
 425 --failover Enable failover support on OST.\r
 426 \layout Description\r
 427 \r
 428 --dev\SpecialChar ~\r
 429 <pathname> Path of device on local system.\r
 430  If this is a file, then a loop device is created and used as the block\r
 431  device.\r
 432 \layout Description\r
 433 \r
 434 --backdev\SpecialChar ~\r
 435 <pathname> Path of the device for backing storage on local system.\r
 436 \layout Description\r
 437 \r
 438 --size\SpecialChar ~\r
 439 [size] Optional argument indicating the size (in KB) of the device\r
 440  to be created (used typically for loop devices).\r
 441 \layout Description\r
 442 \r
 443 --osdtype\SpecialChar ~\r
 444 obdfilter|obdecho Specify the type of OSD.\r
 445 \layout Description\r
 446 \r
 447 --lov\SpecialChar ~\r
 448 <name> Optional arguement.\r
 449  Name of LOV to which this OSC will be attached.\r
 450  \r
 451 \layout Description\r
 452 \r
 453 --ostuuid\SpecialChar ~\r
 454 UUID Specify the UUID of the OST device.\r
 455  \r
 456 \layout Description\r
 457 \r
 458 --fstype\SpecialChar ~\r
 459 extN|ext3 Optional arguement used to specify the file system type.\r
 460  Default is ext3.\r
 461 \layout Description\r
 462 \r
 463 --backfstype\SpecialChar ~\r
 464 ext3|tmpfs Optional argument to specify the backing filesystem\r
 465  type.\r
 466 \layout Description\r
 467 \r
 468 --inode_size\SpecialChar ~\r
 469 <size> Specify new inode size for underlying ext3 file system.\r
 470 \layout Description\r
 471 \r
 472 --nspath Local mount point of server namespace.\r
 473 \layout Description\r
 474 \r
 475 --mkfsoptions\SpecialChar ~\r
 476 <options> Optional argument to mkfs.\r
 477 \layout Description\r
 478 \r
 479 --mountfsoptions\SpecialChar ~\r
 480 <options> Optional argument to mount fs.\r
 481  Mount options will be passed by this argument.\r
 482  For example, extents are to be enabled by adding ",extents" to the --mountfsopt\r
 483 ions option.\r
 484  \r
 485 \begin_inset Quotes eld\r
 486 \end_inset \r
 487 \r
 488 errors=remount-ro\r
 489 \begin_inset Quotes erd\r
 490 \end_inset \r
 491 \r
 492  and \r
 493 \begin_inset Quotes eld\r
 494 \end_inset \r
 495 \r
 496 asyncdel\r
 497 \begin_inset Quotes erd\r
 498 \end_inset \r
 499 \r
 500  can also be added to it.\r
 501 \layout Description\r
 502 \r
 503 --journal_size\SpecialChar ~\r
 504 <size> Optional arguement to specify the journal size for\r
 505  the ext2/ext3 file system.\r
 506  The size should be in the units expected by \r
 507 \series bold \r
 508 mkfs\r
 509 \series default \r
 510 , so for ext3 it should be in MB.\r
 511  If this is option is not used, the ext2/ext3 filesystem will be configured\r
 512  with the default journal size.\r
 513 \end_deeper \r
 514 \layout Description\r
 515 \r
 516 --add\SpecialChar ~\r
 517 mtpt Creates a mount-point on the specified node.\r
 518  Either an LOV or OSC name can be used.\r
 519 \begin_deeper \r
 520 \layout Description\r
 521 \r
 522 --node\SpecialChar ~\r
 523 node Node or profile node that will use the \r
 524 \emph on \r
 525 mtpt\r
 526 \emph default \r
 527 .\r
 528 \layout Description\r
 529 \r
 530 --path\SpecialChar ~\r
 531 /mnt/path Specify the mountpoint for Lustre.\r
 532 \layout Description\r
 533 \r
 534 --mds\SpecialChar ~\r
 535 mds_name Specify the mds name, which will provide service for this\r
 536  client.\r
 537 \layout Description\r
 538 \r
 539 --ost\SpecialChar ~\r
 540 ost_name\SpecialChar ~\r
 541 |\SpecialChar ~\r
 542 --lov\SpecialChar ~\r
 543 lov_name Specify the ost or lov, which will provide service\r
 544  for this client.\r
 545 \layout Description\r
 546 \r
 547 --clientoptions Specify the options for Lustre, such as async.\r
 548 \end_deeper \r
 549 \layout Description\r
 550 \r
 551 --add\SpecialChar ~\r
 552 route Creates a static route through a gateway to a specific \r
 553 \emph on \r
 554 nid\r
 555 \emph default \r
 556  or a range of \r
 557 \emph on \r
 558 nid\r
 559 \emph default \r
 560 's.\r
 561 \begin_deeper \r
 562 \layout Description\r
 563 \r
 564 --node\SpecialChar ~\r
 565 node Node to add the route to.\r
 566 \layout Description\r
 567 \r
 568 --router Optional flag to mark a node as router.\r
 569 \layout Description\r
 570 \r
 571 --gw\SpecialChar ~\r
 572 nid The \r
 573 \emph on \r
 574 nid\r
 575 \emph default \r
 576  of the gateway (must be a local interface or a peer).\r
 577 \layout Description\r
 578 \r
 579 --gateway_cluster_id\SpecialChar ~\r
 580 id Specify the id of the cluster, to which the gateway\r
 581  belongs.\r
 582 \layout Description\r
 583 \r
 584 --target_cluster_id\SpecialChar ~\r
 585 id Specify the id of the cluster, to which the target\r
 586  of the route belongs.\r
 587 \layout Description\r
 588 \r
 589 --lo\SpecialChar ~\r
 590 nid For a range route, this is the lo value \r
 591 \emph on \r
 592 nid.\r
 593 \layout Description\r
 594 \r
 595 --hi\SpecialChar ~\r
 596 nid For a range route, this is the hi value \r
 597 \emph on \r
 598 nid.\r
 599 \end_deeper \r
 600 \layout Description\r
 601 \r
 602 --add\SpecialChar ~\r
 603 echo-client Used for testing purpose only.\r
 604  \r
 605 \begin_deeper \r
 606 \layout Description\r
 607 \r
 608 --node\SpecialChar ~\r
 609 nodename\r
 610 \emph on \r
 611  \r
 612 \emph default \r
 613 Node on which the echo-client resides.\r
 614 \end_deeper \r
 615 \layout Description\r
 616 \r
 617 --add\SpecialChar ~\r
 618 mgmt Management/monitoring service.\r
 619 \begin_deeper \r
 620 \layout Description\r
 621 \r
 622 --node\SpecialChar ~\r
 623 nodename\r
 624 \emph on \r
 625  \r
 626 \emph default \r
 627 Node on which the mgmt service resides.\r
 628 \layout Description\r
 629 \r
 630 --mgmt\SpecialChar ~\r
 631 <mgmt_service_name> Specify management/monitoring service name.\r
 632 \end_deeper \r
 633 \layout List\r
 634 \labelwidthstring 00.00.0000\r
 635 \r
 636 \r
 637 \series bold \r
 638 --add\SpecialChar ~\r
 639 cobd \r
 640 \series default \r
 641 Create the cobd on the specified node.\r
 642 \begin_deeper \r
 643 \layout Description\r
 644 \noindent \align left \r
 645 --node\SpecialChar ~\r
 646 nodename\r
 647 \emph on \r
 648  \r
 649 \emph default \r
 650 Node on which the cobd resides.\r
 651 \layout Description\r
 652 \r
 653 --cache_obd\SpecialChar ~\r
 654 obd_name Specify the cache device for the cache obd system.\r
 655 \layout Description\r
 656 \r
 657 --real_obd\SpecialChar ~\r
 658 obd_name\r
 659 \emph on \r
 660  \r
 661 \emph default \r
 662 Specify the real device for the cache obd system.\r
 663 \end_deeper \r
 664 \layout List\r
 665 \labelwidthstring 00.00.0000\r
 666 \r
 667 \r
 668 \series bold \r
 669 Options\r
 670 \layout Description\r
 671 \r
 672 --reference Print short reference for commands.\r
 673 \layout Description\r
 674 \r
 675 --verbose Print system commands as they are run.\r
 676 \layout Description\r
 677 \r
 678 --batch\SpecialChar ~\r
 679 filename Used to execute lmc commands in batch mode.\r
 680 \layout Description\r
 681 \r
 682 --output\SpecialChar ~\r
 683 filename Send output to the file.\r
 684  If the file exists, it will be overwritten.\r
 685 \layout Description\r
 686 \r
 687 --merge\SpecialChar ~\r
 688 filename\r
 689 \emph on \r
 690  \r
 691 \emph default \r
 692 Add the new element to an existing file.\r
 693  \r
 694 \layout Subsection\r
 695 \r
 696 EXAMPLES\r
 697 \layout Subsubsection\r
 698 \r
 699 --add net\r
 700 \layout Standard\r
 701 \r
 702 \r
 703 \series bold \r
 704 lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp\r
 705  --hostaddr adev3-eth0 --port 988\r
 706 \layout Standard\r
 707 \r
 708 \r
 709 \series bold \r
 710 lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp\r
 711  --hostaddr adev3-eth1 --port 989\r
 712 \series default \r
 713 \emph on \r
 714  \r
 715 \layout Standard\r
 716 \r
 717 Used to add a Lustre node to a specified Lustre cluster through a network\r
 718  interface.\r
 719  In this example, Lustre node adev3 has been added to 2 Lustre clusters\r
 720  whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface\r
 721  cards: adev3-eth0 and adev3-eth1.\r
 722  adev3 would listen in some specified port(s) to prepare for possible connection\r
 723  requests from nodes in these two clusters.\r
 724 \layout Subsubsection\r
 725 \r
 726 --add route\r
 727 \layout Standard\r
 728 \r
 729 \r
 730 \series bold \r
 731 lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000\r
 732  --target_cluster_id 0x1000 --lo 4 --hi 7\r
 733 \layout Standard\r
 734 \r
 735 Used to add a route entry for a Lustre node.\r
 736  Here Lustre node adev3 is told it has a new route entry that now it could\r
 737  send packets to Lustre nodes whose nids is from 4 to 7 with the help of\r
 738  Lustre gateway node whose nid is 5.\r
 739  Besides, Lustre gateway node is in cluster whose id is 0x1000 and target\r
 740  of the route belongs to cluster whose id is also 0x1000.\r
 741  The network in this route path is a tcp network.\r
 742 \layout Subsection\r
 743 \r
 744 BUGS\r
 745 \layout Standard\r
 746 \r
 747 None are known.\r
 748 \the_end\r