From: Ben Pfaff Date: Tue, 4 Dec 2012 15:39:59 +0000 (-0800) Subject: INSTALL.Debian: New instructions for installing on Debian. X-Git-Tag: sliver-openvswitch-1.9.90-3~10^2~124 X-Git-Url: http://git.onelab.eu/?p=sliver-openvswitch.git;a=commitdiff_plain;h=6494ea4c962118de72410f62045603279eb967da INSTALL.Debian: New instructions for installing on Debian. Signed-off-by: Ben Pfaff --- diff --git a/INSTALL b/INSTALL index 4d94c52a7..275e86e3a 100644 --- a/INSTALL +++ b/INSTALL @@ -2,12 +2,13 @@ ================================================ This document describes how to build and install Open vSwitch on a -generic Linux or FreeBSD host. If you want to install Open vSwitch on -a Citrix XenServer, see INSTALL.XenServer instead. +generic Linux or FreeBSD host. For specifics around installation on a +specific platform, please see one of these files: -This version of Open vSwitch may be built manually with "configure" -and "make", as described below. You may also build Debian packages by -running "dpkg-buildpackage". + - INSTALL.Debian + - INSTALL.Fedora + - INSTALL.RHEL + - INSTALL.XenServer Build Requirements ------------------ diff --git a/INSTALL.Debian b/INSTALL.Debian new file mode 100644 index 000000000..62f4c196c --- /dev/null +++ b/INSTALL.Debian @@ -0,0 +1,125 @@ + How to Build Debian Packages for Open vSwitch + ============================================= + +This document describes how to build Debian packages for Open vSwitch. +To install Open vSwitch on Debian without building Debian packages, +see INSTALL instead. + +These instructions should also work on Ubuntu and other Debian +derivative distributions. + + +Before You Begin +---------------- + +Before you begin, consider whether you really need to build packages +yourself. Debian "wheezy" and "sid", as well as recent versions of +Ubuntu, contain pre-built Debian packages for Open vSwitch. It is +easier to install these than to build your own. To use packages from +your distribution, skip ahead to "Installing .deb Packages", below. + + +Building Open vSwitch Debian packages +------------------------------------- + +You may build from an Open vSwitch distribution tarball or from an +Open vSwitch Git tree with these instructions. + +You do not need to be the superuser to build the Debian packages. + +1. Install the "build-essential" and "fakeroot" packages, e.g. with + "apt-get install build-essential fakeroot". + +2. Obtain and unpack an Open vSwitch source distribution and "cd" into + its top level directory. + +3. Install the build dependencies listed under "Build-Depends:" near + the top of debian/rules. You can install these any way you like, + e.g. with "apt-get install". + + Check your work by running "dpkg-checkbuilddeps". If you've + installed all the dependencies properly, dpkg-checkbuilddeps will + exit without printing anything. If you forgot to install some + dependencies, it will tell you which ones. + +4. Run: + + fakeroot debian/rules binary + + This will do a serial build that runs the unit tests. If you + prefer, you can run a faster parallel build, e.g.: + + DEB_BUILD_OPTIONS='parallel=8' fakeroot debian/rules binary + + If you are in a big hurry, you can even skip the unit tests: + + DEB_BUILD_OPTIONS='parallel=8 nocheck' fakeroot debian/rules binary + +5. The generated .deb files will be in the parent directory of the + Open vSwitch source distribution. + + +Installing .deb Packages +------------------------ + +These instructions apply to installing from Debian packages that you +built yourself, as described in the previous section, or from packages +provided by Debian or a Debian derivative distribution such as Ubuntu. +In the former case, use a command such as "dpkg -i" to install the +.deb files that you build, and in the latter case use a program such +as "apt-get" or "aptitude" to download and install the provided +packages. + +You must be superuser to install Debian packages. + +1. Start by installing the "openvswitch-switch" and + "openvswitch-common" packages. These packages include the core + userspace components of the switch. + +2. Install an Open vSwitch kernel module. There are multiple ways to + do this. In order of increasing manual effort, these are: + + * Use a Linux kernel 3.3 or later, which has an integrated Open + vSwitch kernel module. + + The upstream Linux kernel module lacks a few features that + are in the third-party module. For details, please see the + FAQ, "What features are not available in the Open vSwitch + kernel datapath that ships as part of the upstream Linux + kernel?". + + * Install the "openvswitch-datapath-dkms" Debian package that + you built earlier. This should automatically build and + install the Open vSwitch kernel module for your running + kernel. + + This option requires that you have a compiler and toolchain + installed on the machine where you run Open vSwitch, which + may be unacceptable in some production server environments. + + * Install the "openvswitch-datapath-source" Debian package, use + "module-assistant" to build a Debian package of the Open + vSwitch kernel module for your kernel, and then install that + Debian package. + + You can install the kernel module Debian packages that you + build this way on the same machine where you built it or on + another machine or machines, which means that you don't + necessarily have to have any build infrastructure on the + machines where you use the kernel module. + + /usr/share/doc/openvswitch-datapath-source/README.Debian has + details on the build process. + + * Build and install the kernel module by hand. + +Open vSwitch .deb packages not mentioned above are rarely useful. +Please refer to their individual package descriptions to find out +whether any of them are useful to you. + + +Bug Reporting +------------- + +Please report problems to bugs@openvswitch.org. + diff --git a/Makefile.am b/Makefile.am index b71ca1fab..e2e0aa40d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -43,6 +43,7 @@ EXTRA_DIST = \ DESIGN \ FAQ \ INSTALL \ + INSTALL.Debian \ INSTALL.Fedora \ INSTALL.KVM \ INSTALL.Libvirt \ diff --git a/README b/README index 7c680d490..b0e6d05f9 100644 --- a/README +++ b/README @@ -88,26 +88,27 @@ Open vSwitch also provides some tools: What other documentation is available? -------------------------------------- -To install Open vSwitch on a regular Linux machine, read INSTALL. +To install Open vSwitch on a regular Linux or FreeBSD host, please +read INSTALL. For specifics around installation on a specific +platform, please see one of these files: -For answers to common questions, read FAQ. + - INSTALL.Debian + - INSTALL.Fedora + - INSTALL.RHEL + - INSTALL.XenServer -To use Open vSwitch as a drop-in replacement for the Linux bridge, -read INSTALL.bridge. +To use Open vSwitch... -To build RPMs for installing Open vSwitch on a Citrix XenServer host -or resource pool, read INSTALL.XenServer. + - ...with KVM on Linux, read INSTALL, read INSTALL.KVM. -To build RPMs for installing Open vSwitch on a Red Hat Enterprise -Linux host, read INSTALL.RHEL. + - ...with Libvirt, read INSTALL.Libvirt. -To use Open vSwitch with KVM on Linux, read INSTALL, then -INSTALL.KVM. + - ...as a drop-in replacement for the Linux bridge, read + INSTALL.bridge. -To use Open vSwitch with Libvirt, read INSTALL.Libvirt. + - ...without using a kernel module, read INSTALL.userspace. -To install Open vSwitch without using a kernel module, read -INSTALL.userspace. +For answers to common questions, read FAQ. To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.