C Python Shell Perl
Failed to load latest commit information.
build-aux openflow: Use types and accessors for half-aligned 64-bit fields. Feb 5, 2011
datapath datapath: Always use generic stats for devices (vports) Sep 15, 2011
debian Debian: fail gracefully if modules can't be loaded on install Sep 12, 2011
include datapath: Always use generic stats for devices (vports) Sep 16, 2011
lib datapath: Always use generic stats for devices (vports) Sep 16, 2011
m4 datapath: Always use generic stats for devices (vports) Sep 16, 2011
ofproto Set MTU in userspace rather than kernel. Sep 15, 2011
ovsdb Mark "uninstall-local" targets phony. Sep 15, 2011
python/ovs Mark "uninstall-local" targets phony. Sep 15, 2011
rhel rhel: Fix "make distcheck" failure due to regenerating spec files. Sep 15, 2011
tests Implement new "learn" action. Sep 13, 2011
third-party Update primary code license to Apache 2.0. Jun 15, 2009
utilities datapath: Always use generic stats for devices (vports) Sep 16, 2011
vswitchd ovs-brcompatd: Delete ports when netdevs on fake bridges disappear. Sep 15, 2011
xenserver vlog: Add a new log level "off". Aug 1, 2011
.gitignore gitignore: Add manpage-check. Aug 25, 2011
AUTHORS AUTHORS: Add Tyler Coumbes <coumbes@gmail.com>. Sep 15, 2011
COPYING xenserver: Now everything is free. Sep 22, 2010
CodingStyle CodingStyle: Clarify C dialect section and add rationale. Nov 10, 2010
DESIGN DESIGN: Move in-band control design discussion here. May 4, 2011
INSTALL.KVM Update top-level documentation to bring it up to date with latest fea… Apr 6, 2011
INSTALL.Linux INSTALL.Linux: Fix up reference to old option name --with-l26. Aug 17, 2011
INSTALL.RHEL rhel: add ability to build kmod packages for arbitrary kernel version… Sep 8, 2011
INSTALL.SSL configure: Enable OpenSSL support by default. Aug 26, 2010
INSTALL.XenServer xenserver: modify module spec file May 16, 2011
INSTALL.bridge INSTALL.bridge: Fix suggested ovs-brcompatd invocation. Jul 8, 2011
INSTALL.userspace ovs-openflowd: Rename test-openflowd and move to "tests" directory. Jun 7, 2011
Makefile.am Mark "uninstall-local" targets phony. Sep 15, 2011
NEWS Implement new "learn" action. Sep 13, 2011
NOTICE Replace SHA-1 library with one that is clearly licensed. Jun 15, 2009
PORTING PORTING: Document why OVS does not support hybrid ofproto+dpif provid… Jul 15, 2011
README Add RHEL 5/6 spec files and instructions. Jun 21, 2011
README-gcov Rework and simplify the "lcov" support for the testsuite. Feb 2, 2010
REPORTING-BUGS docs: Consistently suggest /etc/openvswitch/conf.db as location for db. Feb 10, 2011
SubmittingPatches Add new function xzalloc(n) as a shorthand for xcalloc(1, n). Nov 4, 2009
WHY-OVS WHY-OVS: New file explaining the rationale for Open vSwitch. Jun 17, 2010
acinclude.m4 datapath: Always use generic stats for devices (vports) Sep 16, 2011
boot.sh debian: Check for accurate Debian changelog version at build time too. Jul 21, 2010
configure.ac datapath: Always use generic stats for devices (vports) Sep 16, 2011
soexpand.pl Update primary code license to Apache 2.0. Jun 15, 2009

README

                 Open vSwitch <http://openvswitch.org>

What is Open vSwitch?
---------------------

Open vSwitch is a multilayer software switch licensed under the open
source Apache 2 license.  Our goal is to implement a production
quality switch platform that supports standard management interfaces
and opens the forwarding functions to programmatic extension and
control.

Open vSwitch is well suited to function as a virtual switch in VM
environments.  In addition to exposing standard control and visibility
interfaces to the virtual networking layer, it was designed to support
distribution across multiple physical servers.  Open vSwitch supports
multiple Linux-based virtualization technologies including
Xen/XenServer, KVM, and VirtualBox.

The bulk of the code is written in platform-independent C and is
easily ported to other environments.  The current release of Open
vSwitch supports the following features:

    * Standard 802.1Q VLAN model with trunk and access ports
    * NIC bonding with or without LACP on upstream switch
    * NetFlow, sFlow(R), SPAN, RSPAN, and ERSPAN for increased visibility
    * QoS (Quality of Service) configuration, plus policing
    * GRE, GRE over IPSEC, and CAPWAP tunneling
    * 802.1ag connectivity fault management
    * OpenFlow 1.0 plus numerous extensions
    * Transactional configuration database with C and Python bindings
    * Compatibility layer for Linux bridging code
    * High-performance forwarding using a Linux kernel module

The included Linux kernel module supports Linux 2.6.18 and up, with
testing focused on 2.6.32 with Centos and Xen patches.  Open vSwitch
also has special support for Citrix XenServer and Red Hat Enterprise
Linux hosts.

Open vSwitch can also operate, at a cost in performance, entirely in
userspace, without assistance from a kernel module.  This userspace
implementation should be easier to port than the kernel-based switch.
It is considered experimental.

What's here?
------------

The main components of this distribution are:

    * ovs-vswitchd, a daemon that implements the switch, along with 
      a companion Linux kernel module for flow-based switching.

    * ovsdb-server, a lightweight database server that ovs-vswitchd
      queries to obtain its configuration.

    * ovs-brcompatd, a daemon that allows ovs-vswitchd to act as a
      drop-in replacement for the Linux bridge in many environments, 
      along with a companion Linux kernel module to intercept bridge 
      ioctls.

    * ovs-dpctl, a tool for configuring the switch kernel module.

    * Scripts and specs for building RPMs for Citrix XenServer and Red
      Hat Enterprise Linux.  The XenServer RPMs allow Open vSwitch to
      be installed on a Citrix XenServer host as a drop-in replacement
      for its switch, with additional functionality.

    * ovs-vsctl, a utility for querying and updating the configuration
      of ovs-vswitchd.

    * ovs-appctl, a utility that sends commands to running Open
      vSwitch daemons.

    * ovsdbmonitor, a GUI tool for remotely viewing OVS databases and
      OpenFlow flow tables.

Open vSwitch also provides some tools:

    * ovs-controller, a simple OpenFlow controller.

    * ovs-ofctl, a utility for querying and controlling OpenFlow
      switches and controllers.

    * ovs-pki, a utility for creating and managing the public-key
      infrastructure for OpenFlow switches.

    * A patch to tcpdump that enables it to parse OpenFlow messages.

What other documentation is available?
--------------------------------------

To install Open vSwitch on a regular Linux machine, read INSTALL.Linux.

To use Open vSwitch as a drop-in replacement for the Linux bridge,
read INSTALL.bridge.

To build RPMs for installing Open vSwitch on a Citrix XenServer host
or resource pool, read INSTALL.XenServer.

To build RPMs for installing Open vSwitch on a Red Hat Enterprise
Linux host, read INSTALL.RHEL.

To use Open vSwitch with KVM on Linux, read INSTALL.Linux, then
INSTALL.KVM.

To install Open vSwitch without using a kernel module, read
INSTALL.userspace.

To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.

Each Open vSwitch userspace program is accompanied by a manpage.  Many
of the manpages are customized to your configuration as part of the
build process, so we recommend building Open vSwitch before reading
the manpages.

Contact 
-------

bugs@openvswitch.org
http://openvswitch.org/