Whamcloud - gitweb
LUDOC-488 fallocate: Add fallocate tuning information
[doc/manual.git] / SystemConfigurationUtilities.xml
index 5f21e5a..0c5b60b 100644 (file)
@@ -1,5 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<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">
+<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>
   <itemizedlist>
       <para><xref linkend="dbdoclet.50438219_63667"/></para>
     </listitem>
     <listitem>
-      <para><xref linkend="dbdoclet.50438219_75432"/></para>
+      <para><xref linkend="mkfs.lustre"/></para>
     </listitem>
     <listitem>
-      <para><xref linkend="dbdoclet.50438219_12635"/></para>
+      <para><xref linkend="mount.lustre"/></para>
     </listitem>
     <listitem>
       <para><xref linkend="dbdoclet.50438219_82679"/></para>
       <para><xref linkend="dbdoclet.50438219_51496"/></para>
     </listitem>
     <listitem>
-      <para><xref linkend="dbdoclet.50438219_39574"/></para>
+      <para><xref linkend="tunefs.lustre"/></para>
     </listitem>
     <listitem>
       <para><xref linkend="dbdoclet.50438219_99928"/></para>
     </listitem>
   </itemizedlist>
   <section xml:id="dbdoclet.50438219_55923">
-      <title><indexterm><primary>e2scan</primary></indexterm>
-                  e2scan</title>
+      <title><indexterm><primary>e2scan</primary></indexterm>e2scan</title>
     <para>The e2scan utility is an ext2 file system-modified inode scan program. The e2scan program uses libext2fs to find inodes with ctime or mtime newer than a given time and prints out their pathname. Use e2scan to efficiently generate lists of files that have been modified. The e2scan tool is included in the e2fsprogs package, located at:</para>
-    <para><link xl:href="http://downloads.whamcloud.com/public/e2fsprogs/latest/">http://downloads.whamcloud.com/public/e2fsprogs/latest/</link></para>
+    <para>
+    <link xl:href="https://downloads.whamcloud.com/public/e2fsprogs/latest/">
+      https://downloads.whamcloud.com/public/e2fsprogs/latest/</link></para>
     <section remap="h5">
       <title>Synopsis</title>
       <screen>e2scan [options] [-f file] block_device</screen>
@@ -191,8 +194,10 @@ l_getidentity</title>
     </section>
     <section remap="h5">
       <title>Files</title>
-      <para>The l_getidentity files are located at:</para>
-      <screen>/proc/fs/lustre/mdt/${FSNAME}-MDT{xxxx}/identity_upcall</screen>
+      <para>The parameter to set the <literal>l_getidentity</literal> path is:
+      </para>
+<screen>mds# lctl set_param -P mdt.*-MDT*.identity_upcall=<replaceable>path</replaceable>
+</screen>
     </section>
   </section>
   <section xml:id="dbdoclet.50438219_38274">
@@ -218,15 +223,32 @@ quit</screen>
     </section>
     <section remap="h5">
       <title>Setting Parameters with lctl</title>
-      <para>Lustre parameters are not always accessible using the procfs interface, as it is platform-specific. As a solution, lctl {get,set}_param has been introduced as a platform-independent interface to the Lustre tunables. Avoid direct references to /proc/{fs,sys}/{lustre,lnet}. For future portability, use lctl {get,set}_param .</para>
-      <para>When the file system is running, use the <literal>lctl set_param</literal> command on the affected node(s) to <emphasis>temporarily</emphasis> set parameters (mapping to items in /proc/{fs,sys}/{lnet,lustre}). The <literal>lctl set_param</literal> command uses this syntax:</para>
+      <para>Lustre parameters are not always accessible using the procfs
+      interface, as it is platform-specific. As a solution,
+      <literal>lctl {get,set}_param</literal> provides a platform-independent
+      interface to the Lustre tunables. Avoid any direct references to
+      <literal>/proc</literal> and <literal>/sys</literal> files in scripts.
+      For future portability, instead use lctl {get,set}_param, which handles
+      these details internally.</para>
+      <para>When the file system is running, use the
+      <literal>lctl set_param</literal> command on the affected node(s) to
+      <emphasis>temporarily</emphasis> set parameters (mapping to items in).
+      The <literal>lctl set_param</literal> command uses this syntax:</para>
       <screen>lctl set_param [-n] [-P] [-d] <replaceable>obdtype.obdname.property</replaceable>=<replaceable>value</replaceable></screen>
       <para>For example:</para>
