InstallingLustre.xml

   1 <?xml version='1.0' encoding='utf-8'?>
   2 <chapter xmlns="http://docbook.org/ns/docbook"
   3 xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US"
   4 xml:id="installinglustre">
   5   <title xml:id="installinglustre.title">Installing the Lustre Software</title>
   6   <para>This chapter describes how to install the Lustre software from RPM
   7   packages. It includes:</para>
   8   <itemizedlist>
   9     <listitem>
  10       <para>
  11         <xref linkend="dbdoclet.50438261_99193" />
  12       </para>
  13     </listitem>
  14     <listitem>
  15       <para>
  16         <xref linkend="dbdoclet.50438261_41900" />
  17       </para>
  18     </listitem>
  19   </itemizedlist>
  20   <para>For hardware and system requirements and hardware configuration
  21   information, see
  22   <xref linkend="settinguplustresystem" />.</para>
  23   <section xml:id="dbdoclet.50438261_99193">
  24     <title>
  25     <indexterm>
  26       <primary>installing</primary>
  27       <secondary>preparation</secondary>
  28     </indexterm>Preparing to Install the Lustre Software</title>
  29     <para>You can install the Lustre software from downloaded packages (RPMs)
  30     or directly from the source code. This chapter describes how to install the
  31     Lustre RPM packages. Instructions to install from source code are beyond
  32     the scope of this document, and can be found elsewhere online.</para>
  33     <para>The Lustre RPM packages have been tested on the Linux distributions
  34     listed in the table below.</para>
  35     <para>
  36       <table frame="all" xml:id="LustreTestMatrixTable">
  37         <title>Lustre Test Matrix</title>
  38         <tgroup cols="3">
  39           <colspec colname="c1" colnum="1" colwidth="1*" />
  40           <colspec colname="c2" colnum="2" colwidth="1.1*" />
  41           <colspec colname="c3" colnum="3" colwidth="1.46*" />
  42           <thead>
  43             <row>
  44               <entry>Lustre Release</entry>
  45               <entry>Servers Tested
  46               <superscript>1</superscript></entry>
  47               <entry>Clients Tested</entry>
  48             </row>
  49           </thead>
  50           <tbody>
  51             <row>
  52               <entry>
  53                 <para>2.0</para>
  54               </entry>
  55               <entry>
  56                 <para>RHEL 5, CentOS 5</para>
  57               </entry>
  58               <entry>
  59                 <para>RHEL 5, CentOS 5, SLES 11 SP0</para>
  60               </entry>
  61             </row>
  62             <row>
  63               <entry>
  64                 <para>2.1.x</para>
  65               </entry>
  66               <entry>
  67                 <para>RHEL 5, CentOS 5, RHEL 6, CentOS 6</para>
  68               </entry>
  69               <entry>
  70                 <para>RHEL 5, CentOS 5, RHEL 6, CentOS 6, SLES 11 SP1</para>
  71               </entry>
  72             </row>
  73             <row>
  74               <entry>
  75                 <para>2.2</para>
  76               </entry>
  77               <entry>
  78                 <para>RHEL 6, CentOS 6</para>
  79               </entry>
  80               <entry>
  81                 <para>RHEL 5, CentOS 5, RHEL 6, CentOS 6, SLES 11 SP1</para>
  82               </entry>
  83             </row>
  84             <row>
  85               <entry>
  86                 <para>2.3</para>
  87               </entry>
  88               <entry>
  89                 <para>RHEL 6.3, CentOS 6.3</para>
  90               </entry>
  91               <entry>
  92                 <para>RHEL 6.3, CentOS 6.3, RHEL 5.8, CentOS 5.8, SLES 11
  93                 SP1</para>
  94               </entry>
  95             </row>
  96             <row>
  97               <entry>2.4.x</entry>
  98               <entry>
  99                 <para>RHEL 6.4, CentOS 6.4</para>
 100               </entry>
 101               <entry>
 102                 <para>RHEL 6.4, CentOS 6.4, SLES 11 SP2, FC18</para>
 103               </entry>
 104             </row>
 105           </tbody>
 106         </tgroup>
 107       </table>
 108     </para>
 109     <para>
 110     <superscript>1</superscript>Red Hat Enterprise Edition (RHEL), CentOS
 111     Enterprise Linux Distribution (CentOS), SUSE Linux Enterprise Server
 112     (SLES), Fedora
 113     <superscript>*</superscript>F18 Linux kernel (FC18).</para>
 114     <section xml:id="section_rqs_tjw_3k">
 115       <title>Software Requirements</title>
 116       <para>To install the Lustre software from RPMs, the following are
 117       required:
 118       <itemizedlist>
 119         <listitem>
 120           <para>
 121           <emphasis role="bold">
 122             <emphasis role="italic">Lustre server packages</emphasis>
 123           </emphasis>. The required packages for Lustre servers are listed in
 124           the table below, where
 125           <replaceable>ver</replaceable>refers to the Linux kernel distribution
 126           (e.g., 2.6.32-358.6.2.el6) and
 127           <replaceable>arch</replaceable>refers to the processor architecture
 128           (e.g., x86_64). These packages are available in the
 129           <link xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">
 130           Lustre Releases</link>repository.</para>
 131           <para>
 132             <table frame="all" xml:id="table_cnh_5m3_gk">
 133               <title>Packages Installed on Lustre Servers</title>
 134               <tgroup cols="2">
 135                 <colspec colname="c1" colnum="1" colwidth="1.18*" />
 136                 <colspec colname="c2" colnum="2" colwidth="1*" />
 137                 <thead>
 138                   <row>
 139                     <entry>Package Name</entry>
 140                     <entry>Description</entry>
 141                   </row>
 142                 </thead>
 143                 <tbody>
 144                   <row>
 145                     <entry>
 146                       <code>kernel-</code>
 147                       <replaceable>ver</replaceable>
 148                       <code>_lustre.</code>
 149                       <replaceable>arch</replaceable>
 150                     </entry>
 151                     <entry>Linux kernel with Lustre software patches (often
 152                     referred to as "patched kernel")</entry>
 153                   </row>
 154                   <row>
 155                     <entry>
 156                       <code>lustre-</code>
 157                       <replaceable>ver</replaceable>
 158                       <code>_lustre.</code>
 159                       <replaceable>arch</replaceable>
 160                     </entry>
 161                     <entry>Lustre software command line tools</entry>
 162                   </row>
 163                   <row>
 164                     <entry>
 165                       <code>lustre-modules-</code>
 166                       <replaceable>ver</replaceable>
 167                       <code>_lustre.</code>
 168                       <replaceable>arch</replaceable>
 169                     </entry>
 170                     <entry>Lustre-patched kernel modules</entry>
 171                   </row>
 172                   <row>
 173                     <entry>
 174                       <code>lustre-osd-ldiskfs-</code>
 175                       <replaceable>ver</replaceable>
 176                       <code>_lustre.</code>
 177                       <replaceable>arch</replaceable>
 178                     </entry>
 179                     <entry>Lustre back-end file system tools</entry>
 180                   </row>
 181                   <row>
 182                     <entry>
 183                       <code>lustre-zfs-ldiskfs-</code>
 184                       <replaceable>ver</replaceable>
 185                       <code>_lustre.</code>
 186                       <replaceable>arch</replaceable>
 187                     </entry>
 188                     <entry>Lustre back-end file system tools for ZFS. This is
 189                     an alternative to
 190                     <literal>lustre-osd-ldiskfs</literal></entry>
 191                   </row>
 192                   <row>
 193                     <entry>
 194                       <code>e2fsprogs</code>
 195                     </entry>
 196                     <entry>Utility to maintain Lustre back-end file
 197                     system</entry>
 198                   </row>
 199                   <row>
 200                     <entry>
 201                       <code>lustre-tests-</code>
 202                       <replaceable>ver</replaceable>
 203                       <code>_lustre.</code>
 204                       <replaceable>arch</replaceable>
 205                     </entry>
 206                     <entry>Lustre I/O Kit benchmarking tools
 207                     <emphasis role="italic">(Included in Lustre software as of
 208                     release 2.2)</emphasis></entry>
 209                   </row>
 210                 </tbody>
 211               </tgroup>
 212             </table>
 213           </para>
 214         </listitem>
 215         <listitem>
 216           <para>
 217           <emphasis role="bold">
 218             <emphasis role="italic">Lustre client packages</emphasis>
 219           </emphasis>. The required packages for Lustre clients are listed in
 220           the table below, where
 221           <replaceable>ver</replaceable>refers to the Linux distribution (e.g.,
 222           2.6.18-348.1.1.el5). These packages are available in the
 223           <link xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">
 224           Lustre Releases</link>repository.</para>
 225           <para>
 226             <table frame="all" xml:id="table_j3r_ym3_gk">
 227               <title>Packages Installed on Lustre Clients</title>
 228               <tgroup cols="2">
 229                 <colspec colname="c1" colnum="1" colwidth="1*" />
 230                 <colspec colname="c2" colnum="2" colwidth="1.02*" />
 231                 <thead>
 232                   <row>
 233                     <entry>Package Name</entry>
 234                     <entry>Description</entry>
 235                   </row>
 236                 </thead>
 237                 <tbody>
 238                   <row>
 239                     <entry>
 240                       <code>lustre-client-modules-</code>
 241                       <replaceable>ver</replaceable>
 242                     </entry>
 243                     <entry>Patchless kernel modules for client</entry>
 244                   </row>
 245                   <row>
 246                     <entry>
 247                       <code>lustre-client-</code>
 248                       <replaceable>ver</replaceable>
 249                       <code>_lustre</code>
 250                     </entry>
 251                     <entry>Client command line tools</entry>
 252                   </row>
 253                   <row>
 254                     <entry>
 255                       <code>lustre-client-tests-</code>
 256                       <replaceable>ver</replaceable>
 257                     </entry>
 258                     <entry>Lustre I/O Kit
 259                     <emphasis role="italic">(Included in Lustre software as of
 260                     release 2.2)</emphasis></entry>
 261                   </row>
 262                 </tbody>
 263               </tgroup>
 264             </table>
 265           </para>
 266           <note>
 267             <para>The version of the kernel running on a Lustre client must be
 268             the same as the version of the
 269             <code>lustre-client-modules-</code>
 270             <replaceable>ver</replaceable>package being installed. If the
 271             kernel running on the client is not compatible, a kernel that is
 272             compatible must be installed on the client before the Lustre file
 273             system software is installed.</para>
 274           </note>
 275         </listitem>
 276         <listitem>
 277           <para>
 278           <emphasis role="bold">
 279             <emphasis role="italic">Lustre LNET network driver (LND)</emphasis>
 280           </emphasis>. The Lustre LNDs provided with the Lustre software are
 281           listed in the table below. For more information about Lustre LNET,
 282           see
 283           <xref xmlns:xlink="http://www.w3.org/1999/xlink"
 284           linkend="understandinglustrenetworking" />.</para>
 285           <table frame="all" xml:id="table_bkx_dn3_gk">
 286             <title>Network Types Supported by Lustre LNDs</title>
 287             <tgroup cols="2">
 288               <colspec colname="c1" colnum="1" colwidth="1*" />
 289               <colspec colname="newCol2" colnum="2" colwidth="1.95*" />
 290               <thead>
 291                 <row>
 292                   <entry>Supported Network Types</entry>
 293                   <entry>Notes</entry>
 294                 </row>
 295               </thead>
 296               <tbody>
 297                 <row>
 298                   <entry>TCP</entry>
 299                   <entry>Any network carrying TCP traffic, including GigE,
 300                   10GigE, and IPoIB</entry>
 301                 </row>
 302                 <row>
 303                   <entry>InfiniBand network</entry>
 304                   <entry>OpenFabrics OFED (o2ib)</entry>
 305                 </row>
 306                 <row>
 307                   <entry>gni</entry>
 308                   <entry>Gemini (Cray)</entry>
 309                 </row>
 310                 <row>
 311                   <entry>Seastar</entry>
 312                   <entry>Cray</entry>
 313                 </row>
 314                 <row>
 315                   <entry>MX</entry>
 316                   <entry>Myrinet network</entry>
 317                 </row>
 318                 <row>
 319                   <entry>ra</entry>
 320                   <entry>RapidArray
 321                   <superscript>*</superscript>interconnect</entry>
 322                 </row>
 323                 <row>
 324                   <entry>Elan</entry>
 325                   <entry>Quadrics</entry>
 326                 </row>
 327               </tbody>
 328             </tgroup>
 329           </table>
 330         </listitem>
 331       </itemizedlist></para>
 332       <para>
 333         <note>
 334           <para>The InfiniBand and TCP Lustre LNDs are routinely tested during
 335           release cycles. The other LNDs are maintained by their respective
 336           owners</para>
 337         </note>
 338         <itemizedlist>
 339           <listitem>
 340             <para>
 341             <emphasis role="bold">
 342               <emphasis role="italic">High availability software</emphasis>
 343             </emphasis>. If needed, install third party high-availability
 344             software. For more information, see
 345             <xref linkend="dbdoclet.50438188_92688" />.</para>
 346           </listitem>
 347           <listitem>
 348             <para>
 349             <emphasis role="bold">
 350               <emphasis role="italic">Optional packages.</emphasis>
 351             </emphasis>Optional packages provided in the
 352             <link xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">
 353             Lustre Releases</link>repository may include the following
 354             (depending on the operating system and platform):
 355             <itemizedlist>
 356               <listitem>
 357                 <para>
 358                 <code>kernel-debuginfo</code>,
 359                 <code>kernel-debuginfo-common</code>,
 360                 <code>lustre-debuginfo</code>,
 361                 <code>lustre-osd-ldiskfs-debuginfo</code>- Versions of required
 362                 packages with debugging symbols and other debugging options
 363                 enabled for use in troubleshooting.</para>
 364               </listitem>
 365               <listitem>
 366                 <para>
 367                 <code>kernel-devel</code>, - Portions of the kernel tree needed
 368                 to compile third party modules, such as network drivers.</para>
 369               </listitem>
 370               <listitem>
 371                 <para>
 372                 <code>kernel-firmware</code>- Standard Red Hat Enterprise Linux
 373                 distribution that has been recompiled to work with the Lustre
 374                 kernel.</para>
 375               </listitem>
 376               <listitem>
 377                 <para>
 378                 <code>kernel-headers</code>- Header files installed under
 379                 /user/include and used when compiling user-space,
 380                 kernel-related code.</para>
 381               </listitem>
 382               <listitem>
 383                 <para>
 384                 <code>lustre-source</code>- Lustre software source code.</para>
 385               </listitem>
 386               <listitem>
 387                 <para>
 388                 <emphasis role="italic">(Recommended)</emphasis>
 389                 <code>perf</code>,
 390                 <code>perf-debuginfo</code>,
 391                 <code>python-perf</code>,
 392                 <code>python-perf-debuginfo</code>- Linux performance analysis
 393                 tools that have been compiled to match the Lustre kernel
 394                 version.</para>
 395               </listitem>
 396             </itemizedlist></para>
 397           </listitem>
 398         </itemizedlist>
 399       </para>
 400     </section>
 401     <section xml:id="section_rh2_d4w_gk">
 402       <title>Environmental Requirements</title>
 403       <para>Before installing the Lustre software, make sure the following
 404       environmental requirements are met.
 405       <itemizedlist>
 406         <listitem>
 407           <para>
 408           <emphasis role="italic">(Required)</emphasis>
 409           <emphasis role="italic">
 410             <emphasis role="bold">Disable Security-Enhanced Linux
 411             <superscript>*</superscript>(SELinux) on all Lustre servers and
 412             clients.</emphasis>
 413           </emphasis>The Lustre software does not support SELinux. Therefore,
 414           the SELinux system extension must be disabled on all Lustre nodes.
 415           Also, make sure other security extensions (such as the Novell
 416           AppArmor
 417           <superscript>*</superscript>security system) and network packet
 418           filtering tools (such as iptables) do not interfere with the Lustre
 419           software.</para>
 420         </listitem>
 421         <listitem>
 422           <para>
 423           <emphasis role="italic">(Required)</emphasis>
 424           <emphasis role="italic">
 425             <emphasis role="bold">Use the same user IDs (UID) and group IDs
 426             (GID) on all clients.</emphasis>
 427           </emphasis>If use of supplemental groups is required, see
 428           <xref linkend="dbdoclet.50438291_32926" />for information about
 429           supplementary user and group cache upcall (
 430           <code>identity_upcall</code>).</para>
 431         </listitem>
 432         <listitem>
 433           <para>
 434           <emphasis role="italic">(Recommended)</emphasis>
 435           <emphasis role="italic">
 436             <emphasis role="bold">Provide remote shell access to
 437             clients.</emphasis>
 438           </emphasis>It is recommended that all cluster nodes have remote shell
 439           client access to facilitate the use of Lustre configuration and
 440           monitoring scripts. Parallel Distributed SHell (pdsh) is preferable,
 441           although Secure SHell (SSH) is acceptable.</para>
 442         </listitem>
 443         <listitem>
 444           <para>
 445           <emphasis role="italic">(Recommended)</emphasis>
 446           <emphasis role="italic">
 447             <emphasis role="bold">Ensure client clocks are
 448             synchronized.</emphasis>
 449           </emphasis>The Lustre file system uses client clocks for timestamps.
 450           If clocks are out of sync between clients, files will appear with
 451           different time stamps when accessed by different clients. Drifting
 452           clocks can also cause problems by, for example, making it difficult
 453           to debug multi-node issues or correlate logs, which depend on
 454           timestamps. We recommend that you use Network Time Protocol (NTP) to
 455           keep client and server clocks in sync with each other. For more
 456           information about NTP, see:
 457           <link xl:href="http://www.ntp.org/">http://www.ntp.org</link>.</para>
 458         </listitem>
 459       </itemizedlist></para>
 460     </section>
 461   </section>
 462   <section xml:id="dbdoclet.50438261_41900">
 463     <title>Lustre Software Installation Procedure</title>
 464     <caution>
 465       <para>Before installing the Lustre software, back up ALL data. The Lustre
 466       software contains kernel modifications that interact with storage devices
 467       and may introduce security issues and data loss if not installed,
 468       configured, or administered properly.</para>
 469     </caution>
 470     <para>To install the Lustre software from RPMs, complete the steps
 471     below.</para>
 472     <orderedlist>
 473       <listitem>
 474         <para>Verify that all Lustre installation requirements have been
 475         met.</para>
 476         <itemizedlist>
 477           <listitem>
 478             <para>For hardware requirements, see
 479             <xref linkend="settinguplustresystem" />.</para>
 480           </listitem>
 481           <listitem>
 482             <para>For software and environmental requirements, see the section
 483             <xref xmlns:xlink="http://www.w3.org/1999/xlink"
 484             linkend="dbdoclet.50438261_99193" />above.</para>
 485           </listitem>
 486         </itemizedlist>
 487       </listitem>
 488       <listitem>
 489         <para>Download the
 490         <literal>e2fsprogs</literal> RPMs for your platform from the
 491         <link xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">
 492         Lustre Releases</link>repository.</para>
 493       </listitem>
 494       <listitem>
 495         <para>Download the Lustre server RPMs for your platform from the
 496         <link xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">
 497         Lustre Releases</link>repository. See
 498         <xref xmlns:xlink="http://www.w3.org/1999/xlink"
 499         linkend="table_cnh_5m3_gk" />for a list of required packages.</para>
 500       </listitem>
 501       <listitem xml:id="dbdoclet.50438261_88296">
 502         <para>Install the Lustre server and
 503         <literal>e2fsprogs</literal> packages on all Lustre servers (MGS, MDSs,
 504         and OSSs).
 505         <orderedlist numeration="loweralpha">
 506           <listitem>
 507             <para>Log onto a Lustre server as the
 508             <literal>root</literal> user</para>
 509           </listitem>
 510           <listitem>
 511             <para>Use the
 512             <literal>yum</literal> command to install the packages:</para>
 513             <para>
 514               <screen>
 515 # yum --nogpgcheck install pkg1.rpm pkg2.rpm ...
 516 </screen>
 517             </para>
 518           </listitem>
 519           <listitem>
 520             <para>Verify the packages are installed correctly:</para>
 521             <para>
 522               <screen>
 523 rpm -qa|egrep "lustre|wc"|sort
 524 </screen>
 525             </para>
 526           </listitem>
 527           <listitem>
 528             <para>Reboot the server.</para>
 529           </listitem>
 530           <listitem>
 531             <para>Repeat these steps on each Lustre server.</para>
 532           </listitem>
 533         </orderedlist></para>
 534       </listitem>
 535       <listitem>
 536         <para>Download the Lustre client RPMs for your platform from the
 537         <link xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">
 538         Lustre Releases</link>repository. See
 539         <xref xmlns:xlink="http://www.w3.org/1999/xlink"
 540         linkend="table_j3r_ym3_gk" />for a list of required packages.</para>
 541       </listitem>
 542       <listitem>
 543         <para>Install the Lustre client packages on all Lustre clients.
 544         <note>
 545           <para>The version of the kernel running on a Lustre client must be
 546           the same as the version of the
 547           <literal>lustre-client-modules-</literal>
 548           <replaceable>ver</replaceable>package being installed. If not, a
 549           compatible kernel must be installed on the client before the Lustre
 550           client packages are installed.</para>
 551         </note></para>
 552         <orderedlist numeration="loweralpha">
 553           <listitem>
 554             <para>Log onto a Lustre client as the root user.</para>
 555           </listitem>
 556           <listitem>
 557             <para>Use the
 558             <literal>yum</literal> command to install the packages:</para>
 559             <para>
 560               <screen>
 561 # yum --nogpgcheck install pkg1.rpm pkg2.rpm ...
 562 </screen>
 563             </para>
 564           </listitem>
 565           <listitem>
 566             <para>Verify the packages were installed correctly:</para>
 567             <para>
 568               <screen>
 569 # rpm -qa|egrep "lustre|kernel"|sort
 570 </screen>
 571             </para>
 572           </listitem>
 573           <listitem>
 574             <para>Reboot the client.</para>
 575           </listitem>
 576           <listitem>
 577             <para>Repeat these steps on each Lustre client.</para>
 578           </listitem>
 579         </orderedlist>
 580       </listitem>
 581     </orderedlist>
 582     <para>To configure LNET, go to
 583     <xref linkend="configuringlnet" />. If default settings will be used for
 584     LNET, go to
 585     <xref linkend="configuringlustre" />.</para>
 586   </section>
 587 </chapter>