Minor documentation fixups.
[sliver-openvswitch.git] / 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, RSPAN, ERSPAN, IOS-like CLI), and opens the forwarding
10 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, SPAN, and RSPAN
24     * Standard 802.1Q VLAN model with trunking
25     * Per VM policing
26     * NIC bonding with source-MAC load balancing
27     * Kernel-based forwarding
28     * Support for OpenFlow
29     * Compatibility layer for the Linux bridging code
30
31 Open vSwitch supports Linux 2.6.15 and up, with testing focused on
32 2.6.18 with Centos and Xen patches and version 2.6.26 from kernel.org.
33 Open vSwitch also has special support for Citrix XenServer hosts.
34
35 What's here?
36 ------------
37
38 The main components of this distribution are:
39
40     * ovs-vswitchd, a daemon that implements the switch, along with 
41       a companion Linux kernel module for flow-based switching.
42
43     * ovs-brcompatd, a daemon that allows ovs-vswitchd to act as a
44       drop-in replacement for the Linux bridge in many environments, 
45       along with a companion Linux kernel module to intercept bridge 
46       ioctls.
47
48     * ovs-dpctl, a tool for configuring the switch kernel module.
49
50     * Scripts and specs for building RPMs that allow Open vSwitch
51       to be installed on a Citrix XenServer host as a drop-in
52       replacement for its switch, with additional functionality.
53
54     * ovs-appctl, a utility that can control Open vSwitch daemons,
55       adjusting their logging levels among other uses.
56
57 Open vSwitch also provides an OpenFlow implementation and tools for
58 those interested in OpenFlow but not additional Open vSwitch features:
59
60     * ovs-openflowd, a program that implements a simple OpenFlow
61       switch (without the special features provided by ovs-vswitchd)
62       using the same kernel module as ovs-vswitchd.
63
64     * ovs-controller, a simple OpenFlow controller.
65
66     * ovs-ofctl, a utility for querying and controlling OpenFlow
67       switches and controllers.
68
69     * ovs-pki, a utility for creating and managing the public-key
70       infrastructure for OpenFlow switches.
71
72     * A patch to tcpdump that enables it to parse OpenFlow messages.
73
74 What other documentation is available?
75 --------------------------------------
76
77 To install Open vSwitch on a regular Linux machine, read INSTALL.Linux.
78
79 To use Open vSwitch as a drop-in replacement for the Linux bridge,
80 read INSTALL.bridge.
81
82 To build RPMs for installing Open vSwitch on a Citrix XenServer host
83 or resource pool, read INSTALL.XenServer.
84
85 To learn set up SSL support for Open vSwitch, read INSTALL.SSL.
86
87 Each Open vSwitch userspace program is accompanied by a manpage.  Many
88 of the manpages are customized to your configuration as part of the
89 build process, so we recommend building Open vSwitch before reading
90 the manpages.
91
92 Contact 
93 -------
94
95 bugs@openvswitch.org
96 http://openvswitch.org/