-      <screen>mds# lctl set_param mdt.testfs-MDT0000.identity_upcall=NONE</screen>
-      <para condition='l25'>Use <literal>-P</literal> option to set parameters permanently. Option <literal>-d </literal>deletes permanent parameters. For example:
-             <screen>mgs# lctl set_param -P mdt.testfs-MDT0000.identity_upcall=NONE
+<screen>mds# lctl set_param mdt.testfs-MDT0000.identity_upcall=NONE</screen>
+      <para condition='l25'>Use <literal>-P</literal> option to set parameters
+      permanently. Option <literal>-d </literal>deletes permanent parameters.
+      For example:
+<screen>
+mgs# lctl set_param -P mdt.testfs-MDT0000.identity_upcall=NONE
 mgs# lctl set_param -P -d mdt.testfs-MDT0000.identity_upcall</screen></para>
-      <para>Many permanent parameters can be set with <literal>lctl conf_param</literal>. In general, <literal>lctl conf_param</literal> can be used to specify any OBD device parameter settable in a /proc/fs/lustre file. The <literal>lctl conf_param</literal> command must be run on the MGS node, and uses this syntax:</para>
+      <para>Many permanent parameters can be set with the
+      <literal>lctl conf_param</literal> utility. In general,
+      <literal>lctl conf_param</literal> can be used to specify any OBD
+      device parameter settable in a /proc/fs/lustre file. The
+      <literal>lctl conf_param</literal> command must be run on the MGS node,
+      and uses this syntax:</para>
       <screen><replaceable>obd|fsname</replaceable>.obdtype.property=<replaceable>value</replaceable>) </screen>
       <para>For example:</para>
       <screen>mgs# lctl conf_param testfs-MDT0000.mdt.identity_upcall=NONE
@@ -773,16 +795,18 @@ lctl &gt; quit</screen>
       <title>See Also</title>
       <itemizedlist>
         <listitem>
-          <para> <xref linkend="dbdoclet.50438219_75432"/> </para>
+          <para> <xref linkend="mkfs.lustre"/>
+          </para>
         </listitem>
         <listitem>
-          <para> <xref linkend="dbdoclet.50438219_12635"/> </para>
+          <para> <xref linkend="mount.lustre"/>
+          </para>
         </listitem>
         <listitem>
           <para> <xref linkend="dbdoclet.50438219_38274"/> </para>
         </listitem>
         <listitem>
-          <para> <xref linkend="dbdoclet.50438206_94597"/> </para>
+          <para> <xref linkend="userutilities.lfs"/> </para>
         </listitem>
       </itemizedlist>
     </section>
@@ -809,7 +833,7 @@ ll_decode_filter_fid</title>
         and is not accessed or modified by Lustre after that time.</para>
       <para>The OST object ID (objid) may be useful in case of OST directory
         corruption, though LFSCK can normally reconstruct the entire OST object
-       directory tree, see <xref linkend="dbdoclet.lfsckadmin" /> for details.
+        directory tree, see <xref linkend="dbdoclet.lfsckadmin" /> for details.
         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
@@ -900,7 +924,7 @@ llog_reader /tmp/tfs-client</screen>
     </section>
     <section remap="h5">
       <title>See Also</title>
-      <para><xref linkend="dbdoclet.50438219_39574"/></para>
+      <para><xref linkend="tunefs.lustre"/></para>
     </section>
   </section>
   <section xml:id="dbdoclet.50438219_23232">
@@ -1435,10 +1459,10 @@ Changelog records consumed: 42</screen>
     </section>
     <section remap="h5">
       <title>See Also</title>
