]> git.proxmox.com Git - ovs.git/blame - INSTALL.Debian.md
ovn: Fix receive from vxlan in ovn-controller.
[ovs.git] / INSTALL.Debian.md
CommitLineData
542cc9bb
TG
1How to Build Debian Packages for Open vSwitch
2=============================================
6494ea4c
BP
3
4This document describes how to build Debian packages for Open vSwitch.
5To install Open vSwitch on Debian without building Debian packages,
9feb1017 6see [INSTALL.md] instead.
6494ea4c
BP
7
8These instructions should also work on Ubuntu and other Debian
9derivative distributions.
10
11
12Before You Begin
13----------------
14
15Before you begin, consider whether you really need to build packages
16yourself. Debian "wheezy" and "sid", as well as recent versions of
17Ubuntu, contain pre-built Debian packages for Open vSwitch. It is
18easier to install these than to build your own. To use packages from
19your distribution, skip ahead to "Installing .deb Packages", below.
20
21
22Building Open vSwitch Debian packages
23-------------------------------------
24
25You may build from an Open vSwitch distribution tarball or from an
26Open vSwitch Git tree with these instructions.
27
28You do not need to be the superuser to build the Debian packages.
29
301. Install the "build-essential" and "fakeroot" packages, e.g. with
542cc9bb 31 `apt-get install build-essential fakeroot`.
6494ea4c 32
542cc9bb 332. Obtain and unpack an Open vSwitch source distribution and `cd` into
6494ea4c
BP
34 its top level directory.
35
363. Install the build dependencies listed under "Build-Depends:" near
a5d3041c 37 the top of debian/control. You can install these any way you like,
542cc9bb 38 e.g. with `apt-get install`.
6494ea4c 39
542cc9bb 40 Check your work by running `dpkg-checkbuilddeps` in the top level of
a5d3041c
KS
41 your ovs directory. If you've installed all the dependencies
42 properly, dpkg-checkbuilddeps will exit without printing anything.
43 If you forgot to install some dependencies, it will tell you which ones.
6494ea4c
BP
44
454. Run:
46
542cc9bb 47 `fakeroot debian/rules binary`
6494ea4c 48
a5d3041c
KS
49 This will do a serial build that runs the unit tests. This will take
50 approximately 8 to 10 minutes. If you prefer, you can run a faster
51 parallel build, e.g.:
6494ea4c 52
542cc9bb 53 `DEB_BUILD_OPTIONS='parallel=8' fakeroot debian/rules binary`
6494ea4c
BP
54
55 If you are in a big hurry, you can even skip the unit tests:
56
542cc9bb 57 `DEB_BUILD_OPTIONS='parallel=8 nocheck' fakeroot debian/rules binary`
6494ea4c 58
6dcc2d0b
BP
59 (There are a few pitfalls in the Debian packaging building system
60 so that, occasionally, you may find that in a tree that you have
61 using for a while, the build command above exits immediately
62 without actually building anything. To fix the problem, run
63
64 `fakeroot debian/rules clean`
65
66 or start over from a fresh copy of the source tree.)
67
6494ea4c
BP
685. The generated .deb files will be in the parent directory of the
69 Open vSwitch source distribution.
70
71
72Installing .deb Packages
73------------------------
74
75These instructions apply to installing from Debian packages that you
76built yourself, as described in the previous section, or from packages
77provided by Debian or a Debian derivative distribution such as Ubuntu.
542cc9bb 78In the former case, use a command such as `dpkg -i` to install the
6494ea4c 79.deb files that you build, and in the latter case use a program such
542cc9bb 80as `apt-get` or `aptitude` to download and install the provided
6494ea4c
BP
81packages.
82
83You must be superuser to install Debian packages.
84
f085ba1e
BP
851. Start by installing an Open vSwitch kernel module. See
86 debian/openvswitch-switch.README.Debian for the available options.
6494ea4c 87
ff23db30
GS
882. Install the "openvswitch-switch" and "openvswitch-common" packages.
89 These packages include the core userspace components of the switch.
90
6494ea4c
BP
91Open vSwitch .deb packages not mentioned above are rarely useful.
92Please refer to their individual package descriptions to find out
93whether any of them are useful to you.
94
95
96Bug Reporting
97-------------
98
99Please report problems to bugs@openvswitch.org.
100
9feb1017 101[INSTALL.md]:INSTALL.md