lustre/doc/lconf.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 lconf
  30 \layout Subsection
  31
  32 NAME
  33 \layout Description
  34
  35 lconf Lustre filesystem configuration utility.
  36 \layout Subsection
  37
  38 SYNOPSIS
  39 \layout Standard
  40
  41
  42 \series bold
  43 lconf\SpecialChar ~
  44 [--node <node_name>] [-d,--cleanup] [--noexec] [--gdb] [--nosetup]
  45  [--nomod] [-n,--noexec] [-v,--verbose] [-h,--help] <XML-config file>
  46 \layout Subsection
  47
  48 DESCRIPTION
  49 \layout Standard
  50
  51 This program configures a node following directives in the <XML-config-file>.
  52  There will be single configuration file for all the nodes in a single cluster.
  53  This file should be distributed to all the nodes in the cluster or kept
  54  in a location accessible to all the nodes.
  55  One option is to store the cluster configuration information in LDAP format
  56  on an LDAP server that can be reached from all the cluster nodes.
  57 \layout Description
  58
  59 --client_uuid\SpecialChar ~
  60 <uuid> The failed client (required for recovery).
  61 \layout Description
  62
  63 --clientoptions\SpecialChar ~
  64 <options> Additional options for Lustre.
  65 \layout Description
  66
  67 --config\SpecialChar ~
  68 <arg> Cluster configuration name used for LDAP query
  69 \layout Description
  70
  71 --conn_uuid\SpecialChar ~
  72 <uuid> The failed connection (required for recovery).
  73 \layout Description
  74
  75 --d|--cleanup Unconfigure a node.
  76  The same config and
  77 \emph on
  78 --node
  79 \emph default
  80  argument used for configuration needs to be used for cleanup as well.
  81  This will attempt to undo all of the configuration steps done by lconf,
  82  including unloading the kernel modules.
  83 \layout Description
  84
  85 --debug_path\SpecialChar ~
  86 <path> Path to save debug dumps.
  87 \layout Description
  88
  89 --dump\SpecialChar ~
  90 <file> Dump the kernel debug log to the specified file before portals
  91  is unloaded during cleanup.
  92 \layout Description
  93
  94 --dump_path\SpecialChar ~
  95 <arg> Path to save debug dumps.
  96  Default is /tmp/lustre_log
  97 \layout Description
  98
  99 --failover Used to shutdown without saving state.
 100  Default is 0.
 101  This will allow the node to give up service to another node for failover
 102  purposes.
 103  This will not be a clean shutdown.
 104 \layout Description
 105
 106 --force Forced unmounting and/or obd detach during cleanup.
 107  Default is 0.
 108
 109 \layout Description
 110
 111 --gdb Causes lconf to print a message and pause for 5 seconds after creating
 112  a gdb module script and before doing any Lustre configuration (the gdb
 113  module script is always created, however).
 114 \layout Description
 115
 116 --gdb_script\SpecialChar ~
 117 <arg> Full name of gdb debug script.
 118  Default is /tmp/ogdb.
 119 \layout Description
 120
 121 --group\SpecialChar ~
 122 <arg> The group of devices to cleanup/configure.
 123 \layout Description
 124
 125 -h,--help Print help.
 126 \layout Description
 127
 128 --inactive\SpecialChar ~
 129 <UUID> The UUID of the service to be ignored by a client mounting
 130  Lustre.
 131  Allows the client to mount in the presence of some inactive services.
 132  (currently OST only).
 133  Multiple UUIDs can be specified by repeating the option.
 134
 135 \layout Description
 136
 137 --lctl-dump\SpecialChar ~
 138 <arg> Dump all ioctls to the specified file
 139 \layout Description
 140
 141 --ldapurl\SpecialChar ~
 142 <arg> LDAP server URL
 143 \layout Description
 144
 145 --lustre_upcall\SpecialChar ~
 146 <path> Set the location of the Lustre upcall scripts used
 147  by the client for recovery
 148 \layout Description
 149
 150 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
 151  will cause lconf to load the lustre modules from this soure tree.
 152 \layout Description
 153
 154 --mds_ost_conn Open connections to OSTs on MDS.
 155 \layout Description
 156
 157 --maxlevel\SpecialChar ~
 158 <level> Perform configuration of devices and services up to level
 159  given.
 160
 161 \emph on
 162 level
 163 \emph default
 164  can take the values
 165 \series bold
 166 net, dev, svc, fs.
 167
 168 \series default
 169 When used in conjunction with cleanup, services are torn down up to a certain
 170  level.
 171  Default is 100.
 172 \layout Description
 173
 174 --minlevel\SpecialChar ~
 175 <level> Specify the minimum level of services to configure/cleanup.
 176  Default is 0.
 177 \layout Description
 178
 179 --mkfsoptions\SpecialChar ~
 180 <options> Specify additional options for the mk*fs command
 181  line.
 182 \layout Description
 183
 184 --mountfsoptions\SpecialChar ~
 185 <options> Specify additional options for mount fs command
 186  line.
 187  Mount options will be passed by this argument.
 188  For example, extents are to be enabled by adding
 189 \begin_inset Quotes eld
 190 \end_inset
 191
 192 ,extents
 193 \begin_inset Quotes erd
 194 \end_inset
 195
 196  to the --mountfsoptions option.
 197
 198 \begin_inset Quotes eld
 199 \end_inset
 200
 201 errors=remount-ro
 202 \begin_inset Quotes erd
 203 \end_inset
 204
 205  and
 206 \begin_inset Quotes eld
 207 \end_inset
 208
 209 asyncdel
 210 \begin_inset Quotes erd
 211 \end_inset
 212
 213  can also be added to it.
 214 \layout Description
 215
 216 --node\SpecialChar ~
 217 node_name Specify a specific node to configure.
 218  By default, lconf will search for nodes with the local hostname and 'localhost'.
 219  When
 220 \emph on
 221  --node
 222 \emph default
 223  is used, only
 224 \emph on
 225 node_name
 226 \emph default
 227  is searched for.
 228  If a matching node is not found in the config, then lconf exits with an
 229  error.
 230 \layout Description
 231
 232 --noexec,-n Print, but don't execute, the steps lconf will perform.
 233  This is useful for debugging a configuration, and when used with
 234 \emph on
 235 --node
 236 \emph default
 237 , can be run on any host.
 238 \layout Description
 239
 240 --nomod Only setup devices and services, do not load modules.
 241 \layout Description
 242
 243 --nosetup Only load modules, do not configure devices or services.
 244 \layout Description
 245
 246 --portals\SpecialChar ~
 247 <path> Specify portals source directory.
 248  If this is a relative path, then it is assumed to be relative to lustre.
 249 \layout Description
 250
 251 --portals_upcall\SpecialChar ~
 252 <path> Specify the location of the Portals upcall scripts
 253  used by the client for recovery
 254 \layout Description
 255
 256 --ptldebug\SpecialChar ~
 257 debug\SpecialChar ~
 258 level This options can be used to set the required debug
 259  level.
 260 \layout Description
 261
 262 --record Write config information on mds.
 263 \layout Description
 264
 265 --record_log\SpecialChar ~
 266 <arg> Specify the name of config record log.
 267 \layout Description
 268
 269 --record_device\SpecialChar ~
 270 <arg> Specify MDS device name that will record the config
 271  commands.
 272 \layout Description
 273
 274 --recover\SpecialChar ~
 275 <arg> Recover a device.
 276 \layout Description
 277
 278 --reformat Reformat all the devices.
 279  This is essential on the first time the file system is brought up.
 280 \layout Description
 281
 282 --select\SpecialChar ~
 283 <arg> Select a particular node for a service
 284 \layout Description
 285
 286 --single_socket Specify socknal option: only use one socket instead of bundle.
 287 \layout Description
 288
 289 --subsystem\SpecialChar ~
 290 <arg> Set the portals debug subsystem.
 291 \layout Description
 292
 293 --tgt_uuid\SpecialChar ~
 294 <uuid> Specify the failed target (required for recovery).
 295 \layout Description
 296
 297 --timeout\SpecialChar ~
 298 <arg> Set the recovery timeout period.
 299 \layout Description
 300
 301 --upcall\SpecialChar ~
 302 <path> Set the location of both Lustre and Portals upcall scripts
 303  used by the client for recovery
 304 \layout Description
 305
 306 --verbose,-v Be verbose and show actions while going along.
 307 \layout Description
 308
 309 --write_conf Save all client configuration information on the MDS
 310 \layout Subsection
 311
 312 EXAMPLES
 313 \layout Standard
 314
 315 On client nodes this is typically invoked as:
 316 \layout LyX-Code
 317
 318
 319 \size small
 320 lconf --node client config.xml
 321 \layout Standard
 322
 323 in order to give clients, regardless of hostname, a single configuration.
 324 \layout Standard
 325
 326 Required debug levels can be set like this:
 327 \layout LyX-Code
 328
 329
 330 \size small
 331    ## Everything but these
 332 \layout LyX-Code
 333
 334
 335 \size small
 336 lconf --ptldebug
 337 \begin_inset Quotes eld
 338 \end_inset
 339
 340 ~(portals | malloc | trace)
 341 \begin_inset Quotes erd
 342 \end_inset
 343
 344
 345 \layout LyX-Code
 346
 347 \layout LyX-Code
 348
 349
 350 \size small
 351 ## Only these debug types
 352 \layout LyX-Code
 353
 354
 355 \size small
 356 lconf --ptldebug
 357 \begin_inset Quotes eld
 358 \end_inset
 359
 360 ldlm|ha
 361 \begin_inset Quotes erd
 362 \end_inset
 363
 364
 365 \layout Standard
 366
 367 A subset of failed OSTs can be ignored during Lustre mount on the clients
 368  by using the following option:
 369 \layout LyX-Code
 370
 371    lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
 372 \layout Standard
 373
 374 where OST1 and OST2 have failed and need to be ignored.
 375 \layout Subsection
 376
 377 BUGS
 378 \layout Standard
 379
 380 None are known.
 381 \the_end