-      <para><xref linkend="dbdoclet.50438206_94597"/></para>
+      <para><xref linkend="userutilities.lfs"/></para>
     </section>
   </section>
-  <section xml:id="dbdoclet.50438219_75432">
+  <section xml:id="mkfs.lustre">
     <title><indexterm><primary>mkfs.lustre</primary></indexterm>
 mkfs.lustre</title>
     <para>The <literal>mkfs.lustre</literal> utility formats a disk for a Lustre service.</para>
@@ -1556,12 +1580,15 @@ mkfs.lustre</title>
               </entry>
             </row>
             <row>
-              <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
+              <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="failover_setup"/> for
                 more details.</entry>
             </row>
             <row>
@@ -1572,11 +1599,12 @@ mkfs.lustre</title>
                 <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"/>
+                    xmlns:xlink="http://www.w3.org/1999/xlink"
+                    linkend="failover_setup"/>
                   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>
+                        linkend="failover_setup"/>).</para>
                   </note></para>
               </entry>
             </row>
@@ -1748,18 +1776,22 @@ mkfs.lustre</title>
       <title>See Also</title>
       <itemizedlist>
         <listitem>
-          <para><xref linkend="dbdoclet.50438219_75432"/>mkfs.lustre, </para>
+          <para>
+            <xref linkend="mkfs.lustre"/>
+            mkfs.lustre, </para>
         </listitem>
         <listitem>
-          <para><xref linkend="dbdoclet.50438219_12635"/>mount.lustre, </para>
+          <para>
+            <xref linkend="mount.lustre"/>
+            mount.lustre, </para>
         </listitem>
         <listitem>
-          <para><xref linkend="dbdoclet.50438206_94597"/>lfs</para>
+          <para><xref linkend="userutilities.lfs"/>lfs</para>
         </listitem>
       </itemizedlist>
     </section>
   </section>
-  <section xml:id="dbdoclet.50438219_12635">
+  <section xml:id="mount.lustre">
     <title><indexterm><primary>mount.lustre</primary></indexterm>
 mount.lustre</title>
     <para>The mount.lustre utility starts a Lustre client or target service.</para>
@@ -2239,16 +2271,17 @@ mount.lustre</title>
       <title>See Also</title>
       <itemizedlist>
         <listitem>
-          <para>  <xref linkend="dbdoclet.50438219_75432"/></para>
+          <para><xref linkend="mkfs.lustre"/>
+         </para>
         </listitem>
         <listitem>
-          <para>  <xref linkend="dbdoclet.50438219_39574"/></para>
+          <para>  <xref linkend="tunefs.lustre"/></para>
         </listitem>
         <listitem>
           <para>  <xref linkend="dbdoclet.50438219_38274"/></para>
         </listitem>
         <listitem>
-          <para>  <xref linkend="dbdoclet.50438206_94597"/></para>
+          <para>  <xref linkend="userutilities.lfs"/></para>
         </listitem>
       </itemizedlist>
     </section>
@@ -2485,7 +2518,7 @@ M   0( 13) E 0 S    7.00/     7 R    0.00/    14 F    0.00/     0 D 0.00/0
       <screen>/proc/sys/lnet/stats</screen>
     </section>
   </section>
-  <section xml:id="dbdoclet.50438219_39574">
+  <section xml:id="tunefs.lustre">
     <title><indexterm><primary>tunefs.lustre</primary></indexterm>
 tunefs.lustre</title>
     <para>The tunefs.lustre utility modifies configuration information on a Lustre target disk.</para>
@@ -2551,8 +2584,9 @@ tunefs.lustre</title>
                 <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
+                  <literal>--failnode</literal> option. See
+                  <xref xmlns:xlink="http://www.w3.org/1999/xlink"
+                   linkend="failover_setup"/> for
                 more details.</entry>
             </row>
             <row>
@@ -2560,15 +2594,16 @@ tunefs.lustre</title>
                 <para> <literal>--failnode=<replaceable>nid,...</replaceable></literal></para>
               </entry>
               <entry>
