Whamcloud - gitweb
LUDOC-321 style: ensure ID attributes are unique.
[doc/manual.git] / ManagingLNET.xml
index c231361..a9843b6 100644 (file)
@@ -1,7 +1,7 @@
-<?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="managinglnet">
+<?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="managinglnet">
   <title xml:id="managinglnet.title">Managing Lustre Networking (LNET)</title>
-  <para>This chapter describes some tools for managing Lustre Networking (LNET) and includes the following sections:</para>
+  <para>This chapter describes some tools for managing Lustre networking (LNET) and includes the
+    following sections:</para>
   <itemizedlist>
     <listitem>
       <para><xref linkend="dbdoclet.50438203_51732"/></para>
@@ -15,6 +15,9 @@
     <listitem>
       <para><xref linkend="dbdoclet.50438203_78227"/></para>
     </listitem>
+    <listitem>
+      <para><xref linkend="managinglnet.configuringroutes"/></para>
+    </listitem>
   </itemizedlist>
   <section xml:id="dbdoclet.50438203_51732">
       <title><indexterm><primary>LNET</primary><secondary>management</secondary></indexterm>
@@ -43,7 +46,9 @@
   </section>
   <section xml:id="dbdoclet.50438203_48703">
       <title><indexterm><primary>LNET</primary><secondary>starting/stopping</secondary></indexterm>Starting and Stopping LNET</title>
-    <para>Lustre automatically starts and stops LNET, but it can also be manually started in a standalone manner. This is particularly useful to verify that your networking setup is working correctly before you attempt to start Lustre.</para>
+    <para>The Lustre software automatically starts and stops LNET, but it can also be manually
+      started in a standalone manner. This is particularly useful to verify that your networking
+      setup is working correctly before you attempt to start the Lustre file system.</para>
     <section remap="h3">
       <title>Starting LNET</title>
       <para>To start LNET, run:</para>
@@ -51,7 +56,8 @@
 $ lctl network up</screen>
       <para>To see the list of local NIDs, run:</para>
       <screen>$ lctl list_nids</screen>
-      <para>This command tells you the network(s) configured to work with Lustre</para>
+      <para>This command tells you the network(s) configured to work with the Lustre file
+        system.</para>
       <para>If the networks are not correctly setup, see the <literal>modules.conf</literal> &quot;<literal>networks=</literal>&quot; line and make sure the network layer modules are correctly installed and configured.</para>
       <para>To get the best remote NID, run:</para>
       <screen>$ lctl which_nid <replaceable>NIDs</replaceable></screen>
@@ -67,10 +73,15 @@ $ lctl network up</screen>
     </section>
     <section remap="h3">
       <title>Stopping LNET</title>
-      <para>Before the LNET modules can be removed, LNET references must be removed. In general, these references are removed automatically when Lustre is shut down, but for standalone routers, an explicit step is needed to stop LNET. Run:</para>
+      <para>Before the LNET modules can be removed, LNET references must be removed. In general,
+        these references are removed automatically when the Lustre file system is shut down, but for
+        standalone routers, an explicit step is needed to stop LNET. Run:</para>
       <screen>lctl network unconfigure</screen>
       <note>
-        <para>Attempting to remove Lustre modules prior to stopping the network may result in a crash or an LNET hang. if this occurs, the node must be rebooted (in most cases). Make sure that the Lustre network and Lustre are stopped prior to unloading the modules. Be extremely careful using rmmod -f.</para>
+        <para>Attempting to remove Lustre modules prior to stopping the network may result in a
+          crash or an LNET hang. If this occurs, the node must be rebooted (in most cases). Make
+          sure that the Lustre network and Lustre file system are stopped prior to unloading the
+          modules. Be extremely careful using <literal>rmmod -f</literal>.</para>
       </note>
       <para>To unconfigure the LNET network, run:</para>
       <screen>modprobe -r <replaceable>lnd_and_lnet_modules</replaceable></screen>
@@ -91,11 +102,15 @@ To remove all Lustre modules, run:</para>
         <para>LNET can work with multiple rails, however, it does not load balance across them. The actual rail used for any communication is determined by the peer NID.</para>
       </listitem>
       <listitem>
-        <para>Multi-rail LNET configurations do not provide an additional level of network fault tolerance. The configurations described below are for bandwidth aggregation only. Network interface failover is planned as an upcoming Lustre feature.</para>
+        <para>Multi-rail LNET configurations do not provide an additional level of network fault
+          tolerance. The configurations described below are for bandwidth aggregation only. </para>
       </listitem>
       <listitem>
         <para>A Lustre node always uses the same local NID to communicate with a given peer NID. The criteria used to determine the local NID are:</para>
         <itemizedlist>
