lustre/doc/lmc.lyx

   1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 220
   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 \emph on
  44 lmc [options] --add <objectype> [args]
  45 \layout Standard
  46
  47
  48 \series bold
  49 NOT IMPLEMENTED
  50 \emph on
  51 -- lmc [options] --remove <objecttype> [args]
  52 \layout Standard
  53
  54
  55 \series bold
  56 NOT IMPLEMENTED
  57 \emph on
  58 -- lmc [options] --convert [args]
  59 \layout Subsection
  60
  61 DESCRIPTION
  62 \layout Standard
  63
  64 At present lmc, when invoked, adds configuration data to the config file.
  65  lmc will also be able to remove configuration data or convert its format.
  66  One generates a single config file for the cluster at present including,
  67  at the minimum, MDS's, mtpt's, and OST's and whatever those reference (e.g.
  68  nets and profiles).
  69 \layout Standard
  70
  71 The
  72 \emph on
  73 objecttype
  74 \emph default
  75  refers to a collection of related configuration entities and can be one
  76  of
  77 \series bold
  78 net, MDS, LOV, OST, mtpt, route, or oscref.
  79
  80 \series default
  81 We describe the arguments required for the addition of each
  82 \emph on
  83 objecttype
  84 \emph default
  85 .
  86  [NOT IMPLEMENTED] lmc can also remove items from or convert the format
  87  of configuration data.
  88 \layout Standard
  89
  90 To generate configuration data associated with systems in a Lustre cluster:
  91 \layout List
  92 \labelwidthstring 00.00.0000
  93
  94
  95 \series bold
  96 \emph on
  97 --add\SpecialChar ~
  98 net
  99 \series default
 100 \emph default
 101  Adds a network device descriptor for the given node, with parameters as
 102  indicated.
 103 \begin_deeper
 104 \layout Standard
 105
 106 The arguments required are:
 107 \layout List
 108 \labelwidthstring 00.00.0000
 109
 110
 111 \series bold
 112 \emph on
 113 --node\SpecialChar ~
 114 ''node_name''
 115 \series default
 116 \emph default
 117  This will create a new node with the given name if not already present.
 118  This is also used to specify a specific node for other elements.
 119 \layout List
 120 \labelwidthstring 00.00.0000
 121
 122
 123 \series bold
 124 \emph on
 125 --nettype\SpecialChar ~
 126 <type>
 127 \series default
 128 \emph default
 129  This can be
 130 \series bold
 131 tcp, elan, gm.
 132 \layout List
 133 \labelwidthstring 00.00.0000
 134
 135
 136 \series bold
 137 \emph on
 138 --nid\SpecialChar ~
 139 nid
 140 \series default
 141 \emph default
 142  The network
 143 \emph on
 144 id
 145 \emph default
 146 , e.g.
 147  ElanID or IP address as used by Portals.
 148  If
 149 \emph on
 150 host_name
 151 \emph default
 152  is '*', then the local address while be substituted when the node is configured
 153  with lconf.
 154 \layout List
 155 \labelwidthstring 00.00.0000
 156
 157
 158 \series bold
 159 \emph on
 160 --router
 161 \series default
 162 \emph default
 163  Optional flag to mark this node as a router
 164 \layout List
 165 \labelwidthstring 00.00.0000
 166
 167
 168 \series bold
 169 \emph on
 170 --profile
 171 \series default
 172 \emph default
 173  Optional flag to mark this node as a profile node.
 174  This is automatically true if the the
 175 \emph on
 176 --nid
 177 \emph default
 178  argument contains a '*'.
 179 \layout List
 180 \labelwidthstring 00.00.0000
 181
 182
 183 \series bold
 184 \emph on
 185 --port\SpecialChar ~
 186 [port]
 187 \series default
 188 \emph default
 189  Optional argument to indicate the tcp port.
 190  The default is 988.
 191
 192 \layout List
 193 \labelwidthstring 00.00.0000
 194
 195
 196 \series bold
 197 \emph on
 198 --tcpbuf\SpecialChar ~
 199 <size>
 200 \series default
 201 \emph default
 202  Optional argument.
 203 \end_deeper
 204 \layout List
 205 \labelwidthstring 00.00.0000
 206
 207
 208 \series bold
 209 \emph on
 210 --add\SpecialChar ~
 211 mds
 212 \begin_deeper
 213 \layout List
 214 \labelwidthstring 00.00.0000
 215
 216
 217 \series bold
 218 \emph on
 219 --mds\SpecialChar ~
 220 <mds_name>
 221 \series default
 222 \emph default
 223
 224 \layout List
 225 \labelwidthstring 00.00.0000
 226
 227
 228 \series bold
 229 \emph on
 230 --dev\SpecialChar ~
 231 <pathname>
 232 \series default
 233 \emph default
 234  Path of device on local system.
 235  If the is a file, then a loop device is created and used as the block device.
 236 \layout List
 237 \labelwidthstring 00.00.0000
 238
 239
 240 \series bold
 241 \emph on
 242 --size\SpecialChar ~
 243 <size>
 244 \series default
 245 \emph default
 246  Optional argument indicating the size of the device to be created (used
 247  typically for loop devices).
 248 \layout List
 249 \labelwidthstring 00.00.0000
 250
 251
 252 \series bold
 253 \emph on
 254 --node\SpecialChar ~
 255 <nodename>
 256 \series default
 257 \emph default
 258  Adds an MDS to the specified node.
 259  This requires a
 260 \emph on
 261 --node
 262 \emph default
 263  argument, and it must not be a profile node.
 264 \end_deeper
 265 \layout List
 266 \labelwidthstring 00.00.0000
 267
 268
 269 \series bold
 270 \emph on
 271 --add\SpecialChar ~
 272 lov
 273 \series default
 274 \emph default
 275  Creates an LOV with the specified parameters.
 276  The
 277 \emph on
 278 mds_name
 279 \emph default
 280  must already exist in the descriptor.
 281 \begin_deeper
 282 \layout List
 283 \labelwidthstring 00.00.0000
 284
 285
 286 \series bold
 287 \emph on
 288 --lov_<name>
 289 \layout List
 290 \labelwidthstring 00.00.0000
 291
 292
 293 \series bold
 294 \emph on
 295 --mds_<name>
 296 \layout List
 297 \labelwidthstring 00.00.0000
 298
 299
 300 \series bold
 301 \emph on
 302 --stripe_sz\SpecialChar ~
 303 <size>
 304 \layout List
 305 \labelwidthstring 00.00.0000
 306
 307
 308 \series bold
 309 \emph on
 310 --stripe_cnt\SpecialChar ~
 311 <count>
 312 \layout List
 313 \labelwidthstring 00.00.0000
 314
 315
 316 \series bold
 317 \emph on
 318 --stripe_pattern\SpecialChar ~
 319 <pattern>
 320 \series default
 321 \emph default
 322  Pattern can be 0.
 323 \end_deeper
 324 \layout List
 325 \labelwidthstring 00.00.0000
 326
 327
 328 \series bold
 329 \emph on
 330 --add\SpecialChar ~
 331 ost
 332 \series default
 333 \emph default
 334  Creates an OBD, OST, and OSC.
 335  The OST and OBD are created on the specified node.
 336 \begin_deeper
 337 \layout List
 338 \labelwidthstring 00.00.0000
 339
 340
 341 \series bold
 342 \emph on
 343 --obd\SpecialChar ~
 344 <name>
 345 \series default
 346 \emph default
 347  Assign a name to the OBD device.
 348 \layout List
 349 \labelwidthstring 00.00.0000
 350
 351
 352 \series bold
 353 \emph on
 354 --node\SpecialChar ~
 355 <nodename>
 356 \series default
 357 \emph default
 358  Node on which the OST service is run, can not be a profile node.
 359 \layout List
 360 \labelwidthstring 00.00.0000
 361
 362
 363 \series bold
 364 \emph on
 365 --dev\SpecialChar ~
 366 <pathname>
 367 \series default
 368 \emph default
 369  Path of device on local system.
 370  If this is a file, then a loop device is created and used as the block
 371  device.
 372 \layout List
 373 \labelwidthstring 00.00.0000
 374
 375
 376 \series bold
 377 \emph on
 378 --size\SpecialChar ~
 379 [size]
 380 \layout List
 381 \labelwidthstring 00.00.0000
 382
 383
 384 \series bold
 385 \emph on
 386 --lov\SpecialChar ~
 387 <name>
 388 \series default
 389 \emph default
 390  Name of LOV to which this OSC will be attached.
 391
 392 \layout List
 393 \labelwidthstring 00.00.0000
 394
 395
 396 \series bold
 397 --obduuid\SpecialChar ~
 398 UUID
 399 \series default
 400  Specify the UUID of the OBD device.
 401  The default value is
 402 \emph on
 403 OBD_nodename_UUID
 404 \emph default
 405 .
 406 \end_deeper
 407 \layout List
 408 \labelwidthstring 00.00.0000
 409
 410
 411 \series bold
 412 \emph on
 413 --add\SpecialChar ~
 414 mtpt
 415 \series default
 416 \emph default
 417  Creates a mount-point on the specified node.
 418  Either an LOV or OSC name can be used.
 419 \begin_deeper
 420 \layout List
 421 \labelwidthstring 00.00.0000
 422
 423
 424 \series bold
 425 \emph on
 426 --node\SpecialChar ~
 427 node
 428 \series default
 429 \emph default
 430  Node or profile node that will use the
 431 \emph on
 432 mtpt
 433 \emph default
 434 .
 435 \layout List
 436 \labelwidthstring 00.00.0000
 437
 438
 439 \series bold
 440 \emph on
 441 --path\SpecialChar ~
 442 /mnt/path\SpecialChar ~
 443
 444 \layout List
 445 \labelwidthstring 00.00.0000
 446
 447
 448 \series bold
 449 \emph on
 450 --mds\SpecialChar ~
 451 mds_name
 452 \layout List
 453 \labelwidthstring 00.00.0000
 454
 455
 456 \series bold
 457 \emph on
 458 --obd\SpecialChar ~
 459 lov_name|osc_name
 460 \end_deeper
 461 \layout List
 462 \labelwidthstring 00.00.0000
 463
 464
 465 \series bold
 466 \emph on
 467 --add\SpecialChar ~
 468 route
 469 \series default
 470 \emph default
 471  Creates a static route through a gateway to a specific
 472 \emph on
 473 nid
 474 \emph default
 475  or a range of
 476 \emph on
 477 nid
 478 \emph default
 479 's.
 480 \begin_deeper
 481 \layout List
 482 \labelwidthstring 00.00.0000
 483
 484
 485 \series bold
 486 \emph on
 487 --node\SpecialChar ~
 488 node
 489 \series default
 490 \emph default
 491  Node or profile node to add the route to.
 492 \layout List
 493 \labelwidthstring 00.00.0000
 494
 495
 496 \series bold
 497 \emph on
 498 --gw\SpecialChar ~
 499 nid
 500 \series default
 501 \emph default
 502  The
 503 \emph on
 504 nid
 505 \emph default
 506  of the gateway (must be a local interface or a peer).
 507 \layout List
 508 \labelwidthstring 00.00.0000
 509
 510
 511 \series bold
 512 \emph on
 513 --tgt\SpecialChar ~
 514 nid
 515 \series default
 516 \emph default
 517  For a specific route, this is the target
 518 \emph on
 519 nid.
 520 \layout List
 521 \labelwidthstring 00.00.0000
 522
 523
 524 \series bold
 525 \emph on
 526 --lo\SpecialChar ~
 527 nid
 528 \series default
 529 \emph default
 530  For a range route, this is the lo value
 531 \emph on
 532 nid.
 533 \layout List
 534 \labelwidthstring 00.00.0000
 535
 536
 537 \series bold
 538 \emph on
 539 --hi\SpecialChar ~
 540 nid
 541 \series default
 542 \emph default
 543  For a range route, this is the hi value
 544 \emph on
 545 nid.
 546 \end_deeper
 547 \layout List
 548 \labelwidthstring 00.00.0000
 549
 550
 551 \series bold
 552 \emph on
 553 --add\SpecialChar ~
 554 oscref
 555 \series default
 556 \emph default
 557  Adds an OSC reference to a node.
 558  This is only necessary when the the OSC will be used without a mount-point.
 559 \begin_deeper
 560 \layout List
 561 \labelwidthstring 00.00.0000
 562
 563
 564 \series bold
 565 \emph on
 566 --node\SpecialChar ~
 567 node
 568 \series default
 569 \emph default
 570 Node or profile node to add the
 571 \emph on
 572 oscref
 573 \emph default
 574  to.
 575 \layout List
 576 \labelwidthstring 00.00.0000
 577
 578
 579 \series bold
 580 \emph on
 581 --osc\SpecialChar ~
 582 osc_name
 583 \series default
 584 \emph default
 585  Name of the OSC to add a reference to.
 586  The
 587 \emph on
 588 --add
 589 \emph default
 590  OST command automatically creates the OSC, and the name will be
 591 \emph on
 592 OSC_<node>
 593 \emph default
 594 , where node is the name of node the OST is on.
 595 \end_deeper
 596 \layout List
 597 \labelwidthstring 00.00.0000
 598
 599
 600 \series bold
 601 Options
 602 \begin_deeper
 603 \layout List
 604 \labelwidthstring 00.00.0000
 605
 606
 607 \series bold
 608 \emph on
 609 --output\SpecialChar ~
 610 filename
 611 \series default
 612 \emph default
 613  Send output to the file.
 614  If the file exists, it will be overwritten.
 615 \layout List
 616 \labelwidthstring 00.00.0000
 617
 618
 619 \series bold
 620 \emph on
 621 --merge\SpecialChar ~
 622 filename
 623 \series default
 624 \emph default
 625 Add the new element to an existing file.
 626
 627 \end_deeper
 628 \layout Subsection
 629
 630 EXAMPLES
 631 \layout Standard
 632
 633 Real life examples are given in the Lustre-conf manual page.
 634 \layout Subsection
 635
 636 BUGS
 637 \layout Standard
 638
 639 None are known.
 640 \the_end