doc: Convert docs to Markdown language
[cascardo/ovs.git] / INSTALL.Fedora.md
1 How to Install Open vSwitch on Fedora Linux
2 ===========================================
3
4 This document describes how to build and install Open vSwitch on a Fedora
5 Linux host.  If you want to install Open vSwitch on a generic Linux host,
6 see [INSTALL.Linux](INSTALL.Linux.md) instead.
7
8 We have tested these instructions with Fedora 16 and Fedora 17.
9
10 Building Open vSwitch for Fedora
11 --------------------------------
12
13 You may build from an Open vSwitch distribution tarball or from an
14 Open vSwitch Git tree.
15
16 The default RPM build directory (_topdir) has five directories in
17 the top-level:
18 1. BUILD/ Where the software is unpacked and built.
19 2. RPMS/ Where the newly created binary package files are written.
20 3. SOURCES/ Contains the original sources, patches, and icon files.
21 4. SPECS/ Contains the spec files for each package to be built.
22 5. SRPMS/ Where the newly created source package files are written.
23
24 Before you begin, note the RPM sources directory on your version of
25 Fedora.  The command "rpmbuild --showrc" will show the configuration
26 for each of those directories. Alternatively, the command "rpm --eval
27  '%{_topdir}'" shows the current configuration for the top level
28 directory and the command "rpm --eval '%{_sourcedir}'" does the same
29 for the sources directory.  On Fedora 17, the default RPM _topdir is
30 $HOME/rpmbuild and the default RPM sources directory is
31 $HOME/rpmbuild/SOURCES.
32
33 1. If you are building from a distribution tarball, skip to step 2.
34    Otherwise, you must be building from an Open vSwitch Git tree.
35    Create a distribution tarball from the root of the Git tree by
36    running:
37
38        ```
39        ./boot.sh
40        ./configure
41        make dist
42            ```
43
44 2. Now you have a distribution tarball, named something like
45    openvswitch-x.y.z.tar.gz.  Copy this file into the RPM sources
46    directory, e.g.:
47
48        `cp openvswitch-x.y.z.tar.gz $HOME/rpmbuild/SOURCES`
49
50 3. Make another copy of the distribution tarball in a temporary
51    directory.  Then unpack the tarball and "cd" into its root, e.g.:
52
53        ```
54        tar xzf openvswitch-x.y.z.tar.gz
55        cd openvswitch-x.y.z
56            ```
57
58 4. To build Open vSwitch userspace, run:
59
60        `rpmbuild -bb rhel/openvswitch-fedora.spec`
61
62    This produces one RPM: "openvswitch".
63
64    The above command automatically runs the Open vSwitch unit tests.
65    To disable the unit tests, run:
66
67        `rpmbuild -bb --without check rhel/openvswitch-fedora.spec`
68
69 5. On Fedora 17, to build the Open vSwitch kernel module, run:
70
71         `rpmbuild -bb rhel/openvswitch-kmod-fedora.spec`
72
73     You might have to specify a kernel version and/or variants, e.g.:
74
75         ```
76         rpmbuild -bb \
77                 -D "kversion 2.6.32-131.6.1.el6.x86_64" \
78                 -D "kflavors default debug kdump" \
79                 rhel/openvswitch-kmod-rhel6.spec
80         ```
81
82     This produces an "kmod-openvswitch" RPM for each kernel variant,
83     in this example: "kmod-openvswitch", "kmod-openvswitch-debug", and
84     "kmod-openvswitch-kdump".
85
86 Reporting Bugs
87 --------------
88
89 Please report problems to bugs@openvswitch.org.