+          <listitem>
+            <para condition='l25'>Lowest route priority number (lower number, higher priority).</para>
+          </listitem>
           <listitem>
             <para>Fewest hops (to minimize routing), and</para>
           </listitem>
@@ -107,8 +122,13 @@ To remove all Lustre modules, run:</para>
     </itemizedlist>
   </section>
   <section xml:id="dbdoclet.50438203_78227">
-    <title><indexterm><primary>LNET</primary><secondary>Infiniband load balancing</secondary></indexterm>Load Balancing with InfiniBand</title>
-    <para>A Lustre file system contains OSSs with two InfiniBand HCAs. Lustre clients have only one InfiniBand HCA using OFED Infiniband &apos;&apos;o2ib&apos;&apos; drivers. Load balancing between the HCAs on the OSS is accomplished through LNET.</para>
+    <title><indexterm>
+        <primary>LNET</primary>
+        <secondary>InfiniBand load balancing</secondary>
+      </indexterm>Load Balancing with an InfiniBand<superscript>*</superscript> Network</title>
+    <para>A Lustre file system contains OSSs with two InfiniBand HCAs. Lustre clients have only one
+      InfiniBand HCA using OFED-based Infiniband &apos;&apos;o2ib&apos;&apos; drivers. Load
+      balancing between the HCAs on the OSS is accomplished through LNET.</para>
     <section remap="h3">
       <title><indexterm><primary>LNET</primary><secondary>lustre.conf</secondary></indexterm>Setting Up <literal>lustre.conf</literal> for Load Balancing</title>
       <para>To configure LNET for load balancing on clients and servers:</para>
@@ -121,20 +141,19 @@ To remove all Lustre modules, run:</para>
               <para>Dual HCA OSS server</para>
             </listitem>
           </itemizedlist>
-          <screen>options lnet networks=&quot;o2ib0(ib0),o2ib1(ib1) 192.168.10.1.[101-102] </screen>
+          <screen>options lnet networks="o2ib0(ib0),o2ib1(ib1)"</screen>
           <itemizedlist>
             <listitem>
               <para>Client with the odd IP address</para>
             </listitem>
           </itemizedlist>
-          <screen>options lnet networks=o2ib0(ib0) 192.168.10.[103-253/2] </screen>
+          <screen>options lnet ip2nets="o2ib0(ib0) 192.168.10.[103-253/2]"</screen>
           <itemizedlist>
             <listitem>
               <para>Client with the even IP address</para>
             </listitem>
           </itemizedlist>
-          <screen>options lnet networks=o2ib1(ib0) 192.168.10.[102-254/2]
-</screen>
+          <screen>options lnet ip2nets="o2ib1(ib0) 192.168.10.[102-254/2]"</screen>
         </listitem>
         <listitem>
           <para>Run the modprobe lnet command and create a combined MGS/MDT file system.</para>
@@ -162,7 +181,8 @@ oss# mount -t lustre mgs@o2ib0:/lustre /mnt/ost0</screen>
 192.168.10.101@o2ib0,192.168.10.102@o2ib1:/mds/client /mnt/lustre</screen>
         </listitem>
       </orderedlist>
-      <para>As an example, consider a two-rail IB cluster running the OFA stack (OFED) with these IPoIB address assignments.</para>
+      <para>As an example, consider a two-rail IB cluster running the OFED stack with these IPoIB
+        address assignments.</para>
       <screen>             ib0                             ib1
 Servers            192.168.0.*                     192.168.1.*
 Clients            192.168.[2-127].*               192.168.[128-253].*</screen>
@@ -204,7 +224,52 @@ ents&quot;</screen>
 #even clients;\
            o2ib1(ib0),o2ib2(ib1)           192.168.[2-253].[1-253/2)       \
 #odd clients&quot;</screen>
