Whamcloud - gitweb
LUDOC-98 mgs: Document new lctl replace_nids feature
[doc/manual.git] / SettingUpBonding.xml
1 <?xml version='1.0' encoding='UTF-8'?>
2 <!-- 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="settingupbonding">
3   <title xml:id="settingupbonding.title">Setting Up Network Interface Bonding</title>
4   <para>This chapter describes how to use multiple network interfaces in parallel to increase bandwidth and/or redundancy. Topics include:</para>
5   <itemizedlist>
6     <listitem>
7       <para>
8               <xref linkend="dbdoclet.50438258_95824"/>
9           </para>
10     </listitem>
11     <listitem>
12       <para>
13               <xref linkend="dbdoclet.50438258_29107"/>
14           </para>
15     </listitem>
16     <listitem>
17       <para>
18               <xref linkend="dbdoclet.50438258_25353"/>
19           </para>
20     </listitem>
21     <listitem>
22       <para>
23               <xref linkend="dbdoclet.50438258_26899"/>
24           </para>
25     </listitem>
26     <listitem>
27       <para>
28               <xref linkend="dbdoclet.50438258_54769"/>
29           </para>
30     </listitem>
31     <listitem>
32       <para>
33               <xref linkend="dbdoclet.50438258_92244"/>
34           </para>
35     </listitem>
36   </itemizedlist>
37   <note>
38     <para>Using network interface bonding is optional.</para>
39   </note>
40   <section xml:id="dbdoclet.50438258_95824">
41     <title>Network Interface Bonding Overview</title>
42     <para>Bonding, also known as link aggregation, trunking and port trunking, is a method of aggregating multiple physical network links into a single logical link for increased bandwidth.</para>
43     <para>Several different types of bonding are available in Linux. All these types are referred to as &apos;modes&apos;, and use the bonding kernel module.</para>
44     <para>Modes 0 to 3 allow load balancing and fault tolerance by using multiple interfaces. Mode 4 aggregates a group of interfaces into a single virtual interface where all members of the group share the same speed and duplex settings. This mode is described under IEEE spec 802.3ad, and it is referred to as either &apos;mode 4&apos; or &apos;802.3ad.&apos;</para>
45   </section>
46   <section xml:id="dbdoclet.50438258_29107">
47     <title>Requirements</title>
48     <para>The most basic requirement for successful bonding is that both endpoints of the connection must be capable of bonding. In a normal case, the non-server endpoint is a switch. (Two systems connected via crossover cables can also use bonding.) Any switch used must explicitly handle 802.3ad Dynamic Link Aggregation.</para>
49     <para>The kernel must also be configured with bonding. All supported Lustre kernels have bonding functionality. The network driver for the interfaces to be bonded must have the ethtool functionality to determine slave speed and duplex settings. All recent network drivers implement it.</para>
50     <para>To verify that your interface works with ethtool, run:</para>
51     <screen># which ethtool
52 /sbin/ethtool
53  
54 # ethtool eth0
55 Settings for eth0:
56            Supported ports: [ TP MII ]
57            Supported link modes:   10baseT/Half 10baseT/Full
58                                    100baseT/Half 100baseT/Full
59            Supports auto-negotiation: Yes
60            Advertised link modes:  10baseT/Half 10baseT/Full
61                                    100baseT/Half 100baseT/Full
62            Advertised auto-negotiation: Yes
63            Speed: 100Mb/s
64            Duplex: Full
65            Port: MII
66            PHYAD: 1
67            Transceiver: internal
68            Auto-negotiation: on
69            Supports Wake-on: pumbg
70            Wake-on: d
71            Current message level: 0x00000001 (1)
72            Link detected: yes
73  
74 # ethtool eth1
75  
76 Settings for eth1:
77    Supported ports: [ TP MII ]
78    Supported link modes:   10baseT/Half 10baseT/Full
79                            100baseT/Half 100baseT/Full
80    Supports auto-negotiation: Yes
81    Advertised link modes:  10baseT/Half 10baseT/Full
82    100baseT/Half 100baseT/Full
83    Advertised auto-negotiation: Yes
84    Speed: 100Mb/s
85    Duplex: Full
86    Port: MII
87    PHYAD: 32
88    Transceiver: internal
89    Auto-negotiation: on
90    Supports Wake-on: pumbg
91    Wake-on: d
92    Current message level: 0x00000007 (7)
93    Link detected: yes
94    To quickly check whether your kernel supports bonding, run:     
95    # grep ifenslave /sbin/ifup
96    # which ifenslave
97    /sbin/ifenslave
98 </screen>
99   </section>
100   <section xml:id="dbdoclet.50438258_25353">
101     <title>Bonding Module Parameters</title>
102     <para>Bonding module parameters control various aspects of bonding.</para>
103     <para>Outgoing traffic is mapped across the slave interfaces according to the transmit hash policy. For Lustre, we recommend that you set the <literal>xmit_hash_policy</literal> option to the layer3+4 option for bonding. This policy uses upper layer protocol information if available to generate the hash. This allows traffic to a particular network peer to span multiple slaves, although a single connection does not span multiple slaves.</para>
104     <screen>$ xmit_hash_policy=layer3+4</screen>
105     <para>The miimon option enables users to monitor the link status. (The parameter is a time interval in milliseconds.) It makes an interface failure transparent to avoid serious network degradation during link failures. A reasonable default setting is 100 milliseconds; run:</para>
106     <screen>$ miimon=100</screen>
107     <para>For a busy network, increase the timeout.</para>
108   </section>
109   <section xml:id="dbdoclet.50438258_26899">
110     <title>Setting Up Bonding</title>
111     <para>To set up bonding:</para>
112     <orderedlist>
113       <listitem>
114         <para>Create a virtual &apos;bond&apos; interface by creating a configuration file:</para>
115         <screen># vi /etc/sysconfig/network-scripts/ifcfg-bond0</screen>
116       </listitem>
117       <listitem>
118         <para>Append the following lines to the file.</para>
119         <screen>DEVICE=bond0
120 IPADDR=192.168.10.79 # Use the free IP Address of your network
121 NETWORK=192.168.10.0
122 NETMASK=255.255.255.0
123 USERCTL=no
124 BOOTPROTO=none
125 ONBOOT=yes</screen>
126       </listitem>
127       <listitem>
128         <para>Attach one or more slave interfaces to the bond interface. Modify the eth0 and eth1 configuration files (using a VI text editor).</para>
129         <orderedlist>
130           <listitem>
131             <para>Use the VI text editor to open the eth0 configuration file.</para>
132             <screen># vi /etc/sysconfig/network-scripts/ifcfg-eth0</screen>
133           </listitem>
134           <listitem>
135             <para>Modify/append the eth0 file as follows:</para>
136             <screen>DEVICE=eth0
137 USERCTL=no
138 ONBOOT=yes
139 MASTER=bond0
140 SLAVE=yes
141 BOOTPROTO=none</screen>
142           </listitem>
143           <listitem>
144             <para>Use the VI text editor to open the eth1 configuration file.</para>
145             <screen># vi /etc/sysconfig/network-scripts/ifcfg-eth1</screen>
146           </listitem>
147           <listitem>
148             <para>Modify/append the eth1 file as follows:</para>
149             <screen>DEVICE=eth1
150 USERCTL=no
151 ONBOOT=yes
152 MASTER=bond0
153 SLAVE=yes
154 BOOTPROTO=none
155 </screen>
156           </listitem>
157         </orderedlist>
158       </listitem>
159       <listitem>
160         <para>Set up the bond interface and its options in <literal>/etc/modprobe.d/bond.conf</literal>. Start the slave interfaces by your normal network method.</para>
161         <screen># vi /etc/modprobe.d/bond.conf
162 </screen>
163         <orderedlist>
164           <listitem>
165             <para>Append the following lines to the file.</para>
166             <screen>alias bond0 bonding
167 options bond0 mode=balance-alb miimon=100
168 </screen>
169           </listitem>
170           <listitem>
171             <para>Load the bonding module.</para>
172             <screen># modprobe bonding
173 # ifconfig bond0 up
174 # ifenslave bond0 eth0 eth1
175 </screen>
176           </listitem>
177         </orderedlist>
178       </listitem>
179       <listitem>
180         <para>Start/restart the slave interfaces (using your normal network method).</para>
181         <note>
182           <para>You must <literal>modprobe</literal> the bonding module for each bonded interface. If you wish to create bond0 and bond1, two entries in <literal>bond.conf</literal> file are required.</para>
183         </note>
184         <para>The examples below are from RedHat systems. For setup use: <literal>/etc/sysconfig/networking-scripts/ifcfg-*</literal> The website referenced below includes detailed instructions for other configuration methods, instructions to use DHCP with bonding, and other setup details. We strongly recommend you use this website.</para>
185         <para><link xl:href="http://www.linuxfoundation.org/collaborate/workgroups/networking/bonding">http://www.linuxfoundation.org/collaborate/workgroups/networking/bonding</link></para>
186       </listitem>
187       <listitem>
188         <para>Check /proc/net/bonding to determine status on bonding. There should be a file there for each bond interface.</para>
189         <screen># cat /proc/net/bonding/bond0
190 Ethernet Channel Bonding Driver: v3.0.3 (March 23, 2006)
191  
192 Bonding Mode: load balancing (round-robin)
193 MII Status: up
194 MII Polling Interval (ms): 0
195 Up Delay (ms): 0
196 Down Delay (ms): 0
197  
198 Slave Interface: eth0
199 MII Status: up
200 Link Failure Count: 0
201 Permanent HW addr: 4c:00:10:ac:61:e0
202  
203 Slave Interface: eth1
204 MII Status: up
205 Link Failure Count: 0
206 Permanent HW addr: 00:14:2a:7c:40:1d
207 </screen>
208       </listitem>
209       <listitem>
210         <para>Use ethtool or ifconfig to check the interface state. ifconfig lists the first bonded interface as &apos;bond0.&apos;</para>
211         <screen>ifconfig
212 bond0      Link encap:Ethernet  HWaddr 4C:00:10:AC:61:E0
213    inet addr:192.168.10.79  Bcast:192.168.10.255 \     Mask:255.255.255.0
214    inet6 addr: fe80::4e00:10ff:feac:61e0/64 Scope:Link
215    UP BROADCAST RUNNING MASTER MULTICAST  MTU:1500 Metric:1
216    RX packets:3091 errors:0 dropped:0 overruns:0 frame:0
217    TX packets:880 errors:0 dropped:0 overruns:0 carrier:0
218    collisions:0 txqueuelen:0
219    RX bytes:314203 (306.8 KiB)  TX bytes:129834 (126.7 KiB)
220  
221 eth0       Link encap:Ethernet  HWaddr 4C:00:10:AC:61:E0
222    inet6 addr: fe80::4e00:10ff:feac:61e0/64 Scope:Link
223    UP BROADCAST RUNNING SLAVE MULTICAST  MTU:1500 Metric:1
224    RX packets:1581 errors:0 dropped:0 overruns:0 frame:0
225    TX packets:448 errors:0 dropped:0 overruns:0 carrier:0
226    collisions:0 txqueuelen:1000
227    RX bytes:162084 (158.2 KiB)  TX bytes:67245 (65.6 KiB)
228    Interrupt:193 Base address:0x8c00
229  
230 eth1       Link encap:Ethernet  HWaddr 4C:00:10:AC:61:E0
231    inet6 addr: fe80::4e00:10ff:feac:61e0/64 Scope:Link
232    UP BROADCAST RUNNING SLAVE MULTICAST  MTU:1500 Metric:1
233    RX packets:1513 errors:0 dropped:0 overruns:0 frame:0
234    TX packets:444 errors:0 dropped:0 overruns:0 carrier:0
235    collisions:0 txqueuelen:1000
236    RX bytes:152299 (148.7 KiB)  TX bytes:64517 (63.0 KiB)
237    Interrupt:185 Base address:0x6000
238 </screen>
239       </listitem>
240     </orderedlist>
241     <section remap="h3">
242       <title>Examples</title>
243       <para>This is an example showing <literal>bond.conf</literal> entries for bonding Ethernet interfaces <literal>eth1</literal> and <literal>eth2</literal> to <literal>bond0</literal>:</para>
244       <screen># cat /etc/modprobe.d/bond.conf
245 alias eth0 8139too
246 alias eth1 via-rhine
247 alias bond0 bonding
248 options bond0 mode=balance-alb miimon=100
249  
250 # cat /etc/sysconfig/network-scripts/ifcfg-bond0
251 DEVICE=bond0
252 BOOTPROTO=none
253 NETMASK=255.255.255.0
254 IPADDR=192.168.10.79 # (Assign here the IP of the bonded interface.)
255 ONBOOT=yes
256 USERCTL=no
257  
258 ifcfg-ethx 
259 # cat /etc/sysconfig/network-scripts/ifcfg-eth0
260 TYPE=Ethernet
261 DEVICE=eth0
262 HWADDR=4c:00:10:ac:61:e0
263 BOOTPROTO=none
264 ONBOOT=yes
265 USERCTL=no
266 IPV6INIT=no
267 PEERDNS=yes
268 MASTER=bond0
269 SLAVE=yes
270 </screen>
271       <para>In the following example, the <literal>bond0</literal> interface is the master (MASTER) while <literal>eth0</literal> and <literal>eth1</literal> are slaves (SLAVE).</para>
272       <note>
273         <para>All slaves of <literal>bond0</literal> have the same MAC address (Hwaddr) - <literal>bond0</literal>. All modes, except TLB and ALB, have this MAC address. TLB and ALB require a unique MAC address for each slave.</para>
274       </note>
275       <screen>$ /sbin/ifconfig
276  
277 bond0Link encap:EthernetHwaddr 00:C0:F0:1F:37:B4
278 inet addr:XXX.XXX.XXX.YYY Bcast:XXX.XXX.XXX.255 Mask:255.255.252.0
279 UP BROADCAST RUNNING MASTER MULTICAST MTU:1500  Metric:1
280 RX packets:7224794 errors:0 dropped:0 overruns:0 frame:0
281 TX packets:3286647 errors:1 dropped:0 overruns:1 carrier:0
282 collisions:0 txqueuelen:0
283  
284 eth0Link encap:EthernetHwaddr 00:C0:F0:1F:37:B4
285 inet addr:XXX.XXX.XXX.YYY Bcast:XXX.XXX.XXX.255 Mask:255.255.252.0
286 UP BROADCAST RUNNING SLAVE MULTICAST MTU:1500  Metric:1
287 RX packets:3573025 errors:0 dropped:0 overruns:0 frame:0
288 TX packets:1643167 errors:1 dropped:0 overruns:1 carrier:0
289 collisions:0 txqueuelen:100
290 Interrupt:10 Base address:0x1080
291  
292 eth1Link encap:EthernetHwaddr 00:C0:F0:1F:37:B4
293 inet addr:XXX.XXX.XXX.YYY Bcast:XXX.XXX.XXX.255 Mask:255.255.252.0
294 UP BROADCAST RUNNING SLAVE MULTICAST MTU:1500  Metric:1
295 RX packets:3651769 errors:0 dropped:0 overruns:0 frame:0
296 TX packets:1643480 errors:0 dropped:0 overruns:0 carrier:0
297 collisions:0 txqueuelen:100
298 Interrupt:9 Base address:0x1400</screen>
299     </section>
300   </section>
301   <section xml:id="dbdoclet.50438258_54769">
302     <title>Configuring Lustre with Bonding</title>
303     <para>Lustre uses the IP address of the bonded interfaces and requires no special configuration. It treats the bonded interface as a regular TCP/IP interface. If needed, specify bond0 using the Lustre networks parameter in /etc/modprobe.</para>
304     <screen>options lnet networks=tcp(bond0)</screen>
305   </section>
306   <section xml:id="dbdoclet.50438258_92244">
307     <title>Bonding References</title>
308     <para>We recommend the following bonding references:</para>
309     <itemizedlist>
310       <listitem>
311         <para>In the Linux kernel source tree, see documentation/networking/bonding.txt</para>
312       </listitem>
313       <listitem>
314         <para><link xl:href="http://linux-ip.net/html/ether-bonding.html">http://linux-ip.net/html/ether-bonding.html</link></para>
315       </listitem>
316       <listitem>
317         <para><link xl:href="http://www.sourceforge.net/projects/bonding">http://www.sourceforge.net/projects/bonding</link></para>
318       </listitem>
319       <listitem>
320         <para>Linux Foundation bonding website: <link xl:href="http://www.linuxfoundation.org/collaborate/workgroups/networking/bonding">http://www.linuxfoundation.org/collaborate/workgroups/networking/bonding</link></para>
321       </listitem>
322     </itemizedlist>
323     <para>This is the most extensive reference and we highly recommend it. This website includes explanations of more complicated setups, including the use of DHCP with bonding.</para>
324   </section>
325 </chapter>