smap: New functions smap_from_json(), smap_to_json().
[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 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), and mirroring 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 and Red Hat Enterprise
37 Linux hosts.
38
39 Open vSwitch can also operate, at a cost in performance, entirely in
40 userspace, without assistance from a kernel module.  This userspace
41 implementation should be easier to port than the kernel-based switch.
42 It is considered experimental.
43
44 What's here?
45 ------------
46
47 The main components of this distribution are:
48
49     * ovs-vswitchd, a daemon that implements the switch, along with 
50       a companion Linux kernel module for flow-based switching.
51
52     * ovsdb-server, a lightweight database server that ovs-vswitchd
53       queries to obtain its configuration.
54
55     * ovs-brcompatd, a daemon that allows ovs-vswitchd to act as a
56       drop-in replacement for the Linux bridge in many environments, 
57       along with a companion Linux kernel module to intercept bridge 
58       ioctls.
59
60     * ovs-dpctl, a tool for configuring the switch kernel module.
61
62     * Scripts and specs for building RPMs for Citrix XenServer and Red
63       Hat Enterprise Linux.  The XenServer RPMs allow Open vSwitch to
64       be installed on a Citrix XenServer host as a drop-in replacement
65       for its switch, with additional functionality.
66
67     * ovs-vsctl, a utility for querying and updating the configuration
68       of ovs-vswitchd.
69
70     * ovs-appctl, a utility that sends commands to running Open
71       vSwitch daemons.
72
73     * ovsdbmonitor, a GUI tool for remotely viewing OVS databases and
74       OpenFlow flow tables.
75
76 Open vSwitch also provides some tools:
77
78     * ovs-controller, a simple OpenFlow controller.
79
80     * ovs-ofctl, a utility for querying and controlling OpenFlow
81       switches and controllers.
82
83     * ovs-pki, a utility for creating and managing the public-key
84       infrastructure for OpenFlow switches.
85
86     * A patch to tcpdump that enables it to parse OpenFlow messages.
87
88 What other documentation is available?
89 --------------------------------------
90
91 To install Open vSwitch on a regular Linux machine, read INSTALL.Linux.
92
93 For answers to common questions, read FAQ.
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 build RPMs for installing Open vSwitch on a Red Hat Enterprise
102 Linux host, read INSTALL.RHEL.
103
104 To use Open vSwitch with KVM on Linux, read INSTALL.Linux, then
105 INSTALL.KVM.
106
107 To use Open vSwitch with Libvirt, read INSTALL.Libvirt.
108
109 To install Open vSwitch without using a kernel module, read
110 INSTALL.userspace.
111
112 To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.
113
114 Each Open vSwitch userspace program is accompanied by a manpage.  Many
115 of the manpages are customized to your configuration as part of the
116 build process, so we recommend building Open vSwitch before reading
117 the manpages.
118
119 Contact 
120 -------
121
122 bugs@openvswitch.org
123 http://openvswitch.org/