Whamcloud - gitweb
LUDOC-169 large_xattr: Added index entries and notes to enhance large_xattr documenta...
[doc/manual.git] / UpgradingLustre.xml
1 <?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="upgradinglustre">
2   <title xml:id="upgradinglustre.title">Upgrading a Lustre* File System</title>
3   <para>This chapter describes interoperability between Lustre* software releases. It also provides
4     procedures for upgrading from a Lustre 1.8 release to a Lustre 2.x release, from a Lustre 2.x
5     release to a more recent Lustre 2.x release (major release upgrade), and from a Lustre 2.X.y
6     release to 2.X.y (minor release upgrade). It includes the following sections:</para>
7   <itemizedlist>
8     <listitem>
9       <para><xref linkend="dbdoclet.50438205_82079"/></para>
10     </listitem>
11     <listitem>
12       <para><xref xmlns:xlink="http://www.w3.org/1999/xlink" linkend="Upgrading_2.x"/></para>
13     </listitem>
14     <listitem>
15       <para><xref xmlns:xlink="http://www.w3.org/1999/xlink" linkend="Upgrading_2.x.x"/></para>
16     </listitem>
17   </itemizedlist>
18   <section xml:id="dbdoclet.50438205_82079">
19       <title><indexterm>
20         <primary>Lustre</primary>
21         <secondary>upgrading</secondary>
22         <see>upgrading</see>
23       </indexterm><indexterm>
24         <primary>upgrading</primary>
25       </indexterm>Release Interoperability and Upgrade Requirements</title>
26     <para><emphasis role="italic"><emphasis role="bold">Lustre software version 2.x release (major)
27           upgrade:</emphasis></emphasis><itemizedlist>
28         <listitem>
29           <para>All servers must be upgraded at the same time, while some or all clients may be
30             upgraded.</para>
31         </listitem>
32         <listitem>
33           <para>All servers must be be upgraded to a Linux kernel supported by the Lustre software. See the Linux Test Matrix at <xref
34               xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LustreTestMatrixTable"/> for a
35             list of tested Lustre distributions.</para>
36         </listitem>
37         <listitem>
38           <para>Clients to be upgraded to the Lustre 2.4 release or higher must be running a compatible Linux distribution. See the Linux Test Matrix at <xref
39               xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LustreTestMatrixTable"/> for a
40             list of tested Linux distributions.</para>
41         </listitem>
42       </itemizedlist></para>
43     <para><emphasis role="italic"><emphasis role="bold">Lustre 2.X.y release (minor)
44           upgrade:</emphasis></emphasis></para>
45     <itemizedlist>
46       <listitem>
47         <para>All servers must be upgraded at the same time, while some or all clients may be
48           upgraded.</para>
49       </listitem>
50       <listitem>
51         <para>Rolling upgrades are supported for minor releases allowing individual servers and
52           clients to be upgraded without stopping the Lustre file system.</para>
53       </listitem>
54     </itemizedlist>
55   </section>
56   <section xml:id="Upgrading_2.x">
57     <title><indexterm>
58         <primary>upgrading</primary>
59         <secondary>major release (2.x to 2.x)</secondary>
60       </indexterm><indexterm>
61         <primary>wide striping</primary>
62       </indexterm><indexterm>
63         <primary>MDT</primary>
64         <secondary>multiple MDSx</secondary>
65       </indexterm><indexterm>
66         <primary>large_xattr</primary>
67       </indexterm><indexterm>
68         <primary>wide striping</primary>
69         <secondary>large_xattr</secondary>
70       </indexterm>Upgrading to Lustre Release 2.x (Major Release)</title>
71     <para> The procedure for upgrading a Lustre release 2.x file system to a more recent 2.x release
72       of the Lustre software is described in this section. </para>
73     <note>
74       <para>This procedure can also be used to upgrade Lustre release 1.8.6-wc1 or later to any
75         Lustre release 2.x. To upgrade other versions of 1.8.x, contact your support
76         provider.</para>
77     </note>
78     <note>
79       <para condition="l22">In Lustre release 2.2, a feature has been added that allows striping
80         across up to 2000 OSTs. By default, this "wide striping" feature is disabled. It is
81         activated by setting the <literal>large_xattr</literal> option on the MDT using either
82           <literal>mkfs.lustre</literal> or <literal>tune2fs</literal>. For example after upgrading
83         an existing file system to Lustre release 2.2 or later, wide striping can be enabled by
84         running the following command on the MDT device before mounting
85         it:<screen>tune2fs -O large_xattr</screen>Once the wide striping feature is enabled and in
86         use on the MDT, it is not possible to directly downgrade the MDT file system to an earlier
87         version of the Lustre software that does not support wide striping. To disable wide striping:<orderedlist>
88           <listitem>
89             <para>Delete all wide-striped files. </para>
90             <para>OR </para>
91             <para>Use <literal>lfs_migrate</literal> with the option <literal>-c</literal>
92               <replaceable>stripe_count</replaceable> (set <replaceable>stripe_count</replaceable>
93               to 160) to move the files to another location.</para>
94           </listitem>
95           <listitem>
96             <para>Unmount the MDT.</para>
97           </listitem>
98           <listitem>
99             <para>Run the following command to turn off the <literal>large_xattr</literal>
100               option:<screen>tune2fs -O ^large_xattr</screen></para>
101           </listitem>
102         </orderedlist>
103       </para></note>
104     <note condition="l23">
105       <para>To generate a list of all files with more than 160 stripes use <literal>lfs
106           find</literal> with the <literal>--stripe-count</literal>
107         option:<screen>lfs find ${mountpoint} --stripe-count=+160</screen></para>
108     </note>
109     <note condition="l24">
110       <para>In Lustre release 2.4, a new feature allows using multiple MDTs, which can each serve
111         one or more remote sub-directories in the file system. The <literal>root</literal> directory
112         is always located on MDT0. </para>
113       <para>Note that clients running a release prior to the Lustre 2.4 release can only see the
114         namespace hosted by MDT0 and will return an IO error if an attempt is made to access a
115         directory on another MDT.</para>
116     </note>
117     <para>To upgrade a Lustre release 2.x file system to a more recent major release, complete these
118       steps:</para>
119     <orderedlist>
120       <listitem>
121         <para>Create a complete, restorable file system backup. </para>
122         <caution>
123           <para>Before installing the Lustre software, back up ALL data. The Lustre software
124             contains kernel modifications that interact with storage devices and may introduce
125             security issues and data loss if not installed, configured, or administered properly. If
126             a full backup of the file system is not practical, a device-level backup of the MDT file
127             system is recommended. See  <xref linkend="backupandrestore"/> for a procedure.</para>
128         </caution>
129       </listitem>
130       <listitem>
131         <para>Shut down the file system by unmounting all clients and servers in the order shown
132           below (unmounting a block device causes the Lustre software to be shut down on that
133           node):</para>
134         <orderedlist numeration="loweralpha">
135           <listitem>
136             <para>Unmount the clients. On each client node, run:</para>
137             <screen>umount -a -t lustre</screen>
138           </listitem>
139           <listitem>
140             <para>Unmount the MDT. On the MDS node, run:</para>
141             <screen>umount -a -t lustre</screen>
142           </listitem>
143           <listitem>
144             <para>Unmount all the OSTs. On each OSS node, run:</para>
145             <screen>umount -a -t lustre</screen>
146           </listitem>
147         </orderedlist>
148       </listitem>
149       <listitem>
150         <para>Upgrade the Linux operating system on all servers to a compatible
151           (tested) Linux distribution and reboot. See the Linux Test Matrix at <xref
152             xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LustreTestMatrixTable"/>.</para>
153       </listitem>
154       <listitem>
155         <para>Upgrade the Linux operating system on all clients to RHEL 6 or other compatible
156           (tested) distribution and reboot.  See the Linux Test Matrix at <xref
157             xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LustreTestMatrixTable"/>.</para>
158       </listitem>
159       <listitem>
160         <para>Download the Lustre server RPMs for your platform from the <link
161             xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">Lustre Releases</link>
162           repository. See <xref xmlns:xlink="http://www.w3.org/1999/xlink"
163             linkend="table_cnh_5m3_gk"/> for a list of required packages.</para>
164       </listitem>
165       <listitem>
166         <para>Install the Lustre server packages on all Lustre servers (MGS, MDSs, and OSSs).</para>
167         <orderedlist numeration="loweralpha">
168           <listitem>
169             <para>Log onto a Lustre server as the <literal>root</literal> user</para>
170           </listitem>
171           <listitem>
172             <para>Use the <literal>yum</literal> command to install the packages:</para>
173             <para>
174               <screen># yum --nogpgcheck install pkg1.rpm pkg2.rpm ...</screen>
175             </para>
176           </listitem>
177           <listitem>
178             <para>Verify the packages are installed correctly:</para>
179             <para>
180               <screen>rpm -qa|egrep "lustre|wc"</screen>
181             </para>
182           </listitem>
183           <listitem>
184             <para>Repeat these steps on each Lustre server.</para>
185           </listitem>
186         </orderedlist>
187       </listitem>
188       <listitem>
189         <para>Download the Lustre client RPMs for your platform from the <link
190             xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">Lustre Releases</link>
191           repository. See <xref xmlns:xlink="http://www.w3.org/1999/xlink"
192             linkend="table_j3r_ym3_gk"/> for a list of required packages.</para>
193         <note>
194           <para>The version of the kernel running on a Lustre client must be the same as the version
195             of the <literal>lustre-client-modules-</literal><replaceable>ver</replaceable> package
196             being installed. If not, a compatible kernel must be installed on the client before the
197             Lustre client packages are installed.</para>
198         </note>
199       </listitem>
200       <listitem>
201         <para>Install the Lustre client packages on each of the Lustre clients to be
202           upgraded.</para>
203         <orderedlist numeration="loweralpha">
204           <listitem>
205             <para>Log onto a Lustre client as the <literal>root</literal> user.</para>
206           </listitem>
207           <listitem>
208             <para>Use the <literal>yum</literal> command to install the packages:</para>
209             <para>
210               <screen># yum --nogpgcheck install pkg1.rpm pkg2.rpm ...</screen>
211             </para>
212           </listitem>
213           <listitem>
214             <para>Verify the packages were installed correctly:</para>
215             <para>
216               <screen># rpm -qa|egrep "lustre|kernel"</screen>
217             </para>
218           </listitem>
219           <listitem>
220             <para>Repeat these steps on each Lustre client.</para>
221           </listitem>
222         </orderedlist>
223       </listitem>
224       <listitem>
225         <para condition="l22">(Optional) For upgrades to Lustre release 2.2 or higher, to enable
226           wide striping on an existing MDT, run the following command on the MDT
227           :<screen>mdt# tune2fs -O large_xattr <replaceable>device</replaceable></screen></para>
228       </listitem>
229       <listitem>
230         <para condition="l24">(Optional) For upgrades to Lustre release 2.4 or higher, to format an
231           additional MDT, complete these steps:<orderedlist numeration="loweralpha">
232             <listitem>
233               <para>Determine the index used for the first MDT (each MDT must have unique index).
234                 Enter:<screen>client$ lctl dl | grep mdc
235 36 UP mdc lustre-MDT0000-mdc-ffff88004edf3c00 
236       4c8be054-144f-9359-b063-8477566eb84e 5</screen></para>
237               <para>In this example, the next available index is 1.</para>
238             </listitem>
239             <listitem>
240               <para>Add the new block device as a new MDT at the next available index by entering
241                 (on one
242                 line):<screen>mds# mkfs.lustre --reformat --fsname=<replaceable>filesystem_name</replaceable> --mdt \
243     --mgsnode=<replaceable>mgsnode</replaceable> --index <replaceable>1</replaceable> <replaceable>/dev/mdt1_device</replaceable>
244                 </screen></para>
245             </listitem>
246           </orderedlist></para>
247       </listitem>
248       <listitem>
249         <para>(<?oxy_comment_start author="lbeberne" timestamp="20130815T140026-0700" comment="Have James test"?>Optional<?oxy_comment_end?>)
250           If you are upgrading to Lustre software release 2.3 or higher from Lustre software version 2.2 or earlier
251           and want to enable the quota feature, complete these steps: <orderedlist
252             numeration="loweralpha">
253             <listitem>
254               <para>Before setting up the file system, enter on both the MDS and
255                 OSTs:<screen>tunefs.lustre --quota</screen></para>
256             </listitem>
257             <listitem>
258               <para>When setting up the file system,
259                 enter:<screen>conf_param $FSNAME.quota.mdt=$QUOTA_TYPE
260 conf_param $FSNAME.quota.ost=$QUOTA_TYPE</screen></para>
261             </listitem>
262           </orderedlist></para>
263       </listitem>
264       <listitem>
265         <para>Start the Lustre file system by starting the components in the order shown in the
266           following steps:</para>
267         <orderedlist numeration="loweralpha">
268           <listitem>
269             <para>Mount the MGT. On the MGS, run<screen>mgs# mount -a -t lustre</screen></para>
270           </listitem>
271           <listitem>
272             <para>Mount the MDT(s). On each MDT, run:<screen>mds# mount -a -t lustre</screen></para>
273           </listitem>
274           <listitem>
275             <para>Mount all the OSTs. On each OSS node, run:</para>
276             <screen>oss# mount -a -t lustre</screen>
277             <note>
278               <para>This command assumes that all the OSTs are listed in the
279                   <literal>/etc/fstab</literal> file. OSTs that are not listed in the
280                   <literal>/etc/fstab</literal> file, must be mounted individually by running the
281                 mount command:</para>
282               <screen> mount -t lustre <replaceable>/dev/block_device</replaceable> <replaceable>/mount_point</replaceable> </screen>
283             </note>
284           </listitem>
285           <listitem>
286             <para>Mount the file system on the clients. On each client node, run:</para>
287             <screen>client# mount -a -t lustre</screen>
288           </listitem>
289         </orderedlist>
290       </listitem>
291     </orderedlist>
292     <note>
293       <para>The mounting order described in the steps above must be followed for the intial mount
294         and registration of a Lustre file system after an upgrade.  For a normal start of a Lustre
295         file system, the  mounting order is MGT, OSTs, MDT(s), clients.</para>
296     </note>
297     <para>If you have a problem upgrading a Lustre file system, see <xref
298         xmlns:xlink="http://www.w3.org/1999/xlink" linkend="dbdoclet.50438198_30989"/> for some ways
299       to get help.</para>
300   </section>
301   <section xml:id="Upgrading_2.x.x">
302     <title><indexterm>
303         <primary>upgrading</primary>
304         <secondary>2.X.y to 2.X.y (minor release)</secondary>
305       </indexterm><indexterm/>Upgrading to a Lustre Release 2.X.y (Minor Release)</title>
306     <para>Rolling upgrades are supported for upgrading from any Lustre release 2.X.y to a more
307       recent 2.X.y release. This allows the Lustre file system to continue to run while individual
308       servers (or their failover partners) and clients are upgraded one at a time. The procedure for
309       upgrading a Lustre release 2.X.y file system to a more recent minor release is described in
310       this section.</para>
311     <para>To upgrade Lustre release 2.X.y to a more recent minor release, complete these
312       steps:</para>
313     <orderedlist>
314       <listitem>
315         <para>Create a complete, restorable file system backup. </para>
316         <caution>
317           <para>Before installing the Lustre software, back up ALL data. The Lustre software
318             contains kernel modifications that interact with storage devices and may introduce
319             security issues and data loss if not installed, configured, or administered properly. If
320             a full backup of the file system is not practical, a device-level backup of the MDT file
321             system is recommended. See  <xref linkend="backupandrestore"/> for a procedure.</para>
322         </caution>
323       </listitem>
324       <listitem>
325         <para>Download the Lustre server RPMs for your platform from the <link
326             xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">Lustre Releases</link>
327           repository. See <xref xmlns:xlink="http://www.w3.org/1999/xlink"
328             linkend="table_cnh_5m3_gk"/> for a list of required packages.</para>
329       </listitem>
330       <listitem>
331         <para>For a rolling upgrade, complete any procedures required to keep the Lustre file system
332           running while the server to be upgraded is offline, such as failing over a primary server
333           to its secondary partner. </para>
334       </listitem>
335       <listitem>
336         <para>Unmount the Lustre server to be upgraded (MGS, MDS, or OSS)</para>
337       </listitem>
338       <listitem>
339         <para>Install the Lustre server packages on the Lustre server.</para>
340         <orderedlist numeration="loweralpha">
341           <listitem>
342             <para>Log onto the Lustre server as the <literal>root</literal> user</para>
343           </listitem>
344           <listitem>
345             <para>Use the <literal>yum</literal> command to install the packages:</para>
346             <para>
347               <screen># yum --nogpgcheck install pkg1.rpm pkg2.rpm ...</screen>
348             </para>
349           </listitem>
350           <listitem>
351             <para>Verify the packages are installed correctly:</para>
352             <para>
353               <screen>rpm -qa|egrep "lustre|wc"</screen>
354             </para>
355           </listitem>
356           <listitem>
357             <para>Mount the Lustre server to restart the Lustre software on the
358               server:<screen>server# mount -a -t lustre</screen></para>
359           </listitem>
360           <listitem>
361             <para>Repeat these steps on each Lustre server.</para>
362           </listitem>
363         </orderedlist>
364       </listitem>
365       <listitem>
366         <para>Download the Lustre client RPMs for your platform from the <link
367             xl:href="https://wiki.hpdd.intel.com/display/PUB/Lustre+Releases">Lustre Releases</link>
368           repository. See <xref xmlns:xlink="http://www.w3.org/1999/xlink"
369             linkend="table_j3r_ym3_gk"/> for a list of required packages.</para>
370       </listitem>
371       <listitem>
372         <para>Install the Lustre client packages on each of the Lustre clients to be
373           upgraded.</para>
374         <orderedlist numeration="loweralpha">
375           <listitem>
376             <para>Log onto a Lustre client as the <literal>root</literal> user.</para>
377           </listitem>
378           <listitem>
379             <para>Use the <literal>yum</literal> command to install the packages:</para>
380             <para>
381               <screen># yum --nogpgcheck install pkg1.rpm pkg2.rpm ...</screen>
382             </para>
383           </listitem>
384           <listitem>
385             <para>Verify the packages were installed correctly:</para>
386             <para>
387               <screen># rpm -qa|egrep "lustre|kernel"</screen>
388             </para>
389           </listitem>
390           <listitem>
391             <para>Mount the Lustre client to restart the Lustre software on the
392               client:<screen>client# mount -a -t lustre</screen></para>
393           </listitem>
394           <listitem>
395             <para>Repeat these steps on each Lustre client.</para>
396           </listitem>
397         </orderedlist>
398       </listitem>
399     </orderedlist>
400     <para>If you have a problem upgrading a Lustre file system, see <xref
401         xmlns:xlink="http://www.w3.org/1999/xlink" linkend="dbdoclet.50438198_30989"/> for some
402       suggestions for how to get help.</para>
403   </section>
404 </chapter>