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 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
 123 \series default
 124 or
 125 \series bold
 126  echo_client.
 127
 128 \series default
 129 We describe the arguments required for the addition of each
 130 \emph on
 131 objecttype
 132 \emph default
 133 .
 134
 135 \layout Standard
 136
 137 To generate configuration data associated with systems in a Lustre cluster:
 138 \layout Description
 139
 140
 141 \emph on
 142 -
 143 \emph default
 144 -add\SpecialChar ~
 145 node Adds a new node in the cluster configuration.
 146
 147 \begin_deeper
 148 \layout Standard
 149
 150 The arguments required are:
 151 \layout Description
 152
 153 --node\SpecialChar ~
 154 ''node_name'' This will create a new node with the given name if not
 155  already present.
 156 \layout Description
 157
 158 --timeout\SpecialChar ~
 159 <num> Timeout before going into recovery
 160 \layout Description
 161
 162 --lustre_upcall\SpecialChar ~
 163 <path> Set the location of the Lustre upcall scripts used
 164  by the client for recovery
 165 \layout Description
 166
 167 --portals_upcall\SpecialChar ~
 168 <path> Specify the location of the Portals upcall scripts
 169  used by the client for recovery
 170 \layout Description
 171
 172 --upcall\SpecialChar ~
 173 <path> Specify the location of both (Lustre and Portals) upcall
 174  scripts used by the client for recovery
 175 \end_deeper
 176 \layout Description
 177
 178
 179 \emph on
 180 -
 181 \emph default
 182 -add\SpecialChar ~
 183 net Adds a network device descriptor for the given node, with parameters
 184  as indicated.
 185 \begin_deeper
 186 \layout Standard
 187
 188 The arguments required are:
 189 \layout Description
 190
 191 --node\SpecialChar ~
 192 ''node_name'' This will create a new node with the given name if not
 193  already present.
 194  This is also used to specify a specific node for other elements.
 195 \layout Description
 196
 197 --nettype\SpecialChar ~
 198 <type> This can be
 199 \series bold
 200 tcp, elan, gm, scimac.
 201 \layout Description
 202
 203 --nid\SpecialChar ~
 204 nid The network
 205 \emph on
 206 id
 207 \emph default
 208 , e.g.
 209  ElanID or IP address as used by Portals.
 210  If
 211 \emph on
 212 nid
 213 \emph default
 214  is '*', then the local address of the interface with specified
 215 \series bold
 216 nettype
 217 \series default
 218 is will be substituted when the node is configured with lconf.
 219  An
 220 \emph on
 221 nid
 222 \emph default
 223  of
 224 \emph on
 225 '*'
 226 \emph default
 227  should be used only for the generic
 228 \emph on
 229 client
 230 \emph default
 231  configuration.
 232 \layout Description
 233
 234 --hostaddr addr
 235 \layout Description
 236
 237 --router Optional flag to mark this node as a router
 238 \layout Description
 239
 240 --profile\SpecialChar ~
 241 [not\SpecialChar ~
 242 implemented] Optional flag to mark this node as a profile node.
 243  This would be very useful to configure several client nodes in large clusters.
 244  It will allow user to define
 245 \series bold
 246 profiles
 247 \series default
 248  for the various client configurations, and then load the correct profile
 249  on the client nodes using lconf.
 250
 251 \layout Description
 252
 253 --port\SpecialChar ~
 254 [port] Optional arguement to indicate the tcp port.
 255  The default is 988.
 256
 257 \layout Description
 258
 259 --tcpbuf\SpecialChar ~
 260 <size> Optional arguement.
 261  The default TCP buffer size is 1MB.
 262 \layout Description
 263
 264 --irq_affinity\SpecialChar ~
 265 0|1 Optional arguement.
 266  Default is 0.
 267 \layout Description
 268
 269 --nid_exchange\SpecialChar ~
 270 0|1 Optional arguement since some OSTs might not have the
 271  required support.
 272  This is turned off by default, value of 1 will turn it ON.
 273
 274 \end_deeper
 275 \layout Description
 276
 277 --add\SpecialChar ~
 278 mds
 279 \begin_deeper
 280 \layout Description
 281
 282 --node\SpecialChar ~
 283 <node\SpecialChar ~
 284 name> Name of the node on which the MDS resides
 285 \layout Description
 286
 287 --mds\SpecialChar ~
 288 <mds_name>
 289 \layout Description
 290
 291 --dev\SpecialChar ~
 292 <pathname> Path of device on local system.
 293  If the is a file, then a loop device is created and used as the block device.
 294 \layout Description
 295
 296 --size\SpecialChar ~
 297 <size> Optional arguement indicating the size of the device to be
 298  created (used typically for loop devices).
 299 \layout Description
 300
 301 --node\SpecialChar ~
 302 <nodename> Adds an MDS to the specified node.
 303  This requires a
 304 \emph on
 305 --node
 306 \emph default
 307  argument, and it must not be a profile node.
 308 \layout Description
 309
 310 --fstype\SpecialChar ~
 311 extN|ext3 Optional arguement used to specify the file system type.
 312  Default is ext3.
 313 \layout Description
 314
 315 --journal_size\SpecialChar ~
 316 <size> Optional arguement to specify the journal size for
 317  the ext2/ext3 file system.
 318  The size should be in the units expected by
 319 \series bold
 320 mkfs
 321 \series default
 322 , so for ext3 it should be in MB.
 323  If this is option is not used, the ext2/ext3 filesystem will be configured
 324  with the default journal size.
 325 \end_deeper
 326 \layout Description
 327
 328 --add\SpecialChar ~
 329 lov Creates an LOV with the specified parameters.
 330  The
 331 \emph on
 332 mds_name
 333 \emph default
 334  must already exist in the descriptor.
 335 \begin_deeper
 336 \layout Description
 337
 338 --lov\SpecialChar ~
 339 <name>
 340 \layout Description
 341
 342 --mds\SpecialChar ~
 343 <name>
 344 \layout Description
 345
 346 --stripe_sz\SpecialChar ~
 347 <size>
 348 \layout Description
 349
 350 --stripe_cnt\SpecialChar ~
 351 <count> A value of 0 for this means to stripe on all available
 352  OSTs.
 353  Default is 0.
 354 \layout Description
 355
 356 --stripe_pattern\SpecialChar ~
 357 <pattern> Only Pattern 0 (RAID 0) is supported currently.
 358 \end_deeper
 359 \layout Description
 360
 361 --add\SpecialChar ~
 362 ost Creates an OBD, OST, and OSC.
 363  The OST and OBD are created on the specified node.
 364 \begin_deeper
 365 \layout Description
 366
 367 --ost\SpecialChar ~
 368 <name> Assign a name to the OST device.
 369 \layout Description
 370
 371 --node\SpecialChar ~
 372 <nodename> Node on which the OST service is run, can not be a profile
 373  node.
 374 \layout Description
 375
 376 --dev\SpecialChar ~
 377 <pathname> Path of device on local system.
 378  If this is a file, then a loop device is created and used as the block
 379  device.
 380 \layout Description
 381
 382 --size\SpecialChar ~
 383 [size]
 384 \layout Description
 385
 386 --osdtype\SpecialChar ~
 387 obdfilter|obdecho
 388 \layout Description
 389
 390 --lov\SpecialChar ~
 391 <name> Optional arguement.
 392  Name of LOV to which this OSC will be attached.
 393
 394 \layout Description
 395
 396 --ostuuid\SpecialChar ~
 397 UUID Specify the UUID of the OST device.
 398
 399 \layout Description
 400
 401 --fstype\SpecialChar ~
 402 extN|ext3 Optional arguement used to specify the file system type.
 403  Default is ext3.
 404 \layout Description
 405
 406 --journal_size\SpecialChar ~
 407 <size> Optional arguement to specify the journal size for
 408  the ext2/ext3 file system.
 409  The size should be in the units expected by
 410 \series bold
 411 mkfs
 412 \series default
 413 , so for ext3 it should be in MB.
 414  If this is option is not used, the ext2/ext3 filesystem will be configured
 415  with the default journal size.
 416 \end_deeper
 417 \layout Description
 418
 419 --add\SpecialChar ~
 420 mtpt Creates a mount-point on the specified node.
 421  Either an LOV or OSC name can be used.
 422 \begin_deeper
 423 \layout Description
 424
 425 --node\SpecialChar ~
 426 node Node or profile node that will use the
 427 \emph on
 428 mtpt
 429 \emph default
 430 .
 431 \layout Description
 432
 433 --path\SpecialChar ~
 434 /mnt/path\SpecialChar ~
 435
 436 \layout Description
 437
 438 --mds\SpecialChar ~
 439 mds_name
 440 \layout Description
 441
 442 --ost\SpecialChar ~
 443 ost_name\SpecialChar ~
 444 |\SpecialChar ~
 445 --lov\SpecialChar ~
 446 lov_name
 447 \end_deeper
 448 \layout Description
 449
 450 --add\SpecialChar ~
 451 route Creates a static route through a gateway to a specific
 452 \emph on
 453 nid
 454 \emph default
 455  or a range of
 456 \emph on
 457 nid
 458 \emph default
 459 's.
 460 \begin_deeper
 461 \layout Description
 462
 463 --node\SpecialChar ~
 464 node Node or profile node to add the route to.
 465 \layout Description
 466
 467 --gw\SpecialChar ~
 468 nid The
 469 \emph on
 470 nid
 471 \emph default
 472  of the gateway (must be a local interface or a peer).
 473 \layout Description
 474
 475 --tgt\SpecialChar ~
 476 nid For a specific route, this is the target
 477 \emph on
 478 nid.
 479 \layout Description
 480
 481 --lo\SpecialChar ~
 482 nid For a range route, this is the lo value
 483 \emph on
 484 nid.
 485 \layout Description
 486
 487 --hi\SpecialChar ~
 488 nid For a range route, this is the hi value
 489 \emph on
 490 nid.
 491 \end_deeper
 492 \layout Description
 493
 494 --add\SpecialChar ~
 495 echo-client Used for testing purpose only.
 496
 497 \begin_deeper
 498 \layout Description
 499
 500 --node\SpecialChar ~
 501 node
 502 \emph on
 503
 504 \layout Description
 505
 506 --obd\SpecialChar ~
 507 obd_name
 508 \end_deeper
 509 \layout List
 510 \labelwidthstring 00.00.0000
 511
 512
 513 \series bold
 514 Options
 515 \layout Description
 516
 517 --output\SpecialChar ~
 518 filename Send output to the file.
 519  If the file exists, it will be overwritten.
 520 \layout Description
 521
 522 --merge\SpecialChar ~
 523 filename
 524 \emph on
 525
 526 \emph default
 527 Add the new element to an existing file.
 528
 529 \layout Subsection
 530
 531 EXAMPLES
 532 \layout Standard
 533
 534 Real life examples are given in the Lustre-conf manual page.
 535 \layout Subsection
 536
 537 BUGS
 538 \layout Standard
 539
 540 None are known.
 541 \the_end