aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2009-11-18 12:57:18 -0800
committerBen Pfaff <blp@nicira.com>2009-11-18 12:57:18 -0800
commitd377243b8557ae8e6c1d374d76b6ee29fd61ceb4 (patch)
tree737b13cad74b452ba09b1f4f401f1afdae973d87 /README
parent37c9895288d0f2f8517da4db0df17a004f1faa37 (diff)
Document userspace switch.
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 12 insertions, 3 deletions
diff --git a/README b/README
index 2bdbfdcf..7871c763 100644
--- a/README
+++ b/README
@@ -28,9 +28,15 @@ vSwitch supports the following features:
* Support for OpenFlow
* Compatibility layer for the Linux bridging code
-Open vSwitch supports Linux 2.6.15 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.
+The included Linux kernel module supports Linux 2.6.15 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.
+
+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?
------------
@@ -85,6 +91,9 @@ read INSTALL.bridge.
To build RPMs for installing Open vSwitch on a Citrix XenServer host
or resource pool, read INSTALL.XenServer.
+To install Open vSwitch without using a kernel module, read
+INSTALL.userspace.
+
To learn set up SSL support for Open vSwitch, read INSTALL.SSL.
Each Open vSwitch userspace program is accompanied by a manpage. Many