]>
Commit | Line | Data |
---|---|---|
f6eb6b20 GL |
1 | How to Install Open vSwitch on Linux and FreeBSD |
2 | ================================================ | |
4b11d5e8 BP |
3 | |
4 | This document describes how to build and install Open vSwitch on a | |
6494ea4c BP |
5 | generic Linux or FreeBSD host. For specifics around installation on a |
6 | specific platform, please see one of these files: | |
4b11d5e8 | 7 | |
6494ea4c BP |
8 | - INSTALL.Debian |
9 | - INSTALL.Fedora | |
10 | - INSTALL.RHEL | |
11 | - INSTALL.XenServer | |
4b11d5e8 BP |
12 | |
13 | Build Requirements | |
14 | ------------------ | |
15 | ||
16 | To compile the userspace programs in the Open vSwitch distribution, | |
17 | you will need the following software: | |
18 | ||
19 | - A make program, e.g. GNU make. BSD make should also work. | |
20 | ||
21 | - The GNU C compiler. We generally test with version 4.1, 4.2, or | |
22 | 4.3. | |
23 | ||
9f8bf569 BP |
24 | - pkg-config. We test with version 0.22. |
25 | ||
4b11d5e8 BP |
26 | - libssl, from OpenSSL, is optional but recommended if you plan to |
27 | connect the Open vSwitch to an OpenFlow controller. libssl is | |
28 | required to establish confidentiality and authenticity in the | |
f272ec73 BP |
29 | connections from an Open vSwitch to an OpenFlow controller. If |
30 | libssl is installed, then Open vSwitch will automatically build | |
31 | with support for it. | |
4b11d5e8 | 32 | |
f6eb6b20 GL |
33 | To compile the kernel module on Linux, you must also install the |
34 | following. If you cannot build or install the kernel module, you may | |
35 | use the userspace-only implementation, at a cost in performance. The | |
d377243b BP |
36 | userspace implementation may also lack some features. Refer to |
37 | INSTALL.userspace for more information. | |
4b11d5e8 BP |
38 | |
39 | - A supported Linux kernel version. Please refer to README for a | |
40 | list of supported versions. | |
41 | ||
42 | The Open vSwitch datapath requires bridging support | |
43 | (CONFIG_BRIDGE) to be built as a kernel module. (This is common | |
44 | in kernels provided by Linux distributions.) The bridge module | |
45 | must not be loaded or in use. If the bridge module is running | |
46 | (check with "lsmod | grep bridge"), you must remove it ("rmmod | |
47 | bridge") before starting the datapath. | |
48 | ||
49 | For optional support of ingress policing, you must enable kernel | |
f8500004 JP |
50 | configuration options NET_CLS_BASIC, NET_SCH_INGRESS, and |
51 | NET_ACT_POLICE, either built-in or as modules. (NET_CLS_POLICE is | |
52 | obsolete and not needed.) | |
4b11d5e8 | 53 | |
6f470982 JG |
54 | If GRE tunneling is being used it is recommended that the kernel |
55 | be compiled with IPv6 support (CONFIG_IPV6). This allows for | |
56 | special handling (such as path MTU discovery) of IPv6 packets. | |
57 | ||
c9d3af4e BP |
58 | To configure HTB or HFSC quality of service with Open vSwitch, |
59 | you must enable the respective configuration options. | |
60 | ||
26bb189d BP |
61 | To use Open vSwitch support for TAP devices, you must enable |
62 | CONFIG_TUN. | |
63 | ||
4b11d5e8 BP |
64 | - To build a kernel module, you need the same version of GCC that |
65 | was used to build that kernel. | |
66 | ||
67 | - A kernel build directory corresponding to the Linux kernel image | |
68 | the module is to run on. Under Debian and Ubuntu, for example, | |
69 | each linux-image package containing a kernel binary has a | |
70 | corresponding linux-headers package with the required build | |
71 | infrastructure. | |
72 | ||
73 | If you are working from a Git tree or snapshot (instead of from a | |
c9d3af4e BP |
74 | distribution tarball), or if you modify the Open vSwitch build system |
75 | or the database schema, you will also need the following software: | |
4b11d5e8 | 76 | |
55aa00e0 | 77 | - Autoconf version 2.64 or later. |
4b11d5e8 BP |
78 | |
79 | - Automake version 1.10 or later. | |
80 | ||
195b5c35 BP |
81 | - Python 2.x, for x >= 4. |
82 | ||
436f27dd AS |
83 | If you modify the ovsdbmonitor tool, then you will also need the |
84 | following: | |
85 | ||
86 | - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk). | |
87 | ||
c9d3af4e BP |
88 | To run the unit tests, you also need: |
89 | ||
90 | - Perl. Version 5.10.1 is known to work. Earlier versions should | |
91 | also work. | |
92 | ||
f8d739a9 BP |
93 | If you modify the vswitchd database schema, then the E-R diagram in |
94 | the ovs-vswitchd.conf.db(5) manpage will be updated properly only if | |
95 | you have the following: | |
96 | ||
97 | - "dot" from graphviz (http://www.graphviz.org/). | |
98 | ||
c9d3af4e BP |
99 | - Perl. Version 5.10.1 is known to work. Earlier versions should |
100 | also work. | |
101 | ||
102 | - Python 2.x, for x >= 4. | |
103 | ||
f8f26e98 BP |
104 | If you are going to extensively modify Open vSwitch, please consider |
105 | installing the following to obtain better warnings: | |
106 | ||
107 | - "sparse" version 0.4.4 or later | |
108 | (http://www.kernel.org/pub/software/devel/sparse/dist/). | |
109 | ||
110 | - GNU make. | |
111 | ||
4b11d5e8 BP |
112 | Installation Requirements |
113 | ------------------------- | |
114 | ||
115 | The machine on which Open vSwitch is to be installed must have the | |
116 | following software: | |
117 | ||
118 | - libc compatible with the libc used for build. | |
119 | ||
120 | - libssl compatible with the libssl used for build, if OpenSSL was | |
121 | used for the build. | |
122 | ||
f6eb6b20 | 123 | - On Linux, the same kernel version configured as part of the build. |
4b11d5e8 | 124 | |
f6eb6b20 GL |
125 | - For optional support of ingress policing on Linux, the "tc" program |
126 | from iproute2 (part of all major distributions and available at | |
4b11d5e8 BP |
127 | http://www.linux-foundation.org/en/Net:Iproute2). |
128 | ||
f6eb6b20 GL |
129 | On Linux you should ensure that /dev/urandom exists. To support TAP |
130 | devices, you must also ensure that /dev/net/tun exists. | |
6e8e271c | 131 | |
2ac7bbf5 | 132 | To run the ovsdbmonitor tool, the machine must also have the following |
436f27dd AS |
133 | software: |
134 | ||
135 | - Python 2.x, for x >= 4. | |
136 | ||
137 | - Python Twisted Conch. | |
138 | ||
139 | - Python JSON. | |
140 | ||
141 | - PySide or PyQt4. | |
142 | ||
143 | - Python Zope interface module. | |
144 | ||
145 | (On Debian "lenny" the above can be installed with "apt-get install | |
146 | python-json python-qt4 python-zopeinterface python-twisted-conch".) | |
147 | ||
f6eb6b20 GL |
148 | Building and Installing Open vSwitch for Linux or FreeBSD |
149 | ========================================================= | |
4b11d5e8 BP |
150 | |
151 | Once you have installed all the prerequisites listed above in the Base | |
152 | Prerequisites section, follow the procedure below to build. | |
153 | ||
f6eb6b20 | 154 | 1. If you pulled the sources directly from an Open vSwitch Git tree, |
30746a1b JP |
155 | run boot.sh in the top source directory: |
156 | ||
157 | % ./boot.sh | |
158 | ||
159 | 2. In the top source directory, configure the package by running the | |
4b11d5e8 BP |
160 | configure script. You can usually invoke configure without any |
161 | arguments: | |
162 | ||
163 | % ./configure | |
164 | ||
165 | By default all files are installed under /usr/local. If you want | |
166 | to install into, e.g., /usr and /var instead of /usr/local and | |
167 | /usr/local/var, add options as shown here: | |
168 | ||
169 | % ./configure --prefix=/usr --localstatedir=/var | |
170 | ||
171 | To use a specific C compiler for compiling Open vSwitch user | |
172 | programs, also specify it on the configure command line, like so: | |
173 | ||
174 | % ./configure CC=gcc-4.2 | |
175 | ||
176 | To build the Linux kernel module, so that you can run the | |
177 | kernel-based switch, pass the location of the kernel build | |
338fb44a | 178 | directory on --with-linux. For example, to build for a running |
8a2d6596 | 179 | instance of Linux: |
4b11d5e8 | 180 | |
8a2d6596 | 181 | % ./configure --with-linux=/lib/modules/`uname -r`/build |
4b11d5e8 BP |
182 | |
183 | If you wish to build the kernel module for an architecture other | |
184 | than the architecture of the machine used for the build, you may | |
185 | specify the kernel architecture string using the KARCH variable | |
186 | when invoking the configure script. For example, to build for MIPS | |
8a2d6596 | 187 | with Linux: |
4b11d5e8 | 188 | |
22bcc0e7 | 189 | % ./configure --with-linux=/path/to/linux KARCH=mips |
4b11d5e8 BP |
190 | |
191 | The configure script accepts a number of other options and honors | |
192 | additional environment variables. For a full list, invoke | |
193 | configure with the --help option. | |
194 | ||
f6eb6b20 | 195 | 3. Run make in the top source directory: |
4b11d5e8 BP |
196 | |
197 | % make | |
198 | ||
f6eb6b20 GL |
199 | On FreeBSD you may need to use GNU make (gmake) or NetBSD make |
200 | (bmake) instead of the native make. | |
201 | ||
f8f26e98 BP |
202 | For improved warnings if you installed "sparse" (see |
203 | "Prerequisites"), add C=1 to the "make" command line. | |
204 | ||
30746a1b | 205 | 4. Become root by running "su" or another program. |
4b11d5e8 | 206 | |
30746a1b | 207 | 5. Run "make install" to install the executables and manpages into the |
4b11d5e8 BP |
208 | running system, by default under /usr/local. |
209 | ||
30746a1b | 210 | 6. If you built kernel modules, you may load them with "insmod", e.g.: |
4b11d5e8 | 211 | |
9b80f761 | 212 | % insmod datapath/linux/openvswitch.ko |
4b11d5e8 BP |
213 | |
214 | You may need to specify a full path to insmod, e.g. /sbin/insmod. | |
215 | To verify that the modules have been loaded, run "/sbin/lsmod" and | |
9b80f761 | 216 | check that openvswitch is listed. |
4b11d5e8 | 217 | |
dd2d79ce BP |
218 | If the "insmod" operation fails, look at the last few kernel log |
219 | messages (e.g. with "dmesg | tail"): | |
220 | ||
9b80f761 | 221 | - The message "openvswitch: exports duplicate symbol |
dd2d79ce BP |
222 | br_should_route_hook (owned by bridge)" means that the bridge |
223 | module is loaded. Run "/sbin/rmmod bridge" to remove it. | |
224 | ||
225 | If "/sbin/rmmod bridge" fails with "ERROR: Module bridge does | |
226 | not exist in /proc/modules", then the bridge is compiled into | |
227 | the kernel, rather than as a module. Open vSwitch does not | |
228 | support this configuration (see "Build Requirements", above). | |
229 | ||
9b80f761 | 230 | - The message "openvswitch: exports duplicate symbol |
dd2d79ce BP |
231 | dp_ioctl_hook (owned by ofdatapath)" means that the ofdatapath |
232 | module from the OpenFlow reference implementation is loaded. | |
233 | Run "/sbin/rmmod ofdatapath" to remove it. (You might have to | |
234 | delete any existing datapaths beforehand, using the "dpctl" | |
235 | program included with the OpenFlow reference implementation. | |
236 | "ovs-dpctl" will not work.) | |
237 | ||
238 | - Otherwise, the most likely problem is that Open vSwitch was | |
239 | built for a kernel different from the one into which you are | |
9b80f761 | 240 | trying to load it. Run "modinfo" on openvswitch.ko and on |
dd2d79ce BP |
241 | a module built for the running kernel, e.g.: |
242 | ||
9b80f761 | 243 | % /sbin/modinfo openvswitch.ko |
dd2d79ce BP |
244 | % /sbin/modinfo /lib/modules/`uname -r`/kernel/net/bridge/bridge.ko |
245 | ||
246 | Compare the "vermagic" lines output by the two commands. If | |
247 | they differ, then Open vSwitch was built for the wrong kernel. | |
248 | ||
249 | - If you decide to report a bug or ask a question related to | |
250 | module loading, please include the output from the "dmesg" and | |
251 | "modinfo" commands mentioned above. | |
252 | ||
9b80f761 | 253 | There is an optional module parameter to openvswitch.ko called |
3f6256af JG |
254 | vlan_tso that enables TCP segmentation offload over VLANs on NICs |
255 | that support it. Many drivers do not expose support for TSO on VLANs | |
256 | in a way that Open vSwitch can use but there is no way to detect | |
257 | whether this is the case. If you know that your particular driver can | |
258 | handle it (for example by testing sending large TCP packets over VLANs) | |
259 | then passing in a value of 1 may improve performance. Modules built for | |
431488e6 BP |
260 | Linux kernels 2.6.37 and later, as well as specially patched versions |
261 | of earlier kernels, do not need this and do not have this parameter. If | |
262 | you do not understand what this means or do not know if your driver | |
263 | will work, do not set this. | |
3f6256af | 264 | |
beffe875 BP |
265 | Once you verify that the kernel modules load properly, you should |
266 | install them: | |
267 | ||
268 | % make modules_install | |
269 | ||
3b12adda | 270 | 7. Initialize the configuration database using ovsdb-tool, e.g.: |
4b11d5e8 | 271 | |
028415b6 BP |
272 | % mkdir -p /usr/local/etc/openvswitch |
273 | % ovsdb-tool create /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema | |
4b11d5e8 | 274 | |
3b12adda BP |
275 | Startup |
276 | ======= | |
4b11d5e8 | 277 | |
3b12adda | 278 | Before starting ovs-vswitchd itself, you need to start its |
cb8141b2 BP |
279 | configuration database, ovsdb-server. Each machine on which Open |
280 | vSwitch is installed should run its own copy of ovsdb-server. | |
281 | Configure it to use the database you created during step 7 of | |
8084a280 BP |
282 | installation, above, to listen on a Unix domain socket, to connect to |
283 | any managers specified in the database itself, and to use the SSL | |
284 | configuration in the database: | |
285 | ||
29701194 BP |
286 | % ovsdb-server --remote=punix:/usr/local/var/run/openvswitch/db.sock \ |
287 | --remote=db:Open_vSwitch,manager_options \ | |
288 | --private-key=db:SSL,private_key \ | |
289 | --certificate=db:SSL,certificate \ | |
290 | --bootstrap-ca-cert=db:SSL,ca_cert \ | |
291 | --pidfile --detach | |
3b12adda | 292 | |
d3e3fb58 BP |
293 | (If you built Open vSwitch without SSL support, then omit |
294 | --private-key, --certificate, and --bootstrap-ca-cert.) | |
295 | ||
de4f3c10 | 296 | Then initialize the database using ovs-vsctl. This is only |
332b4e09 BP |
297 | necessary the first time after you create the database with |
298 | ovsdb-tool (but running it at any time is harmless): | |
299 | ||
de4f3c10 | 300 | % ovs-vsctl --no-wait init |
332b4e09 | 301 | |
3b12adda BP |
302 | Then start the main Open vSwitch daemon, telling it to connect to the |
303 | same Unix domain socket: | |
304 | ||
80df177a | 305 | % ovs-vswitchd --pidfile --detach |
3b12adda BP |
306 | |
307 | Now you may use ovs-vsctl to set up bridges and other Open vSwitch | |
308 | features. For example, to create a bridge named br0 and add ports | |
309 | eth0 and vif1.0 to it: | |
310 | ||
311 | % ovs-vsctl add-br br0 | |
312 | % ovs-vsctl add-port br0 eth0 | |
313 | % ovs-vsctl add-port br0 vif1.0 | |
314 | ||
315 | Please refer to ovs-vsctl(8) for more details. | |
4b11d5e8 | 316 | |
8b055d92 BP |
317 | Upgrading |
318 | ========= | |
319 | ||
320 | When you upgrade Open vSwitch from one version to another, you should | |
321 | also upgrade the database schema: | |
322 | ||
323 | 1. Stop the Open vSwitch daemons, e.g.: | |
324 | ||
012f5c4b | 325 | % kill `cd /usr/local/var/run/openvswitch && cat ovsdb-server.pid ovs-vswitchd.pid` |
8b055d92 BP |
326 | |
327 | 2. Install the new Open vSwitch release. | |
328 | ||
329 | 3. Upgrade the database, in one of the following two ways: | |
330 | ||
331 | - If there is no important data in your database, then you may | |
332 | delete the database file and recreate it with ovsdb-tool, | |
333 | following the instructions under "Building and Installing Open | |
f6eb6b20 | 334 | vSwitch for Linux or FreeBSD". |
8b055d92 BP |
335 | |
336 | - If you want to preserve the contents of your database, back it | |
337 | up first, then use "ovsdb-tool convert" to upgrade it, e.g.: | |
338 | ||
028415b6 | 339 | % ovsdb-tool convert /usr/local/etc/openvswitch/conf.db vswitchd/vswitch.ovsschema |
8b055d92 BP |
340 | |
341 | 4. Start the Open vSwitch daemons as described under "Building and | |
f6eb6b20 | 342 | Installing Open vSwitch for Linux or FreeBSD" above. |
8b055d92 | 343 | |
4b11d5e8 BP |
344 | Bug Reporting |
345 | ------------- | |
346 | ||
37ea6436 | 347 | Please report problems to bugs@openvswitch.org. |