INSTALL.userspace

   1               Using Open vSwitch without kernel support
   2               =========================================
   3
   4 Open vSwitch can operate, at a cost in performance, entirely in
   5 userspace, without assistance from a kernel module.  This file
   6 explains how to install Open vSwitch in such a mode.
   7
   8 The userspace-only mode of Open vSwitch is considered experimental.
   9 It has not been thoroughly tested.
  10
  11 This version of Open vSwitch should be built manually with "configure"
  12 and "make".  Debian packaging for Open vSwitch is also included, but
  13 it has not been recently tested, and so Debian packages are not a
  14 recommended way to use this version of Open vSwitch.
  15
  16 Building and Installing
  17 -----------------------
  18
  19 The requirements and procedure for building, installing, and
  20 configuring Open vSwitch are the same as those given in INSTALL.Linux.
  21 You may omit configuring, building, and installing the kernel module,
  22 and the related requirements.
  23
  24 On Linux, the userspace switch additionally requires the kernel
  25 TUN/TAP driver to be available, either built into the kernel or loaded
  26 as a module.  If you are not sure, check for a directory named
  27 /sys/class/misc/tun.  If it does not exist, then attempt to load the
  28 module with "modprobe tun".
  29
  30 The tun device must also exist as /dev/net/tun.  If it does not exist,
  31 then create /dev/net (if necessary) with "mkdir /dev/net", then create
  32 /dev/net/tun with "mknod /dev/net/tun c 10 200".
  33
  34 Using the Userspace Datapath with ovs-vswitchd
  35 ----------------------------------------------
  36
  37 To use ovs-vswitchd in userspace mode, create a bridge with datapath_type
  38 "netdev" in the configuration database.  For example:
  39
  40     ovs-vsctl add-br br0
  41     ovs-vsctl set bridge br0 datapath_type=netdev
  42     ovs-vsctl add-port br0 eth0
  43     ovs-vsctl add-port br0 eth1
  44     ovs-vsctl add-port br0 eth2
  45
  46 ovs-vswitchd will create a TAP device as the bridge's local interface,
  47 named the same as the bridge, as well as for each configured internal
  48 interface.
  49
  50 Using the Userspace Datapath with ovs-openflowd
  51 -----------------------------------------------
  52
  53 To use ovs-openflowd in userspace mode, specify a datapath name that
  54 begins with "netdev@", and specify --ports with the names of the ports
  55 that should be included in the datapath as argument.  For example:
  56
  57     ovs-openflowd netdev@br0 --ports=eth0,eth1,eth2
  58
  59 ovs-openflowd will create a TAP device as the bridge's local
  60 interface, named the same as the bridge minus the "netdev@" prefix.
  61
  62 Bug Reporting
  63 -------------
  64
  65 Please report problems to bugs@openvswitch.org.