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 and opens the forwarding functions to programmatic extension and
  10 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     * Standard 802.1Q VLAN model with trunk and access ports
  24     * NIC bonding with or without LACP on upstream switch
  25     * NetFlow, sFlow(R), SPAN, RSPAN, and ERSPAN for increased visibility
  26     * QoS (Quality of Service) configuration, plus policing
  27     * GRE, GRE over IPSEC, and CAPWAP tunneling
  28     * 802.1ag connectivity fault management
  29     * OpenFlow 1.0 plus numerous extensions
  30     * Transactional configuration database with C and Python bindings
  31     * Compatibility layer for Linux bridging code
  32     * High-performance forwarding using a Linux kernel module
  33
  34 The included Linux kernel module supports Linux 2.6.18 and up, with
  35 testing focused on 2.6.32 with Centos and Xen patches.  Open vSwitch
  36 also has special support for Citrix XenServer hosts.
  37
  38 Open vSwitch can also operate, at a cost in performance, entirely in
  39 userspace, without assistance from a kernel module.  This userspace
  40 implementation should be easier to port than the kernel-based switch.
  41 It is considered experimental.
  42
  43 What's here?
  44 ------------
  45
  46 The main components of this distribution are:
  47
  48     * ovs-vswitchd, a daemon that implements the switch, along with
  49       a companion Linux kernel module for flow-based switching.
  50
  51     * ovsdb-server, a lightweight database server that ovs-vswitchd
  52       queries to obtain its configuration.
  53
  54     * ovs-brcompatd, a daemon that allows ovs-vswitchd to act as a
  55       drop-in replacement for the Linux bridge in many environments,
  56       along with a companion Linux kernel module to intercept bridge
  57       ioctls.
  58
  59     * ovs-dpctl, a tool for configuring the switch kernel module.
  60
  61     * Scripts and specs for building RPMs that allow Open vSwitch
  62       to be installed on a Citrix XenServer host as a drop-in
  63       replacement for its switch, with additional functionality.
  64
  65     * ovs-vsctl, a utility for querying and updating the configuration
  66       of ovs-vswitchd.
  67
  68     * ovs-appctl, a utility that sends commands to running Open
  69       vSwitch daemons.
  70
  71     * ovsdbmonitor, a GUI tool for remotely viewing OVS databases and
  72       OpenFlow flow tables.
  73
  74 Open vSwitch also provides an OpenFlow implementation and tools for
  75 those interested in OpenFlow but not additional Open vSwitch features:
  76
  77     * ovs-openflowd, an alternative to ovs-vswitchd that implements a
  78       simple OpenFlow switch, without the special features provided by
  79       ovs-vswitchd.
  80
  81     * ovs-controller, a simple OpenFlow controller.
  82
  83     * ovs-ofctl, a utility for querying and controlling OpenFlow
  84       switches and controllers.
  85
  86     * ovs-pki, a utility for creating and managing the public-key
  87       infrastructure for OpenFlow switches.
  88
  89     * A patch to tcpdump that enables it to parse OpenFlow messages.
  90
  91 What other documentation is available?
  92 --------------------------------------
  93
  94 To install Open vSwitch on a regular Linux machine, read INSTALL.Linux.
  95
  96 To use Open vSwitch as a drop-in replacement for the Linux bridge,
  97 read INSTALL.bridge.
  98
  99 To build RPMs for installing Open vSwitch on a Citrix XenServer host
 100 or resource pool, read INSTALL.XenServer.
 101
 102 To use Open vSwitch with KVM on Linux, read INSTALL.Linux, then
 103 INSTALL.KVM.
 104
 105 To install Open vSwitch without using a kernel module, read
 106 INSTALL.userspace.
 107
 108 To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.
 109
 110 Each Open vSwitch userspace program is accompanied by a manpage.  Many
 111 of the manpages are customized to your configuration as part of the
 112 build process, so we recommend building Open vSwitch before reading
 113 the manpages.
 114
 115 Contact
 116 -------
 117
 118 bugs@openvswitch.org
 119 http://openvswitch.org/