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