-      <para>This configuration includes two additional proxy o2ib networks to work around Lustre&apos;s simplistic NID selection algorithm. It connects &quot;even&quot; clients to &quot;even&quot; servers with <literal>o2ib0</literal> on <literal>rail0</literal>, and &quot;odd&quot; servers with <literal>o2ib3</literal> on <literal>rail1</literal>. Similarly, it connects &quot;odd&quot; clients to &quot;odd&quot; servers with <literal>o2ib1</literal> on <literal>rail0</literal>, and &quot;even&quot; servers with <literal>o2ib2</literal> on <literal>rail1</literal>.</para>
+      <para>This configuration includes two additional proxy o2ib networks to work around the
+        simplistic NID selection algorithm in the Lustre software. It connects &quot;even&quot;
+        clients to &quot;even&quot; servers with <literal>o2ib0</literal> on
+          <literal>rail0</literal>, and &quot;odd&quot; servers with <literal>o2ib3</literal> on
+          <literal>rail1</literal>. Similarly, it connects &quot;odd&quot; clients to
+        &quot;odd&quot; servers with <literal>o2ib1</literal> on <literal>rail0</literal>, and
+        &quot;even&quot; servers with <literal>o2ib2</literal> on <literal>rail1</literal>.</para>
+    </section>
+  </section>
+  <section xml:id="managinglnet.configuringroutes" condition='l24'>
+    <title><indexterm><primary>LNET</primary></indexterm>Dynamically Configuring LNET Routes</title>
+    <para>Two scripts are provided: <literal>lustre/scripts/lustre_routes_config</literal> and <literal>lustre/scripts/lustre_routes_conversion</literal>.</para>
+    <para><literal>lustre_routes_config</literal> sets or cleans up LNET routes from the specified config file.  <literal>/etc/sysconfig/lustre_routes.conf</literal> file can be used to automatically configure routes on LNET startup. </para>
+    <para><literal>lustre_routes_conversion</literal> converts a legacy routes configuration file to the new syntax, which is parsed by <literal>lustre_routes_config</literal>.</para>
+    <section remap="h3">
+      <title><indexterm><primary>LNET</primary></indexterm><literal>lustre_routes_config</literal></title>
+      <para><literal>lustre_routes_config</literal> usage is as follows</para>
+      <screen><literal>lustre_routes_config [--setup|--cleanup|--dry-run|--verbose] <replaceable>config_file</replaceable></literal>
+         --setup: configure routes listed in config_file
+         --cleanup: unconfigure routes listed in config_file
+         --dry-run: echo commands to be run, but do not execute them
+         --verbose: echo commands before they are executed </screen>
+      <para> The format of the file which is passed into the script is as follows: </para>
+      <para><literal><replaceable>network</replaceable>: { gateway: <replaceable>gateway</replaceable>@<replaceable>exit_network</replaceable> [hop: <replaceable>hop</replaceable>] [priority: <replaceable>priority</replaceable>] }</literal></para>
+      <para> An LNET router is identified when its local NID appears within the list of routes.  However, this can not be achieved by the use of this script, since the script only adds extra routes after the router is identified.  To ensure that a router is identified correctly, make sure to add its local NID in the routes parameter in the modprobe lustre configuration file.  See <xref linkend='dbdoclet.50438293_15350'/>.</para>
+    </section>
+    <section remap="h3">
+      <title><indexterm><primary>LNET</primary></indexterm><literal>lustre_routes_conversion</literal></title>
+      <para><literal>lustre_routes_conversion</literal> usage is as follows:</para>
+      <screen><literal>lustre_routes_conversion <replaceable>legacy_file</replaceable> <replaceable>new_file</replaceable></literal></screen>
+      <para><literal>lustre_routes_conversion</literal> takes as a first parameter a file with routes configured as follows:</para>
+      <para><literal><replaceable>network</replaceable> [<replaceable>hop</replaceable>] <replaceable>gateway</replaceable>@<replaceable>exit network</replaceable>[:<replaceable>priority</replaceable>];</literal></para>
+      <para>The script then converts each routes entry in the provided file to:</para>
+      <para><literal><replaceable>network</replaceable>: { gateway: <replaceable>gateway</replaceable>@<replaceable>exit network</replaceable> [hop: <replaceable>hop</replaceable>] [priority: <replaceable>priority</replaceable>] }</literal></para>
+      <para>and appends each converted entry to the output file passed in as the second parameter to the script.</para>
+    </section>
+    <section remap="h3">
+      <title><indexterm><primary>LNET</primary></indexterm><literal>Route Configuration Examples</literal></title>
+      <para>Below is an example of a legacy LNET route configuration.  A legacy configuration file can have multiple entries.</para>
+      <screen><literal>tcp1 10.1.1.2@tcp0:1;
+tcp2 10.1.1.3@tcp0:2;
+tcp3 10.1.1.4@tcp0;</literal></screen>
+      <para>Below is an example of the converted LNET route configuration.  The following would be the result of the <literal>lustre_routes_conversion</literal> script, when run on the above legacy entries.</para>
+      <screen><literal>tcp1: { gateway: 10.1.1.2@tcp0 priority: 1 }
+tcp2: { gateway: 10.1.1.2@tcp0 priority: 2 }
+tcp1: { gateway: 10.1.1.4@tcp0 }</literal></screen>
     </section>
   </section>
 </chapter>