X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Flmc.lyx;h=bb6ca2b083d192c00d7096dafbb61fba46bb7d34;hb=37113b4cd285399154f0d8a27df7d4090cc5fee4;hp=a5160b719a4bc8cddc05dabd53d532bccb69838b;hpb=df19a2c10f6d84133ab52912a14a10c411ff7a18;p=fs%2Flustre-release.git diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx index a5160b7..bb6ca2b 100644 --- a/lustre/doc/lmc.lyx +++ b/lustre/doc/lmc.lyx @@ -1,5 +1,5 @@ -#LyX 1.2 created this file. For more info see http://www.lyx.org/ -\lyxformat 220 +#LyX 1.3 created this file. For more info see http://www.lyx.org/ +\lyxformat 221 \textclass amsart \language english \inputencoding auto @@ -30,9 +30,9 @@ lmc \layout Subsection NAME -\layout Standard +\layout Description -lmc - lustre configuration maker. +lmc Lustre configuration maker. \layout Subsection SYNOPSIS @@ -45,82 +45,219 @@ lmc [options] --add [args] \series bold -NOT IMPLEMENTED -- lmc [options] --remove [args] +lmc [options] --remove [args] -- [NOT IMPLEMENTED] \layout Standard \series bold -NOT IMPLEMENTED -- lmc [options] --convert [args] +lmc [options] --convert [args] -- [NOT IMPLEMENTED] \layout Subsection DESCRIPTION \layout Standard -At present lmc when invoked adds configuration data to the config file. - lmc will also be able to remove configuration data or convert its forma. - One generates a single config file for the cluster at present including - at the minimum mds's, mtpt's and ost's and whatever those reference (e.g. - net's and profiles) +At present +\series bold +\emph on +lmc +\series default +\emph default +, when invoked, adds configuration data to the config file. + In future, +\series bold +\emph on +lmc +\series default +\emph default + will also be able to remove configuration data or convert its format. + A Lustre cluster consists of several components - MDS's, mount-points, + OSTs, LOVs and whatever those reference (e.g nets and profiles). + A single configuration file would be generated for the complete cluster. + In the +\series bold +\emph on +lmc +\series default +\emph default + command line interface, each of these components is associated with an + +\emph on +objecttype +\emph default +. + \layout Standard -The objecttype refers to a collection of related configuration entities - and can be one of +The +\emph on +objecttype +\emph default + refers to a collection of related configuration entities and can be one + of +\series bold +net +\series default +, +\series bold + MDS +\series default +, +\series bold + LOV +\series default +, +\series bold + OST +\series default +, \series bold -net, mds, lov, ost, mtpt, route, oscref. + mtpt +\series default +, +\series bold + route +\series default +, +\series bold + +\series default +or +\series bold + echo_client. \series default -We describe the arguments required for the addition of each objecttype. - [NOT implemented] Lmc can also remove items from or convert the format - of configuration data. +We describe the arguments required for the addition of each +\emph on +objecttype +\emph default +. + \layout Standard -to generate configuration data associated with systems in a Lustre cluster. +To generate configuration data associated with systems in a Lustre cluster: +\layout Description + + +\emph on +- +\emph default +-add\SpecialChar ~ +node Adds a new node in the cluster configuration. +\begin_deeper +\layout Standard + +The arguments required are: \layout Description ---add\SpecialChar ~ +--node\SpecialChar ~ +''node_name'' This will create a new node with the given name if not + already present. +\layout Description + +--timeout\SpecialChar ~ + Timeout before going into recovery +\layout Description + +--lustre_upcall\SpecialChar ~ + Set the location of the Lustre upcall scripts used + by the client for recovery +\layout Description + +--portals_upcall\SpecialChar ~ + Specify the location of the Portals upcall scripts + used by the client for recovery +\layout Description + +--upcall\SpecialChar ~ + Specify the location of both (Lustre and Portals) upcall + scripts used by the client for recovery +\end_deeper +\layout Description + + +\emph on +- +\emph default +-add\SpecialChar ~ net Adds a network device descriptor for the given node, with parameters as indicated. \begin_deeper \layout Standard -The arguments required are +The arguments required are: \layout Description --node\SpecialChar ~ -''node_name'' If not present this will create a new node with the - given name. - This is also used to specify a specific node for other elements, and the +''node_name'' This will create a new node with the given name if not + already present. + This is also used to specify a specific node for other elements. \layout Description --nettype\SpecialChar ~ - this can be + This can be \series bold -tcp, elan, gm +tcp, elan, gm. \layout Description --nid\SpecialChar ~ -nid the network id, e.g. - ElanID or IP address as used by portals. - If host_name is '*', then the local address while be substituted when the - node is configured with lconf. +nid The network +\emph on +id +\emph default +, e.g. + ElanID or IP address as used by Portals. + If +\emph on +nid +\emph default + is '*', then the local address of the interface with specified +\series bold +nettype +\series default +is will be substituted when the node is configured with lconf. + An +\emph on +nid +\emph default + of +\emph on +'*' +\emph default + should be used only for the generic +\emph on +client +\emph default + configuration. \layout Description ---router optional flag to mark this node as a router +--hostaddr addr \layout Description ---profile optional flag to mark this node as a profile node. - This is automatically true if the the --nid argument contains a '*'. +--router Optional flag to mark this node as a router \layout Description --port\SpecialChar ~ -[port] optional argument to indicate the tcp port. +[port] Optional arguement to indicate the tcp port. The default is 988. \layout Description --tcpbuf\SpecialChar ~ - optional argument + Optional arguement. + The default TCP buffer size is 1MB. +\layout Description + +--irq_affinity\SpecialChar ~ +0|1 Optional arguement. + Default is 0. +\layout Description + +--nid_exchange\SpecialChar ~ +0|1 Optional arguement since some OSTs might not have the + required support. + This is turned off by default, value of 1 will turn it ON. + \end_deeper \layout Description @@ -129,6 +266,11 @@ mds \begin_deeper \layout Description +--node\SpecialChar ~ + Name of the node on which the MDS resides +\layout Description + --mds\SpecialChar ~ \layout Description @@ -139,26 +281,53 @@ mds \layout Description --size\SpecialChar ~ - optional argument indicating the size of the device to be created - (used typically for loop devices). + Optional argument indicating the size (in KB) of the device + to be created (used typically for loop devices). \layout Description --node\SpecialChar ~ Adds an MDS to the specified node. - This requires a --node argument, and it must not be a profile node. + This requires a +\emph on +--node +\emph default + argument, and it must not be a profile node. +\layout Description + +--fstype\SpecialChar ~ +extN|ext3 Optional argument used to specify the file system type. + Default is ext3. +\layout Description + +--journal_size\SpecialChar ~ + Optional arguement to specify the journal size for + the ext2/ext3 file system. + The size should be in the units expected by +\series bold +mkfs +\series default +, so for ext3 it should be in MB. + If this is option is not used, the ext2/ext3 filesystem will be configured + with the default journal size. \end_deeper \layout Description --add\SpecialChar ~ lov Creates an LOV with the specified parameters. - The mds_name must already exist in the descriptor. + The +\emph on +mds_name +\emph default + must already exist in the descriptor. \begin_deeper \layout Description ---lov_ +--lov\SpecialChar ~ + \layout Description ---mds_ +--mds\SpecialChar ~ + \layout Description --stripe_sz\SpecialChar ~ @@ -166,11 +335,13 @@ lov Creates an LOV with the specified parameters. \layout Description --stripe_cnt\SpecialChar ~ - + A value of 0 for this means to stripe on all available + OSTs. + Default is 0. \layout Description --stripe_pattern\SpecialChar ~ - Pattern can be 0. + Only Pattern 0 (RAID 0) is supported currently. \end_deeper \layout Description @@ -180,8 +351,8 @@ ost Creates an OBD, OST, and OSC. \begin_deeper \layout Description ---obd\SpecialChar ~ - Assign a name to the OBD device. +--ost\SpecialChar ~ + Assign a name to the OST device. \layout Description --node\SpecialChar ~ @@ -191,32 +362,60 @@ ost Creates an OBD, OST, and OSC. --dev\SpecialChar ~ Path of device on local system. - If the is a file, then a loop device is created and used as the block device. + If this is a file, then a loop device is created and used as the block + device. \layout Description --size\SpecialChar ~ -[size] +[size] Optional argument indicating the size (in KB) of the device + to be created (used typically for loop devices). +\layout Description + +--obdtype\SpecialChar ~ +obdfilter|obdecho \layout Description --lov\SpecialChar ~ - Name of LOV to which this OSC will be attached. + Optional arguement. + Name of LOV to which this OSC will be attached. + +\layout Description + +--ostuuid\SpecialChar ~ +UUID Specify the UUID of the OST device. \layout Description ---obduuid\SpecialChar ~ -UUID specify the UUID of the OBD device. - The default value is OBD_nodename_UUID. +--fstype\SpecialChar ~ +extN|ext3 Optional arguement used to specify the file system type. + Default is ext3. +\layout Description + +--journal_size\SpecialChar ~ + Optional arguement to specify the journal size for + the ext2/ext3 file system. + The size should be in the units expected by +\series bold +mkfs +\series default +, so for ext3 it should be in MB. + If this is option is not used, the ext2/ext3 filesystem will be configured + with the default journal size. \end_deeper \layout Description --add\SpecialChar ~ -mtpt Creates a mount point on the specified node. +mtpt Creates a mount-point on the specified node. Either an LOV or OSC name can be used. \begin_deeper \layout Description --node\SpecialChar ~ -node node or profile node that will use the mtpt +node Node or profile node that will use the +\emph on +mtpt +\emph default +. \layout Description --path\SpecialChar ~ @@ -228,85 +427,103 @@ node node or profile node that will use the mtpt mds_name \layout Description ---obd\SpecialChar ~ -lov_name|osc_name +--ost\SpecialChar ~ +ost_name\SpecialChar ~ +|\SpecialChar ~ +--lov\SpecialChar ~ +lov_name \end_deeper \layout Description --add\SpecialChar ~ -route Creates a static route through a gateway to a specific nid or - a range of nids. +route Creates a static route through a gateway to a specific +\emph on +nid +\emph default + or a range of +\emph on +nid +\emph default +'s. \begin_deeper \layout Description --node\SpecialChar ~ -node node or profile node to add the route to +node Node to add the route to. \layout Description --gw\SpecialChar ~ -nid the nid of the gateway (must be a local interface or a peer) +nid The +\emph on +nid +\emph default + of the gateway (must be a local interface or a peer). \layout Description --tgt\SpecialChar ~ -nid for a specific route, this is the target nid +nid For a specific route, this is the target +\emph on +nid. \layout Description --lo\SpecialChar ~ -nid for a range route, this is the lo value nid +nid For a range route, this is the lo value +\emph on +nid. \layout Description --hi\SpecialChar ~ -nid for a range route, this is the hi value nid +nid For a range route, this is the hi value +\emph on +nid. \end_deeper \layout Description --add\SpecialChar ~ -oscref Adds an OSC reference to a node. - This is only necessary when the the OSC will be used without a mountpoint. +echo-client Used for testing purpose only. + \begin_deeper \layout Description --node\SpecialChar ~ -node node or profile node to add the OSC ref to +node +\emph on + \layout Description ---osc\SpecialChar ~ -osc_name Name of the OSC to add a reference to. - The --add ost command automatically creates the OSC, and the name will - be OSC_, where node is the name of node the OST is on. +--obd\SpecialChar ~ +obd_name \end_deeper -\layout Description +\layout List +\labelwidthstring 00.00.0000 -Options: -\begin_deeper + +\series bold +Options \layout Description --output\SpecialChar ~ -filename Sends output to the file. +filename Send output to the file. If the file exists, it will be overwritten. \layout Description --merge\SpecialChar ~ -filename Add the new element to an existing file. +filename +\emph on + +\emph default +Add the new element to an existing file. -\end_deeper \layout Subsection EXAMPLES \layout Standard -Real life examples are given in the lustre-conf man page. +Real life examples are given in the Lustre-conf manual page. \layout Subsection BUGS \layout Standard None are known. -\layout Subsection - -AUTHOR -\layout Standard - -Cluster File Systems, Inc. - 2002 - created \the_end