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 --group_upcall\SpecialChar ~
 126 <arg> Pathname to the MDS upcall to resolve secondary group membership.
 127  Defaults to NONE, meaning that the MDS will use whatever group the client
 128  supplies, but this is limited to a single supplementary group.
 129 \layout Description
 130
 131 -h,--help Print help.
 132 \layout Description
 133
 134 --inactive\SpecialChar ~
 135 <UUID> The UUID of the service to be ignored by a client mounting
 136  Lustre.
 137  Allows the client to mount in the presence of some inactive services.
 138  (currently OST only).
 139  Multiple UUIDs can be specified by repeating the option.
 140
 141 \layout Description
 142
 143 --lctl-dump\SpecialChar ~
 144 <arg> Dump all ioctls to the specified file
 145 \layout Description
 146
 147 --ldapurl\SpecialChar ~
 148 <arg> LDAP server URL
 149 \layout Description
 150
 151 --lustre_upcall\SpecialChar ~
 152 <path> Set the location of the Lustre upcall scripts used
 153  by the client for recovery
 154 \layout Description
 155
 156 --lustre=src_dir Specify the base directory for Lustre sources, this parameter
 157  will cause lconf to load the lustre modules from this soure tree.
 158 \layout Description
 159
 160 --mds_ost_conn Open connections to OSTs on MDS.
 161 \layout Description
 162
 163 --maxlevel\SpecialChar ~
 164 <level> Perform configuration of devices and services up to level
 165  given.
 166
 167 \emph on
 168 level
 169 \emph default
 170  can take the values
 171 \series bold
 172 net, dev, svc, fs.
 173
 174 \series default
 175 When used in conjunction with cleanup, services are torn down up to a certain
 176  level.
 177  Default is 100.
 178 \layout Description
 179
 180 --minlevel\SpecialChar ~
 181 <level> Specify the minimum level of services to configure/cleanup.
 182  Default is 0.
 183 \layout Description
 184
 185 --mkfsoptions\SpecialChar ~
 186 <options> Specify additional options for the mk*fs command
 187  line.
 188 \layout Description
 189
 190 --mountfsoptions\SpecialChar ~
 191 <options> Specify additional options for mount fs command
 192  line.
 193  Mount options will be passed by this argument.
 194  For example, extents are to be enabled by adding
 195 \begin_inset Quotes eld
 196 \end_inset
 197
 198 ,extents
 199 \begin_inset Quotes erd
 200 \end_inset
 201
 202  to the --mountfsoptions option.
 203
 204 \begin_inset Quotes eld
 205 \end_inset
 206
 207 errors=remount-ro
 208 \begin_inset Quotes erd
 209 \end_inset
 210
 211  and
 212 \begin_inset Quotes eld
 213 \end_inset
 214
 215 asyncdel
 216 \begin_inset Quotes erd
 217 \end_inset
 218
 219  can also be added to it.
 220 \layout Description
 221
 222 --node\SpecialChar ~
 223 node_name Specify a specific node to configure.
 224  By default, lconf will search for nodes with the local hostname and 'localhost'.
 225  When
 226 \emph on
 227  --node
 228 \emph default
 229  is used, only
 230 \emph on
 231 node_name
 232 \emph default
 233  is searched for.
 234  If a matching node is not found in the config, then lconf exits with an
 235  error.
 236 \layout Description
 237
 238 --noexec,-n Print, but don't execute, the steps lconf will perform.
 239  This is useful for debugging a configuration, and when used with
 240 \emph on
 241 --node
 242 \emph default
 243 , can be run on any host.
 244 \layout Description
 245
 246 --nomod Only setup devices and services, do not load modules.
 247 \layout Description
 248
 249 --nosetup Only load modules, do not configure devices or services.
 250 \layout Description
 251
 252 --portals\SpecialChar ~
 253 <path> Specify portals source directory.
 254  If this is a relative path, then it is assumed to be relative to lustre.
 255 \layout Description
 256
 257 --portals_upcall\SpecialChar ~
 258 <path> Specify the location of the Portals upcall scripts
 259  used by the client for recovery
 260 \layout Description
 261
 262 --ptldebug\SpecialChar ~
 263 debug\SpecialChar ~
 264 level This options can be used to set the required debug
 265  level.
 266 \layout Description
 267
 268 --record Write config information on mds.
 269 \layout Description
 270
 271 --record_log\SpecialChar ~
 272 <arg> Specify the name of config record log.
 273 \layout Description
 274
 275 --record_device\SpecialChar ~
 276 <arg> Specify MDS device name that will record the config
 277  commands.
 278 \layout Description
 279
 280 --recover\SpecialChar ~
 281 <arg> Recover a device.
 282 \layout Description
 283
 284 --reformat Reformat all the devices.
 285  This is essential on the first time the file system is brought up.
 286 \layout Description
 287
 288 --select\SpecialChar ~
 289 <arg> Select a particular node for a service
 290 \layout Description
 291
 292 --single_socket Specify socknal option: only use one socket instead of bundle.
 293 \layout Description
 294
 295 --subsystem\SpecialChar ~
 296 <arg> Set the portals debug subsystem.
 297 \layout Description
 298
 299 --tgt_uuid\SpecialChar ~
 300 <uuid> Specify the failed target (required for recovery).
 301 \layout Description
 302
 303 --timeout\SpecialChar ~
 304 <arg> Set the recovery timeout period.
 305 \layout Description
 306
 307 --upcall\SpecialChar ~
 308 <path> Set the location of both Lustre and Portals upcall scripts
 309  used by the client for recovery
 310 \layout Description
 311
 312 --verbose,-v Be verbose and show actions while going along.
 313 \layout Description
 314
 315 --write_conf Save all client configuration information on the MDS
 316 \layout Subsection
 317
 318 EXAMPLES
 319 \layout Standard
 320
 321 On client nodes this is typically invoked as:
 322 \layout LyX-Code
 323
 324
 325 \size small
 326 lconf --node client config.xml
 327 \layout Standard
 328
 329 in order to give clients, regardless of hostname, a single configuration.
 330 \layout Standard
 331
 332 Required debug levels can be set like this:
 333 \layout LyX-Code
 334
 335
 336 \size small
 337    ## Everything but these
 338 \layout LyX-Code
 339
 340
 341 \size small
 342 lconf --ptldebug
 343 \begin_inset Quotes eld
 344 \end_inset
 345
 346 ~(portals | malloc | trace)
 347 \begin_inset Quotes erd
 348 \end_inset
 349
 350
 351 \layout LyX-Code
 352
 353 \layout LyX-Code
 354
 355
 356 \size small
 357 ## Only these debug types
 358 \layout LyX-Code
 359
 360
 361 \size small
 362 lconf --ptldebug
 363 \begin_inset Quotes eld
 364 \end_inset
 365
 366 ldlm|ha
 367 \begin_inset Quotes erd
 368 \end_inset
 369
 370
 371 \layout Standard
 372
 373 A subset of failed OSTs can be ignored during Lustre mount on the clients
 374  by using the following option:
 375 \layout LyX-Code
 376
 377    lconf --inactive OST_ost1_UUID --inactive OST_ost2_UUID config.xml
 378 \layout Standard
 379
 380 where OST1 and OST2 have failed and need to be ignored.
 381 \layout Subsection
 382
 383 BUGS
 384 \layout Standard
 385
 386 None are known.
 387 \the_end