X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README;h=dc5f05e2ca682613e248048ce274c9fc64f20d59;hb=0f5293d8a5cadcc2111e38fd79f3d39f5c83cebc;hp=d23636d598f31fc728144a0d1d735f1297982cce;hpb=045b2e5c77d02cd0d7bba046e2dbed72ec4828c8;p=sliver-openvswitch.git diff --git a/README b/README index d23636d59..dc5f05e2c 100644 --- a/README +++ b/README @@ -22,18 +22,18 @@ 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 + * NetFlow, sFlow(R), and mirroring for increased visibility * QoS (Quality of Service) configuration, plus policing - * GRE, GRE over IPSEC, and CAPWAP tunneling + * GRE, GRE over IPSEC, CAPWAP, and VXLAN 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 hosts. +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 @@ -51,16 +51,12 @@ The main components of this distribution are: * 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 that allow Open vSwitch - to be installed on a Citrix XenServer host as a drop-in - replacement for its switch, with additional functionality. + * 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. @@ -86,19 +82,24 @@ Open vSwitch also provides some tools: What other documentation is available? -------------------------------------- -To install Open vSwitch on a regular Linux machine, read INSTALL.Linux. +To install Open vSwitch on a regular Linux or FreeBSD host, please +read INSTALL. For specifics around installation on a specific +platform, please see one of these files: + + - INSTALL.Debian + - INSTALL.Fedora + - INSTALL.RHEL + - INSTALL.XenServer + +To use Open vSwitch... -To use Open vSwitch as a drop-in replacement for the Linux bridge, -read INSTALL.bridge. + - ...with KVM on Linux, read INSTALL, read INSTALL.KVM. -To build RPMs for installing Open vSwitch on a Citrix XenServer host -or resource pool, read INSTALL.XenServer. + - ...with Libvirt, read INSTALL.Libvirt. -To use Open vSwitch with KVM on Linux, read INSTALL.Linux, then -INSTALL.KVM. + - ...without using a kernel module, read INSTALL.userspace. -To install Open vSwitch without using a kernel module, read -INSTALL.userspace. +For answers to common questions, read FAQ. To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.