From 09a9c466f0908f28043e2816155deed05a2883f9 Mon Sep 17 00:00:00 2001 From: braam Date: Wed, 18 Sep 2002 05:44:26 +0000 Subject: [PATCH] - add manual pages with configuration help. - of particular importance is lustre-conf. - this is included as a new chapter in the book. --- lustre/doc/lconf.lyx | 272 +++++++------------------------------------------ lustre/doc/lctl.lyx | 17 ++-- lustre/doc/lmc.lyx | 279 +++++++++++---------------------------------------- 3 files changed, 105 insertions(+), 463 deletions(-) diff --git a/lustre/doc/lconf.lyx b/lustre/doc/lconf.lyx index f5c85bb..5e9b9a6 100644 --- a/lustre/doc/lconf.lyx +++ b/lustre/doc/lconf.lyx @@ -1,6 +1,6 @@ #LyX 1.2 created this file. For more info see http://www.lyx.org/ \lyxformat 220 -\textclass manpage +\textclass amsart \language english \inputencoding auto \fontscheme times @@ -26,272 +26,72 @@ \layout Section +lconf +\layout Subsection + NAME \layout Standard lctl - low level Lustre file system configuration utility -\layout Section +\layout Subsection SYNOPSIS \layout Standard \series bold -lctl -\layout Standard - - -\series bold -lctl\SpecialChar ~ ---device\SpecialChar ~ - -\layout Standard - - -\series bold -lctl\SpecialChar ~ ---threads\SpecialChar ~ -\SpecialChar ~ -\SpecialChar ~ -\SpecialChar ~ - -\layout Section +lconf\SpecialChar ~ +[--node ] [--cleanup] [--noexec] [--gdb] +\layout Subsection DESCRIPTION \layout Standard -The program can be invoked in interactive mode by issuing -\series bold -lctl. - -\series default - After than commands are issued as below. -\layout Standard - -For non-interactive single threaded use, one uses the second invocation - which runs -\emph on -command -\emph default - after connecting to the -\emph on -device. - -\emph default - -\layout Description - ---device The device number to be used for the operation. - The value of devno is an integer, normally found by calling -\emph on -lctl name2dev -\emph default -on a device name. - -\layout Description - ---threads How many threads should be forked doing the command specified. - The numthreads variable is a strictly positivie integer indicating how - many threads should be started. - Verbose can take values , -\emph on -devno -\emph default -is used as above. -\layout Section - -SUBCOMMANDS -\layout Description - -network\SpecialChar ~ -config -\begin_deeper -\layout Description - -network\SpecialChar ~ - Indicate what kind of network applies for the - configuration commands that follow. -\layout Description - -connect\SpecialChar ~ -[[\SpecialChar ~ -]\SpecialChar ~ -|\SpecialChar ~ -] -\layout Description - -disconnect -\layout Description - -mynid -\layout Description - -add_uuid -\layout Description - -close_uuid -\layout Description - -del_uuid -\layout Description - -add_route -\layout Description - -del_route -\layout Description - -route_list -\layout Description - -recv_mem -\layout Description - -send_mem -\layout Description - -nagle -\end_deeper -\layout Description - -device\SpecialChar ~ -selection -\begin_deeper -\layout Description - -newdev -\layout Description - -name2dev -\layout Description - -device -\layout Description - -device_list -\end_deeper -\layout Description - -device\SpecialChar ~ -config -\begin_deeper -\layout Description - -attach -\layout Description - -setup -\layout Description - -cleanup -\layout Description - -detach -\layout Description - -lovconfig -\end_deeper -\layout Description - -device\SpecialChar ~ -operations -\begin_deeper -\layout Description - -probe +This program configures a node following directives in the \layout Description -close +--node\SpecialChar ~ +node_name Specifiy a specific node to configure. + By default, LCONF will search for nodes with the local hostname and 'localhost'. + When --node is used, only node_name is searched for. + If a matching node is not found in the config, then LCONF exits with an + error. \layout Description -getattr +--cleanup Unconfigure a node. + The same config and --node argument used for configuration needs to be + used for cleanup as well. + This will attempt to undo all of the configuration steps done by LCONF, + including unloading the kernel modules. \layout Description -setattr +--noexec Print, but don't execute, the steps lconf will perform. + This is useful for debugging a configuration, and when used with --node, + can be run on any host. \layout Description -create -\layout Description +--gdb Causes LCONF to print a message and pause for 5 seconds after creating + a gdb module script and before doing any lustre configuration. + (The gdb module script is always created, however.) +\layout Subsection -destroy -\layout Description - -test_getattr -\layout Description - -test_brw -\layout Description - -test_ldlm -\layout Description - -ldlm_regress_start -\layout Description - -ldlm_regress_stop -\layout Description - -dump_ldlm -\layout Description - -newconn -\end_deeper -\layout Description - -debug -\begin_deeper -\layout Description - -debug_kernel -\layout Description - -debug_file -\layout Description - -clear -\layout Description - -mark -\layout Description - -filter -\layout Description - -show -\layout Description - -debug_list\SpecialChar ~ -modules -\layout Description - -panic -\end_deeper -\layout Description - -control -\begin_deeper -\layout Description - -help -\layout Description +EXAMPLES +\layout Standard -exit -\layout Description +On client nodes this is typically invoked as +\layout LyX-Code -quit -\end_deeper -\layout Section +lconf --node client config.xml +\layout Standard -EXAMPLES -\layout Section +in order to give clients, regardless of hostname a single configuration. +\layout Subsection BUGS \layout Standard None are known. -\layout Section +\layout Subsection AUTHOR \layout Standard diff --git a/lustre/doc/lctl.lyx b/lustre/doc/lctl.lyx index f5c85bb..4600144 100644 --- a/lustre/doc/lctl.lyx +++ b/lustre/doc/lctl.lyx @@ -1,6 +1,6 @@ #LyX 1.2 created this file. For more info see http://www.lyx.org/ \lyxformat 220 -\textclass manpage +\textclass amsart-plain \language english \inputencoding auto \fontscheme times @@ -26,11 +26,14 @@ \layout Section +LCTL +\layout Subsection + NAME \layout Standard lctl - low level Lustre file system configuration utility -\layout Section +\layout Subsection SYNOPSIS \layout Standard @@ -56,7 +59,7 @@ lctl\SpecialChar ~ \SpecialChar ~ \SpecialChar ~ -\layout Section +\layout Subsection DESCRIPTION \layout Standard @@ -99,7 +102,7 @@ on a device name. devno \emph default is used as above. -\layout Section +\layout Subsection SUBCOMMANDS \layout Description @@ -282,16 +285,16 @@ exit quit \end_deeper -\layout Section +\layout Subsection EXAMPLES -\layout Section +\layout Subsection BUGS \layout Standard None are known. -\layout Section +\layout Subsection AUTHOR \layout Standard diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx index f5c85bb..ac0ccb0 100644 --- a/lustre/doc/lmc.lyx +++ b/lustre/doc/lmc.lyx @@ -1,6 +1,6 @@ #LyX 1.2 created this file. For more info see http://www.lyx.org/ \lyxformat 220 -\textclass manpage +\textclass amsart \language english \inputencoding auto \fontscheme times @@ -26,272 +26,111 @@ \layout Section +lmc +\layout Subsection + NAME \layout Standard lctl - low level Lustre file system configuration utility -\layout Section +\layout Subsection SYNOPSIS \layout Standard \series bold -lctl -\layout Standard - - -\series bold -lctl\SpecialChar ~ ---device\SpecialChar ~ - -\layout Standard - - -\series bold -lctl\SpecialChar ~ ---threads\SpecialChar ~ -\SpecialChar ~ -\SpecialChar ~ -\SpecialChar ~ - -\layout Section +lmc [options] [cmd args] +\layout Subsection DESCRIPTION \layout Standard -The program can be invoked in interactive mode by issuing -\series bold -lctl. - -\series default - After than commands are issued as below. -\layout Standard - -For non-interactive single threaded use, one uses the second invocation - which runs -\emph on -command -\emph default - after connecting to the -\emph on -device. - -\emph default +lmc can be invoked to generate configuration data associated with systems + in a Lustre cluster. \layout Description ---device The device number to be used for the operation. - The value of devno is an integer, normally found by calling -\emph on -lctl name2dev -\emph default -on a device name. - -\layout Description - ---threads How many threads should be forked doing the command specified. - The numthreads variable is a strictly positivie integer indicating how - many threads should be started. - Verbose can take values , -\emph on -devno -\emph default -is used as above. -\layout Section - -SUBCOMMANDS -\layout Description - -network\SpecialChar ~ -config -\begin_deeper -\layout Description - -network\SpecialChar ~ - Indicate what kind of network applies for the - configuration commands that follow. -\layout Description - -connect\SpecialChar ~ -[[\SpecialChar ~ -]\SpecialChar ~ -|\SpecialChar ~ -] -\layout Description - -disconnect -\layout Description - -mynid -\layout Description - -add_uuid -\layout Description - -close_uuid -\layout Description - -del_uuid -\layout Description - -add_route -\layout Description - -del_route -\layout Description - -route_list +--node\SpecialChar ~ +''node_name'' By itself, this will create a new node. + This is also used to specify a specific node for other elements, and the \layout Description -recv_mem +--net\SpecialChar ~ +host_name\SpecialChar ~ +net_type\SpecialChar ~ +[port] Adds a network interface to a node. + If host_name is '*', then the local address while be substituted when the + node is configured with lconf. + This requires a --node argument. \layout Description -send_mem +--mds\SpecialChar ~ +mds_name Adds an MDS to the specified node. + This requires a --node argument. \layout Description -nagle -\end_deeper +--lov\SpecialChar ~ +lov_name\SpecialChar ~ +mds_name\SpecialChar ~ +stripe_sz\SpecialChar ~ +stripe_off\SpecialChar ~ +pattern Creates an LOV with the + specified parameters. + The mds_name must already exist in the descriptor. + When used as an argument to other commands, only the lov_name is specified. \layout Description +--ost\SpecialChar ~ device\SpecialChar ~ -selection -\begin_deeper +[size] Creates an OBD, OST, and OSC. + The OST and OBD are created on the specified node. + If an lov option is used, then the OSC will be added to the LOV. + Requires: --node. \layout Description -newdev +--ostuuid\SpecialChar ~ +UUID specify the UUID of the OSC device. + The default value is OSC_nodename. \layout Description -name2dev +--mtpt\SpecialChar ~ +/mnt/path\SpecialChar ~ +mdc_uuid\SpecialChar ~ +lov_uuid|osc_uuid Creates a mount point on the specified + node. + Either an LOV or OSC name can be used. + Requires: --node \layout Description -device -\layout Description - -device_list -\end_deeper -\layout Description - -device\SpecialChar ~ -config +Options: \begin_deeper \layout Description -attach -\layout Description - -setup +--output filename Sends output to the file. + If the file exists, it will be overwritten. \layout Description -cleanup -\layout Description - -detach -\layout Description - -lovconfig -\end_deeper -\layout Description - -device\SpecialChar ~ -operations -\begin_deeper -\layout Description - -probe -\layout Description - -close -\layout Description - -getattr -\layout Description - -setattr -\layout Description - -create -\layout Description - -destroy -\layout Description - -test_getattr -\layout Description - -test_brw -\layout Description - -test_ldlm -\layout Description - -ldlm_regress_start -\layout Description - -ldlm_regress_stop -\layout Description - -dump_ldlm -\layout Description - -newconn -\end_deeper -\layout Description - -debug -\begin_deeper -\layout Description - -debug_kernel -\layout Description - -debug_file -\layout Description - -clear -\layout Description - -mark -\layout Description - -filter -\layout Description - -show -\layout Description - -debug_list\SpecialChar ~ -modules -\layout Description - -panic -\end_deeper -\layout Description - -control -\begin_deeper -\layout Description - -help -\layout Description - -exit +--merge filename Add the new element to an existing file. + \layout Description -quit +--format Turns on autoformat. + The block devices for MDS and OBD will be formatted if necessary. \end_deeper -\layout Section +\layout Subsection EXAMPLES -\layout Section +\layout Standard + +Real life examples are given in the lustre-conf man page. +\layout Subsection BUGS \layout Standard None are known. -\layout Section +\layout Subsection AUTHOR \layout Standard -- 1.8.3.1