ovs-ofctl: Avoid groff warning due to too-long line.
[cascardo/ovs.git] / INSTALL.RHEL
1        How to Install Open vSwitch on Red Hat Enterprise Linux
2        =======================================================
3
4 This document describes how to build and install Open vSwitch on a Red
5 Hat Enterprise Linux (RHEL) host.  If you want to install Open vSwitch
6 on a generic Linux host, see INSTALL instead.
7
8 We have tested these instructions with RHEL 5.6 and RHEL 6.0.
9
10 Building Open vSwitch for RHEL
11 ------------------------------
12
13 You may build from an Open vSwitch distribution tarball or from an
14 Open vSwitch Git tree.
15
16 Before you begin, note the RPM source directory on your version of
17 RHEL.  On RHEL 5, the default RPM source directory is
18 /usr/src/redhat/SOURCES.  On RHEL 6, it is $HOME/rpmbuild/SOURCES.
19
20 1. If you are building from an Open vSwitch Git tree, then you will
21    need to first create a distribution tarball by running "./boot.sh;
22    ./configure; make dist" in the Git tree.
23
24 2. Copy the distribution tarball into the RPM source directory.
25
26 3. Unpack the distribution tarball into a temporary directory and "cd"
27    into the root of the distribution tarball.
28
29 4. To build Open vSwitch userspace, run:
30
31        rpmbuild -bb rhel/openvswitch.spec
32
33    This produces two RPMs: "openvswitch" and "openvswitch-debuginfo".
34
35 5a. On RHEL 5, to build the Open vSwitch kernel module, copy
36     rhel/kmodtool-openvswitch-el5.sh into the RPM source directory and
37     run:
38
39         rpmbuild -bb --target=i686-unknown-linux \
40                 rhel/openvswitch-kmod-rhel5.spec
41
42     You might have to specify a kernel version, e.g.:
43
44         rpmbuild -bb -D "kversion 2.6.18-238.12.1.el5" \
45                 --target=i686-unknown-linux \
46                 rhel/openvswitch-kmod-rhel5.spec
47
48     This produces a "kmod-openvswitch" RPM for each kernel variant,
49     which is usually: "kmod-openvswitch", "kmod-openvswitch-xen", and
50     "kmod-openvswitch-PAE".
51
52 5b. On RHEL 6, to build the Open vSwitch kernel module, copy
53     rhel/openvswitch-kmod.files into the RPM source directory and run:
54
55         rpmbuild -bb rhel/openvswitch-kmod-rhel6.spec
56
57     You might have to specify a kernel version and/or variants, e.g.:
58
59         rpmbuild -bb \
60                 -D "kversion 2.6.32-131.6.1.el6.x86_64" \
61                 -D "kflavors default debug kdump" \
62                 rhel/openvswitch-kmod-rhel6.spec
63
64     This produces an "kmod-openvswitch" RPM for each kernel variant,
65     in this example: "kmod-openvswitch", "kmod-openvswitch-debug", and
66     "kmod-openvswitch-kdump".
67
68 Red Hat Network Scripts Integration
69 -----------------------------------
70
71 Simple integration with Red Hat network scripts has been implemented.
72 Please read rhel/README.RHEL in the source tree or
73 /usr/share/doc/openvswitch/README.RHEL in the installed openvswitch
74 package for details.
75
76 Reporting Bugs
77 --------------
78
79 Please report problems to bugs@openvswitch.org.