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