X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README;h=a57bb621e16e97c35b2be5ddc8aa85d87dcfcae6;hb=d017eeb9f9ebcb46c24a67fd301b3e36cd26a04e;hp=dddad3f686217d02f6a28ea669efef47835f7ea6;hpb=c434706a374bd44d1274e7bdbee40067a6620b61;p=sliver-openvswitch.git diff --git a/README b/README index dddad3f68..a57bb621e 100644 --- a/README +++ b/README @@ -22,13 +22,12 @@ 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, VXLAN, and LISP 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 @@ -52,11 +51,6 @@ 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 for Citrix XenServer and Red @@ -88,25 +82,30 @@ 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 as a drop-in replacement for the Linux bridge, -read INSTALL.bridge. +To use Open vSwitch... -To build RPMs for installing Open vSwitch on a Citrix XenServer host -or resource pool, read INSTALL.XenServer. + - ...with KVM on Linux, read INSTALL, read INSTALL.KVM. -To build RPMs for installing Open vSwitch on a Red Hat Enterprise -Linux host, read INSTALL.RHEL. + - ...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. +To learn about some advanced features of the Open vSwitch software +switch, read the tutorial in tutorial/Tutorial. + Each Open vSwitch userspace program is accompanied by a manpage. Many of the manpages are customized to your configuration as part of the build process, so we recommend building Open vSwitch before reading