-                <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>
+                <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="failover_setup"/> 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="failover_setup"/>).</para></note>
+                </para>
               </entry>
             </row>
             <row>
@@ -2696,16 +2731,18 @@ tunefs.lustre</title>
       <title>See Also</title>
       <itemizedlist>
         <listitem>
-          <para><xref linkend="dbdoclet.50438219_75432"/></para>
+          <para><xref linkend="mkfs.lustre"/>
+          </para>
         </listitem>
         <listitem>
-          <para><xref linkend="dbdoclet.50438219_12635"/></para>
+          <para><xref linkend="mount.lustre"/>
+          </para>
         </listitem>
         <listitem>
           <para><xref linkend="dbdoclet.50438219_38274"/></para>
         </listitem>
         <listitem>
-          <para><xref linkend="dbdoclet.50438206_94597"/></para>
+          <para><xref linkend="userutilities.lfs"/></para>
         </listitem>
       </itemizedlist>
     </section>
@@ -2722,21 +2759,20 @@ Application Profiling Utilities</title>
       <para>The lustre_req_history.sh utility (run from a client), assembles as much Lustre RPC request history as possible from the local node and from the servers that were contacted, providing a better picture of the coordinated network activity.</para>
     </section>
     <section remap="h3">
-      <title>More /proc Statistics for Application Profiling</title>
+      <title>More Statistics for Application Profiling</title>
       <para>The following utilities provide additional statistics.</para>
       <para><literal>vfs_ops_stats</literal></para>
-      <para>The client vfs_ops_stats utility tracks Linux VFS operation calls into Lustre for a single PID, PPID, GID or everything.</para>
-      <screen>/proc/fs/lustre/llite/*/vfs_ops_stats
-/proc/fs/lustre/llite/*/vfs_track_[pid|ppid|gid]
-</screen>
+      <para>The client vfs_ops_stats utility tracks Linux VFS operation calls
+      into Lustre for a single PID, PPID, GID or everything.</para>
+      <screen>llite.*.vfs_ops_stats llite.*.vfs_track_[pid|ppid|gid]</screen>
       <para><literal>extents_stats</literal></para>
-      <para>The client extents_stats utility shows the size distribution of I/O calls from the client (cumulative and by process).</para>
-      <screen>/proc/fs/lustre/llite/*/extents_stats, extents_stats_per_process
-</screen>
+      <para>The client extents_stats utility shows the size distribution of
+      I/O calls from the client (cumulative and by process).</para>
+      <screen>llite.*.{extents_stats,extents_stats_per_process}</screen>
       <para><literal>offset_stats</literal></para>
-      <para>The client offset_stats utility shows the read/write seek activity of a client by offsets and ranges.</para>
-      <screen>/proc/fs/lustre/llite/*/offset_stats
-</screen>
+      <para>The client offset_stats utility shows the read/write seek activity
+      of a client by offsets and ranges.</para>
+      <screen>llite.*.offset_stats</screen>
       <para>Lustre includes per-client and improved MDT statistics:</para>
       <itemizedlist>
         <listitem>
@@ -2746,7 +2782,7 @@ Application Profiling Utilities</title>
       <para>Each MDS and OSS now tracks LDLM and operations statistics for
       every connected client, for comparisons and simpler collection of
       distributed job statistics.</para>
-      <screen>/proc/fs/lustre/mds|obdfilter/*/exports/
+      <screen>{mds,obdfilter}.*.exports
 </screen>
       <itemizedlist>
         <listitem>
@@ -2755,7 +2791,7 @@ Application Profiling Utilities</title>
       </itemizedlist>
       <para>More detailed MDT operations statistics are collected for better
       profiling.</para>
-      <screen>/proc/fs/lustre/mdt/*/md_stats
+      <screen>mdt.*.md_stats
 </screen>
     </section>
     <section remap="h3">
@@ -2878,3 +2914,6 @@ fid2path: error on FID [0x200000400:0x2:0x0]: No such file or directory</screen>
     </section>
   </section>
 </chapter>
+<!--
+  vim:expandtab:shiftwidth=2:tabstop=8:
+  -->