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
  35 ----------------------------
  36
  37 To use ovs-vswitchd in userspace mode, give the bridge a name that
  38 begins with "netdev:" in the configuration file.  For example:
  39
  40     bridge.netdev:br0.port=eth0
  41     bridge.netdev:br0.port=eth1
  42     bridge.netdev:br0.port=eth2
  43
  44 ovs-vswitchd will create a TAP device as the bridge's local interface,
  45 named the same as the bridge minus the "netdev:" prefix, as well as
  46 for each configured internal interface.
  47
  48 Bug Reporting
  49 -------------
  50
  51 Please report problems to bugs@openvswitch.org.