<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US" xml:id="systemconfigurationutilities">
<title xml:id="systemconfigurationutilities.title">System Configuration Utilities</title>
<para>This chapter includes system configuration utilities and includes the following sections:</para>
<para>The l_getidentity utility handles Lustre user / group cache upcall.</para>
<section remap="h5">
<title>Synopsis</title>
- <screen>l_getidentity {mdtname} {uid}</screen>
+ <screen>l_getidentity ${FSNAME}-MDT{xxxx} {uid}</screen>
</section>
<section remap="h5">
<title>Description</title>
- <para>The group upcall file contains the path to an executable file that is invoked to resolve a numeric UID to a group membership list. This utility opens <literal>/proc/fs/lustre/mdt/{mdtname}/identity_info</literal> and writes the related <literal>identity_downcall_data</literal> structure (see <xref linkend='dbdoclet.50438291_33759'/>.) The data is persisted with <literal>lctl set_param mdt.{mdtname}.identity_info</literal>.</para>
+ <para>The group upcall file contains the path to an executable file that is invoked to resolve
+ a numeric UID to a group membership list. This utility opens
+ <literal>/proc/fs/lustre/mdt/${FSNAME}-MDT{xxxx}/identity_info</literal> and writes the
+ related <literal>identity_downcall_data</literal> structure (see <xref
+ linkend="dbdoclet.50438291_33759"/>.) The data is persisted with <literal>lctl set_param
+ mdt.${FSNAME}-MDT{xxxx}.identity_info</literal>.</para>
<para>The l_getidentity utility is the reference implementation of the user or group cache upcall.</para>
</section>
<section remap="h5">
<tbody>
<row>
<entry>
- <para> <literal>mdtname</literal></para>
+ <para>
+ <literal>${FSNAME}-MDT{xxxx}</literal></para>
</entry>
<entry>
<para> Metadata server target name</para>
</section>
<section remap="h5">
<title>Description</title>
- <para>The ll_decode_filter_fid utility decodes and prints the Lustre OST object ID, MDT FID, stripe index for the specified OST object(s), which is stored in the "trusted.fid" attribute on each OST object. This is accessible to ll_decode_filter_fid when the OST filesystem is mounted locally as type ldiskfs for maintenance.</para>
+ <para>The ll_decode_filter_fid utility decodes and prints the Lustre OST object ID, MDT FID,
+ stripe index for the specified OST object(s), which is stored in the "trusted.fid"
+ attribute on each OST object. This is accessible to <literal>ll_decode_filter_fid</literal>
+ when the OST file system is mounted locally as type ldiskfs for maintenance.</para>
<para>The "trusted.fid" extended attribute is stored on each OST object when it is first modified (data written or attributes set), and is not accessed or modified by Lustre after that time.</para>
<para>The OST object ID (objid) is useful in case of OST directory corruption, though normally the ll_recover_lost_found_objs(8) utility is able to reconstruct the entire OST object directory hierarchy. The MDS FID can be useful to determine which MDS inode an OST object is (or was) used by. The stripe index can be used in conjunction with other OST objects to reconstruct the layout of a file even if the MDT inode was lost.</para>
</section>
<para> <literal>-t <replaceable>timestamp</replaceable></literal></para>
</entry>
<entry>
- <para> Sets the test start time as printed at the start of a previously-interrupted test to ensure that validation data is the same across the entire filesystem (default value is the current time()).</para>
+ <para> Sets the test start time as printed at the start of a previously-interrupted
+ test to ensure that validation data is the same across the entire file system
+ (default value is the current time()).</para>
</entry>
</row>
<row>
<section xml:id="dbdoclet.50438219_75432">
<title><indexterm><primary>mkfs.lustre</primary></indexterm>
mkfs.lustre</title>
- <para>The mkfs.lustre utility formats a disk for a Lustre service.</para>
+ <para>The <literal>mkfs.lustre</literal> utility formats a disk for a Lustre service.</para>
<section remap="h5">
<title>Synopsis</title>
<screen>mkfs.lustre <replaceable>target_type</replaceable> [options] <replaceable>device</replaceable></screen>
<para> <literal>--ost</literal></para>
</entry>
<entry>
- <para> Object Storage Target (OST)</para>
+ <para> Object storage target (OST)</para>
</entry>
</row>
<row>
<para> <literal>--mdt</literal></para>
</entry>
<entry>
- <para> Metadata Storage Target (MDT)</para>
+ <para> Metadata storage target (MDT)</para>
</entry>
</row>
<row>
<para> <literal>--mgs</literal></para>
</entry>
<entry>
- <para> Configuration Management Service (MGS), one per site. This service can be combined with one <literal>--mdt</literal> service by specifying both types.</para>
+ <para> Configuration management service (MGS), one per site. This service can be
+ combined with one <literal>--mdt</literal> service by specifying both
+ types.</para>
</entry>
</row>
</tbody>
</section>
<section remap="h5">
<title>Description</title>
- <para>mkfs.lustre is used to format a disk device for use as part of a Lustre file system. After formatting, a disk can be mounted to start the Lustre service defined by this command.</para>
- <para>When the file system is created, parameters can simply be added as a --param option to the mkfs.lustre command. See <xref linkend="dbdoclet.50438194_17237"/>.</para>
+ <para><literal>mkfs.lustre</literal> is used to format a disk device for use as part of a
+ Lustre file system. After formatting, a disk can be mounted to start the Lustre service
+ defined by this command.</para>
+ <para>When the file system is created, parameters can simply be added as a
+ <literal>--param</literal> option to the <literal>mkfs.lustre</literal> command. See <xref
+ linkend="dbdoclet.50438194_17237"/>.</para>
<informaltable frame="all">
<tgroup cols="3">
- <colspec colname="c1" colwidth="33*"/>
- <colspec colname="c2" colwidth="33*"/>
- <colspec colname="c3" colwidth="33*"/>
+ <colspec colname="c1" colwidth="1*"/>
+ <colspec colname="c2" colwidth="1*"/>
+ <colspec colname="c3" colwidth="3*"/>
<thead>
<row>
<entry nameend="c2" namest="c1">
<para> <literal>--comment=<replaceable>comment</replaceable></literal></para>
</entry>
<entry>
- <para> Sets a user comment about this disk, ignored by Lustre.</para>
+ <para> Sets a user comment about this disk, ignored by the Lustre software.</para>
</entry>
</row>
<row>
<para> <literal>--device-size=<replaceable>#</replaceable>>KB</literal></para>
</entry>
<entry>
- <para> Sets the device size for loop devices.</para>
+ <para>Sets the device size for loop devices.</para>
</entry>
</row>
<row>
<para> <literal>--dryrun</literal></para>
</entry>
<entry>
- <para> Only prints what would be done; it does not affect the disk.</para>
+ <para>Only prints what would be done; it does not affect the disk.</para>
</entry>
</row>
<row>
- <entry nameend="c2" namest="c1">
- <para> <literal>--failnode=<replaceable>nid,...</replaceable></literal></para>
- </entry>
- <entry>
- <para> Sets the NID(s) of a failover partner. This option can be repeated as needed.</para>
- <warning><para>This cannot be used with <literal>--servicenode</literal>.</para></warning>
- </entry>
+ <entry nameend="c2" namest="c1"
+ ><literal>--servicenode=<replaceable>nid,...</replaceable></literal></entry>
+ <entry>Sets the NID(s) of all service nodes, including primary and failover partner
+ service nodes. The <literal>--servicenode</literal> option cannot be used with
+ <literal>--failnode</literal> option. See <xref
+ xmlns:xlink="http://www.w3.org/1999/xlink" linkend="dbdoclet.50438188_92688"/> for
+ more details.</entry>
</row>
<row>
<entry nameend="c2" namest="c1">
- <para> <literal>--servicenode=<replaceable>nid,...</replaceable></literal></para>
+ <para> <literal>--failnode=<replaceable>nid,...</replaceable></literal></para>
</entry>
<entry>
- <para> Sets the NID(s) of all service node, including failover partner as well as primary node service nids. This option can be repeated as needed.</para>
- <warning><para>This cannot be used with <literal>--failnode</literal>.</para></warning>
+ <para>Sets the NID(s) of a failover service node for a primary server for a target.
+ The <literal>--failnode</literal> option cannot be used with
+ <literal>--servicenode</literal> option. See <xref
+ xmlns:xlink="http://www.w3.org/1999/xlink" linkend="dbdoclet.50438188_92688"/>
+ for more details.<note>
+ <para>When the <literal>--failnode</literal> option is used, certain
+ restrictions apply (see <xref xmlns:xlink="http://www.w3.org/1999/xlink"
+ linkend="dbdoclet.50438188_92688"/>).</para>
+ </note></para>
</entry>
</row>
<row>
<para> <literal>--fsname=<replaceable>filesystem_name</replaceable></literal></para>
</entry>
<entry>
- <para> The Lustre file system of which this service/node will be a part. The default file system name is 'lustreâ€.</para>
+ <para> The Lustre file system of which this service/node will be a part. The default
+ file system name is <literal>lustre</literal>.</para>
<para> </para>
<note>
<para>The file system name is limited to 8 characters.</para>
</row>
<row>
<entry nameend="c2" namest="c1">
- <para> <literal>--index=<replaceable>index</replaceable></literal></para>
+ <para>
+ <literal>--index=<replaceable>index_number</replaceable></literal></para>
</entry>
<entry>
- <para> Specifies the OST or MDT number. This should always be used when formatting OSTs, in order to ensure that there is a simple mapping between the OST index and the OSS node and device it is located on.</para>
+ <para>Specifies the OST or MDT number (0...N). This allows mapping between the OSS
+ and MDS node and the device on which the OST or MDT is located.</para>
</entry>
</row>
<row>
</entry>
<entry>
<para> Sets the mount options used when the backing file system is mounted.</para>
- <warning><para>Unlike earlier versions of mkfs.lustre, this version completely replaces the default mount options with those specified on the command line, and issues a warning on stderr if any default mount options are omitted.</para></warning>
+ <warning><para>Unlike earlier versions of <literal>mkfs.lustre</literal>, this version completely replaces
+ the default mount options with those specified on the command line, and issues a
+ warning on stderr if any default mount options are omitted.</para></warning>
<para>The defaults for ldiskfs are:</para>
<para>OST: <literal>errors=remount-ro</literal>;</para>
<para>MGS/MDT: <literal>errors=remount-ro,iopen_nopriv,user_xattr</literal></para>
- <para>Do not alter the default mount options unless you know what you are doing.</para>
+ <para>Use care when altering the default mount options.</para>
</entry>
</row>
<row>
<title>Examples</title>
<para>Creates a combined MGS and MDT for file system <literal>testfs</literal> on, e.g., node <literal>cfs21</literal>:</para>
<screen>mkfs.lustre --fsname=testfs --mdt --mgs /dev/sda1</screen>
- <para>Creates an OST for file system <literal>testfs</literal> on any node (using the above MGS):</para>
+ <para>Creates an OST for file system <literal>testfs</literal> on any node (using the above
+ MGS):</para>
<screen>mkfs.lustre --fsname=testfs --mgsnode=cfs21@tcp0 --ost --index=0 /dev/sdb</screen>
<para>Creates a standalone MGS on, e.g., node <literal>cfs22</literal>:</para>
<screen>mkfs.lustre --mgs /dev/sda1</screen>
<para> </para>
</entry>
<entry>
- <para> Mounts the Lustre file system named <literal>fsname</literal> on the client by contacting the Management Service at <literal>mgsspec</literal> on the pathname given by <literal>directory</literal>. The format for <literal>mgsspec</literal> is defined below. A mounted client file system appears in fstab(5) and is usable, like any local file system, and provides a full POSIX-compliant interface.</para>
+ <para> Mounts the Lustre file system named <literal>fsname</literal> on the client
+ by contacting the Management Service at <literal>mgsspec</literal> on the pathname
+ given by <literal>directory</literal>. The format for <literal>mgsspec</literal>
+ is defined below. A mounted client file system appears in fstab(5) and is usable,
+ like any local file system, and provides a full POSIX standard-compliant
+ interface.</para>
</entry>
</row>
<row>
</row>
<row>
<entry>
- <para> <literal>--failnode=<replaceable>nid,...</replaceable></literal></para>
- </entry>
- <entry>
- <para> Sets the NID(s) of a failover partner. This option can be repeated as needed.</para>
- <warning><para>Cannot be used with <literal>--servicenode</literal>.</para></warning>
- </entry>
+ <literal>--servicenode=<replaceable>nid,...</replaceable></literal></entry>
+ <entry>Sets the NID(s) of all service nodes, including primary and failover partner
+ service nodes. The <literal>--servicenode</literal> option cannot be used with
+ <literal>--failnode</literal> option. See <xref
+ xmlns:xlink="http://www.w3.org/1999/xlink" linkend="dbdoclet.50438188_92688"/> for
+ more details.</entry>
</row>
<row>
<entry>
- <para> <literal>--servicenode=<replaceable>nid,...</replaceable></literal></para>
+ <para> <literal>--failnode=<replaceable>nid,...</replaceable></literal></para>
</entry>
<entry>
- <para> Sets the NID(s) of all service node, including failover partner as well as local service nids. This option can be repeated as needed.</para>
- <warning><para>: Cannot be used with <literal>--failnode</literal>.</para></warning>
+ <para>Sets the NID(s) of a failover service node for a primary server for a target.
+ The <literal>--failnode</literal> option cannot be used with
+ <literal>--servicenode</literal> option. See <xref
+ xmlns:xlink="http://www.w3.org/1999/xlink" linkend="dbdoclet.50438188_92688"/>
+ for more details.<note>
+ <para>When the <literal>--failnode</literal> option is used, certain
+ restrictions apply (see <xref xmlns:xlink="http://www.w3.org/1999/xlink"
+ linkend="dbdoclet.50438188_92688"/>).</para>
+ </note></para>
</entry>
</row>
<row>
<para> <literal>--fsname=<replaceable>filesystem_name</replaceable></literal></para>
</entry>
<entry>
- <para> The Lustre file system of which this service will be a part. The default file system name is 'lustreâ€.</para>
+ <para> The Lustre file system of which this service will be a part. The default file
+ system name is <literal>lustre</literal>.</para>
</entry>
</row>
<row>
<para> <literal>--writeconf</literal></para>
</entry>
<entry>
- <para> Erases all configuration logs for the file system to which this MDT belongs, and regenerates them. This is dangerous operation. All clients must be unmounted and servers for this file system should be stopped. All targets (OSTs/MDTs) must then be restarted to regenerate the logs. No clients should be started until all targets have restarted.</para>
- <para> </para>
+ <para> Erases all configuration logs for the file system to which this MDT belongs,
+ and regenerates them. This is dangerous operation. All clients must be unmounted
+ and servers for this file system should be stopped. All targets (OSTs/MDTs) must
+ then be restarted to regenerate the logs. No clients should be started until all
+ targets have restarted.</para>
<para>The correct order of operations is:</para>
- <para>* Unmount all clients on the file system</para>
- <para>* Unmount the MDT and all OSTs on the file system</para>
- <para>* Run <literal>tunefs.lustre --writeconf <replaceable>device</replaceable></literal> on every server</para>
- <para>* Mount the MDT and OSTs</para>
- <para>* Mount the clients</para>
+ <orderedlist>
+ <listitem>
+ <para>Unmount all clients on the file system</para>
+ </listitem>
+ <listitem>
+ <para>Unmount the MDT and all OSTs on the file system</para>
+ </listitem>
+ <listitem>
+ <para>Run <literal>tunefs.lustre --writeconf
+ <replaceable>device</replaceable></literal> on every server</para>
+ </listitem>
+ <listitem>
+ <para>Mount the MDT and OSTs</para>
+ </listitem>
+ <listitem>
+ <para>Mount the clients</para>
+ </listitem>
+ </orderedlist>
</entry>
</row>
</tbody>
git://git.whamcloud.com / doc / manual.git / blobdiff