README

   1                  Open vSwitch <http://openvswitch.org>
   2
   3 What is Open vSwitch?
   4 ---------------------
   5
   6 Open vSwitch is a multilayer software switch licensed under the open
   7 source Apache 2 license.  Our goal is to implement a production
   8 quality switch platform that supports standard management interfaces
   9 (e.g. NetFlow, sFlow(R), RSPAN, ERSPAN, IOS-like CLI), and opens the
  10 forwarding functions to programmatic extension and control.
  11
  12 Open vSwitch is well suited to function as a virtual switch in VM
  13 environments.  In addition to exposing standard control and visibility
  14 interfaces to the virtual networking layer, it was designed to support
  15 distribution across multiple physical servers.  Open vSwitch supports
  16 multiple Linux-based virtualization technologies including
  17 Xen/XenServer, KVM, and VirtualBox.
  18
  19 The bulk of the code is written in platform-independent C and is
  20 easily ported to other environments.  The current release of Open
  21 vSwitch supports the following features:
  22
  23     * Visibility into inter-VM communication via NetFlow, sFlow, SPAN,
  24       and RSPAN
  25     * Standard 802.1Q VLAN model with trunking
  26     * Per VM policing
  27     * NIC bonding with source-MAC load balancing
  28     * Kernel-based forwarding
  29     * Support for OpenFlow
  30     * Compatibility layer for the Linux bridging code
  31
  32 The included Linux kernel module supports Linux 2.6.18 and up, with
  33 testing focused on 2.6.18 with Centos and Xen patches and version
  34 2.6.26 from kernel.org.  Open vSwitch also has special support for
  35 Citrix XenServer hosts.
  36
  37 Open vSwitch can also operate, at a cost in performance, entirely in
  38 userspace, without assistance from a kernel module.  This userspace
  39 implementation should be easier to port than the kernel-based switch.
  40 It is considered experimental.
  41
  42 What's here?
  43 ------------
  44
  45 The main components of this distribution are:
  46
  47     * ovs-vswitchd, a daemon that implements the switch, along with
  48       a companion Linux kernel module for flow-based switching.
  49
  50     * ovsdb-server, a lightweight database server that ovs-vswitchd
  51       queries to obtain its configuration.
  52
  53     * ovs-brcompatd, a daemon that allows ovs-vswitchd to act as a
  54       drop-in replacement for the Linux bridge in many environments,
  55       along with a companion Linux kernel module to intercept bridge
  56       ioctls.
  57
  58     * ovs-dpctl, a tool for configuring the switch kernel module.
  59
  60     * Scripts and specs for building RPMs that allow Open vSwitch
  61       to be installed on a Citrix XenServer host as a drop-in
  62       replacement for its switch, with additional functionality.
  63
  64     * ovs-vsctl, a utility for querying and updating the configuration
  65       of ovs-vswitchd.
  66
  67     * ovs-appctl, a utility that sends commands to running Open
  68       vSwitch daemons.
  69
  70     * ovsdbmonitor, a GUI tool for remotely viewing OVS databases and
  71       OpenFlow flow tables.
  72
  73 Open vSwitch also provides an OpenFlow implementation and tools for
  74 those interested in OpenFlow but not additional Open vSwitch features:
  75
  76     * ovs-openflowd, an alternative to ovs-vswitchd that implements a
  77       simple OpenFlow switch, without the special features provided by
  78       ovs-vswitchd.
  79
  80     * ovs-controller, a simple OpenFlow controller.
  81
  82     * ovs-ofctl, a utility for querying and controlling OpenFlow
  83       switches and controllers.
  84
  85     * ovs-pki, a utility for creating and managing the public-key
  86       infrastructure for OpenFlow switches.
  87
  88     * A patch to tcpdump that enables it to parse OpenFlow messages.
  89
  90 What other documentation is available?
  91 --------------------------------------
  92
  93 To install Open vSwitch on a regular Linux machine, read INSTALL.Linux.
  94
  95 To use Open vSwitch as a drop-in replacement for the Linux bridge,
  96 read INSTALL.bridge.
  97
  98 To build RPMs for installing Open vSwitch on a Citrix XenServer host
  99 or resource pool, read INSTALL.XenServer.
 100
 101 To use Open vSwitch with KVM on Linux, read INSTALL.Linux, then
 102 INSTALL.KVM.
 103
 104 To install Open vSwitch without using a kernel module, read
 105 INSTALL.userspace.
 106
 107 To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.
 108
 109 Each Open vSwitch userspace program is accompanied by a manpage.  Many
 110 of the manpages are customized to your configuration as part of the
 111 build process, so we recommend building Open vSwitch before reading
 112 the manpages.
 113
 114 Contact
 115 -------
 116
 117 bugs@openvswitch.org
 118 http://openvswitch.org/