Skip to content

Commit

Permalink
Update top-level documentation to bring it up to date with latest fea…
Browse files Browse the repository at this point in the history
…tures.
  • Loading branch information
blp committed Apr 6, 2011
1 parent 773cd53 commit c9d3af4
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 20 deletions.
2 changes: 1 addition & 1 deletion INSTALL.KVM
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This document describes how to use Open vSwitch with the Kernel-based
Virtual Machine (KVM). This document assumes that you have read and
followed INSTALL.Linux to get Open vSwitch setup on your Linux system
followed INSTALL.Linux to get Open vSwitch setup on your Linux system.

Setup
-----
Expand Down
17 changes: 15 additions & 2 deletions INSTALL.Linux
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ INSTALL.userspace for more information.
be compiled with IPv6 support (CONFIG_IPV6). This allows for
special handling (such as path MTU discovery) of IPv6 packets.

To configure HTB or HFSC quality of service with Open vSwitch,
you must enable the respective configuration options.

To use Open vSwitch support for TAP devices, you must enable
CONFIG_TUN.

Expand All @@ -67,8 +70,8 @@ INSTALL.userspace for more information.
infrastructure.

If you are working from a Git tree or snapshot (instead of from a
distribution tarball), or if you modify the Open vSwitch build system,
you will also need the following software:
distribution tarball), or if you modify the Open vSwitch build system
or the database schema, you will also need the following software:

- Autoconf version 2.64 or later.

Expand All @@ -81,12 +84,22 @@ following:

- pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).

To run the unit tests, you also need:

- Perl. Version 5.10.1 is known to work. Earlier versions should
also work.

If you modify the vswitchd database schema, then the E-R diagram in
the ovs-vswitchd.conf.db(5) manpage will be updated properly only if
you have the following:

- "dot" from graphviz (http://www.graphviz.org/).

- Perl. Version 5.10.1 is known to work. Earlier versions should
also work.

- Python 2.x, for x >= 4.

Installation Requirements
-------------------------

Expand Down
8 changes: 4 additions & 4 deletions INSTALL.OpenFlow
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ OpenFlow switch.

% insmod datapath/linux-2.6/openvswitch_mod.ko

This kernel module cannot be loaded if the Linux bridge module is
already loaded. Thus, you may need to remove any existing bridges
and unload the bridge module with "rmmod bridge" before you can do
this.
If your Linux kernel is earlier than 2.6.36, this kernel module
cannot be loaded if the Linux bridge module is already loaded.
Thus, you may need to remove any existing bridges and unload the
bridge module with "rmmod bridge" before you can do this.

3. Create a datapath instance. The command below creates a datapath
identified as dp0 (see ovs-dpctl(8) for more detailed usage
Expand Down
27 changes: 14 additions & 13 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ 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
(e.g. NetFlow, sFlow(R), RSPAN, ERSPAN, IOS-like CLI), and opens the
forwarding functions to programmatic extension and control.
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
Expand All @@ -20,19 +20,20 @@ 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:

* Visibility into inter-VM communication via NetFlow, sFlow, SPAN,
and RSPAN
* Standard 802.1Q VLAN model with trunking
* Per VM policing
* NIC bonding with source-MAC load balancing
* Kernel-based forwarding
* Support for OpenFlow
* Compatibility layer for the Linux bridging code
* 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.18 with Centos and Xen patches and version
2.6.26 from kernel.org. Open vSwitch also has special support for
Citrix XenServer hosts.
testing focused on 2.6.32 with Centos and Xen patches. Open vSwitch
also has special support for Citrix XenServer hosts.

Open vSwitch can also operate, at a cost in performance, entirely in
userspace, without assistance from a kernel module. This userspace
Expand Down

0 comments on commit c9d3af4

Please sign in to comment.