X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Flmc.lyx;h=48fcb4b2a58c5b9f7e672a18ab9d935cc77fc0c7;hb=5900da4464d90468519964571c441382cd512232;hp=f28944fb32f551ab9a121cf8246275d79c37e0cf;hpb=4f0ccc2fa8f60290aacd8ff1918edb66f080cb28;p=fs%2Flustre-release.git diff --git a/lustre/doc/lmc.lyx b/lustre/doc/lmc.lyx index f28944f..48fcb4b 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 -lctl - low level Lustre file system configuration utility +lmc Lustre configuration maker. \layout Subsection SYNOPSIS @@ -40,102 +40,652 @@ SYNOPSIS \series bold -lmc [options] [cmd args] +lmc [options] --add [args] +\layout Standard + + +\series bold +lmc [options] --remove [args] -- [NOT IMPLEMENTED] +\layout Standard + + +\series bold +lmc [options] --convert [args] -- [NOT IMPLEMENTED] \layout Subsection DESCRIPTION \layout Standard -lmc can be invoked to generate configuration data associated with systems - in a Lustre cluster. +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 +\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 + mtpt +\series default +, +\series bold + route +\series default +, +\series bold + echo_client, or cobd. + +\series default +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: +\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 --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 +''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 +\layout Description + +--group_upcall\SpecialChar ~ + Specify the location of the group upcall scripts used by the MDS + for determiningsupplementary group membership +\layout Description + +--ptldebug\SpecialChar ~ + Set the portals debug level. \layout Description ---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. +--subsytem\SpecialChar ~ + Specify which Lustre subsystems have debug output + recorded in the log. +\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: +\layout Description + +--node\SpecialChar ~ +''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 ~ + Specify the network type.This can be +\series bold +tcp, elan, gm. +\layout Description + +--nid\SpecialChar ~ +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 + +--cluster_id\SpecialChar ~ +id Specify the cluster ID. +\layout Description + +--hostaddr\SpecialChar ~ +addr Specify the host address. + lconf will transfer it to the real host address. +\layout Description + +--router Optional flag to mark this node as a router +\layout Description + +--port\SpecialChar ~ +[port] Optional arguement to indicate the tcp port. + The default is 988. + +\layout Description + +--tcpbuf\SpecialChar ~ + 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 + +--add\SpecialChar ~ +mds +\begin_deeper +\layout Description + +--node\SpecialChar ~ + Name of the node on which the MDS resides \layout Description --mds\SpecialChar ~ -mds_name Adds an MDS to the specified node. - This requires a --node argument. + Specify MDS name. +\layout Description + +--mdsuuid\SpecialChar ~ + Specify MDS uuid. +\layout Description + +--failover Enable failover support on MDS. +\layout Description + +--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. +\layout Description + +--size\SpecialChar ~ + 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 +\emph on +--node +\emph default + argument, and it must not be a profile node. +\layout Description + +--fstype\SpecialChar ~ +ldiskfs|ext3 Optional argument used to specify the file system type. + Default is ext3. For 2.6 kernels the ldiskfs filesystem must be used. +\layout Description + +--inode_size\SpecialChar ~ + Specify new inode size for underlying ext3 file system. Must be a + power of 2 between 128 and 4096. The default inode size is selected based + on the default number of stripes specified for the filesystem. +\layout Description + +--group_upcall\SpecialChar ~ + The group upcall program to call for resolving a user's secondary + groups. The default value is NONE, which means that the MDS will use whatever + supplementary group is passed from the client. The supplied upcall is + /usr/sbin/l_getgroups, which gets groups from the MDS's /etc/group file + based on the client-supplied UID. + +--mkfsoptions\SpecialChar ~ + Optional argument to mkfs. +\layout Description + +--mountfsoptions\SpecialChar ~ + Optional argument to mount fs. + Mount options will be passed by this argument. + For example, extents are to be enabled by adding ",extents" to the --mountfsopt +ions option. + +\begin_inset Quotes eld +\end_inset + +errors=remount-ro +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +asyncdel +\begin_inset Quotes erd +\end_inset + + can also be added to it. +\layout Description + +--journal_size\SpecialChar ~ + Optional arguement to specify the journal size for + the 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 ext3 filesystem will be configured + with a journal size dependent upon how large the filesystem is. +\end_deeper +\layout Description + +--add\SpecialChar ~ +lov Creates an LOV with the specified parameters. + The +\emph on +mds_name +\emph default + must already exist in the descriptor. +\begin_deeper \layout Description --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. + Specify LOV name. \layout Description ---ost\SpecialChar ~ -device\SpecialChar ~ -[size] Creates an OBD, OST, and OSC. +--mds\SpecialChar ~ + Specify the mds name. +\layout Description + +--stripe_sz\SpecialChar ~ + Specify the stripe size in bytes. This much data is written to each + stripe before starting to write in the next stripe. Default is 1048576. +\layout Description + +--stripe_cnt\SpecialChar ~ + A value of 0 for this means to use the currently optimal number + of stripes. Default is 1 stripe per file. +\layout Description + +--stripe_pattern\SpecialChar ~ + Only Pattern 0 (RAID 0) is supported currently. +\end_deeper +\layout Description + +--add\SpecialChar ~ +ost 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. +\begin_deeper \layout Description ---obduuid\SpecialChar ~ -UUID specify the UUID of the OBD device. - +--ost\SpecialChar ~ + Assign a name to the OST device. \layout Description ---mtpt\SpecialChar ~ -/mnt/path\SpecialChar ~ -mdc_uuid\SpecialChar ~ -lov_uuid|osc_uuid Creates a mount point on the specified +--node\SpecialChar ~ + Node on which the OST service is run, can not be a profile node. - Either an LOV or OSC name can be used. - The default OSC name currently used is OSC_. - Requires: --node \layout Description -Options: +--failover Enable failover support on OST. +\layout Description + +--dev\SpecialChar ~ + Path of device on local system. + If this is a file, then a loop device is created and used as the block + device. +\layout Description + +--size\SpecialChar ~ +[size] Optional argument indicating the size (in KB) of the device + to be created (used typically for loop devices). +\layout Description + +--osdtype\SpecialChar ~ +obdfilter|obdecho Specify the type of OSD. +\layout Description + +--lov\SpecialChar ~ + 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 + +--fstype\SpecialChar ~ +ldiskfs|ext3 Optional arguement used to specify the file system type. + Default is ext3. +\layout Description + +--inode_size\SpecialChar ~ + Specify new inode size for underlying ext3 file system. +\layout Description + +--mkfsoptions\SpecialChar ~ + Optional argument to mkfs. +\layout Description + +--mountfsoptions\SpecialChar ~ + Optional argument to mount fs. + Mount options will be passed by this argument. + For example, extents are to be enabled by adding ",extents" to the --mountfsopt +ions option. + +\begin_inset Quotes eld +\end_inset + +errors=remount-ro +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +asyncdel +\begin_inset Quotes erd +\end_inset + + can also be added to it. +\layout Description + +--journal_size\SpecialChar ~ + Optional arguement to specify the journal size for + the 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 ext3 filesystem will be configured + with a journal size dependent upon how large the filesystem is. +\end_deeper +\layout Description + +--add\SpecialChar ~ +mtpt Creates a mount-point on the specified node for the given LOV. \begin_deeper \layout Description ---output filename Sends output to the file. - If the file exists, it will be overwritten. +--node\SpecialChar ~ +node Node or profile node that will use the +\emph on +mtpt +\emph default +. +\layout Description + +--path\SpecialChar ~ +/mnt/path Specify the mountpoint for Lustre. +\layout Description + +--mds\SpecialChar ~ +mds_name Specify the mds name, which will provide service for this + client. +\layout Description + +--ost\SpecialChar ~ +ost_name\SpecialChar ~ +|\SpecialChar ~ +--lov\SpecialChar ~ +lov_name Specify the ost or lov, which will provide service + for this client. +\layout Description + +--clientoptions Specify the options for Lustre, such as async. +\end_deeper \layout Description ---merge filename Add the new element to an existing file. +--add\SpecialChar ~ +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 to add the route to. +\layout Description + +--router Optional flag to mark a node as router. +\layout Description + +--gw\SpecialChar ~ +nid The +\emph on +nid +\emph default + of the gateway (must be a local interface or a peer). +\layout Description + +--gateway_cluster_id\SpecialChar ~ +id Specify the id of the cluster, to which the gateway + belongs. +\layout Description + +--target_cluster_id\SpecialChar ~ +id Specify the id of the cluster, to which the target + of the route belongs. +\layout Description + +--lo\SpecialChar ~ +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 +\emph on +nid. +\end_deeper +\layout Description + +--add\SpecialChar ~ +echo-client Used for testing purpose only. +\begin_deeper \layout Description ---format Turns on autoformat. - The block devices for MDS and OBD will be formatted if necessary. +--node\SpecialChar ~ +nodename +\emph on + +\emph default +Node on which the echo-client resides. \end_deeper +\layout Description + +\end_deeper +\layout List +\labelwidthstring 00.00.0000 + + +\series bold +Options +\layout Description + +--reference Print short reference for commands. +\layout Description + +--verbose Print system commands as they are run. +\layout Description + +--batch\SpecialChar ~ +filename Used to execute lmc commands in batch mode. +\layout Description + +--output\SpecialChar ~ +filename Send output to the file. + If the file exists, it will be overwritten. +\layout Description + +--merge\SpecialChar ~ +filename +\emph on + +\emph default +Add the new element to an existing file. + \layout Subsection EXAMPLES +\layout Subsubsection + +--add net \layout Standard -Real life examples are given in the lustre-conf man page. -\layout Subsection -BUGS +\series bold +lmc --node adev3 --add net --nid adev3 --cluster_id 0x1000 --nettype tcp + --hostaddr adev3-eth0 --port 988 \layout Standard -None are known. + +\series bold +lmc --node adev3 --add net --nid adev3 --cluster_id 0x2000 --nettype tcp + --hostaddr adev3-eth1 --port 989 +\series default +\emph on + +\layout Standard + +Used to add a Lustre node to a specified Lustre cluster through a network + interface. + In this example, Lustre node adev3 has been added to 2 Lustre clusters + whose cluster_id are 0x1000 and 0x2000 separately through 2 network interface + cards: adev3-eth0 and adev3-eth1. + adev3 would listen in some specified port(s) to prepare for possible connection + requests from nodes in these two clusters. +\layout Subsubsection + +--add route +\layout Standard + + +\series bold +lmc --node adev3 --add route --nettype tcp --gw 5 --gateway_cluster_id 0x1000 + --target_cluster_id 0x1000 --lo 4 --hi 7 +\layout Standard + +Used to add a route entry for a Lustre node. + Here Lustre node adev3 is told it has a new route entry that now it could + send packets to Lustre nodes whose nids is from 4 to 7 with the help of + Lustre gateway node whose nid is 5. + Besides, Lustre gateway node is in cluster whose id is 0x1000 and target + of the route belongs to cluster whose id is also 0x1000. + The network in this route path is a tcp network. \layout Subsection -AUTHOR +BUGS \layout Standard -Cluster File Systems, Inc. - 2002 - created +None are known. \the_end