forked from openvswitch/ovs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: Adding github markup and travis-ci build status to github rea…
…dme page. Signed-off-by: Pritesh Kothari <[email protected]> Signed-off-by: Ben Pfaff <[email protected]>
- Loading branch information
Showing
6 changed files
with
47 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -82,6 +82,7 @@ EXTRA_DIST = \ | |
| NOTICE \ | ||
| OPENFLOW-1.1+ \ | ||
| PORTING \ | ||
| README.md \ | ||
| README-lisp \ | ||
| REPORTING-BUGS \ | ||
| TODO \ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,9 @@ | ||
| Open vSwitch <http://openvswitch.org> | ||
| # Open vSwitch | ||
|
|
||
| Build Status: | ||
| ------------- | ||
|
|
||
| [](https://travis-ci.org/openvswitch/ovs) | ||
|
|
||
| What is Open vSwitch? | ||
| --------------------- | ||
|
|
@@ -20,15 +25,15 @@ 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: | ||
|
|
||
| * Standard 802.1Q VLAN model with trunk and access ports | ||
| * NIC bonding with or without LACP on upstream switch | ||
| * NetFlow, sFlow(R), and mirroring for increased visibility | ||
| * QoS (Quality of Service) configuration, plus policing | ||
| * Geneve, 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 | ||
| * High-performance forwarding using a Linux kernel module | ||
| * Standard 802.1Q VLAN model with trunk and access ports | ||
| * NIC bonding with or without LACP on upstream switch | ||
| * NetFlow, sFlow(R), and mirroring for increased visibility | ||
| * QoS (Quality of Service) configuration, plus policing | ||
| * Geneve, 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 | ||
| * High-performance forwarding using a Linux kernel module | ||
|
|
||
| The included Linux kernel module supports Linux 2.6.32 and up, with | ||
| testing focused on 2.6.32 with Centos and Xen patches. Open vSwitch | ||
|
|
@@ -45,37 +50,29 @@ What's here? | |
|
|
||
| The main components of this distribution are: | ||
|
|
||
| * ovs-vswitchd, a daemon that implements the switch, along with | ||
| a companion Linux kernel module for flow-based switching. | ||
|
|
||
| * ovsdb-server, a lightweight database server that ovs-vswitchd | ||
| queries to obtain its configuration. | ||
|
|
||
| * ovs-dpctl, a tool for configuring the switch kernel module. | ||
|
|
||
| * 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. | ||
|
|
||
| * ovs-appctl, a utility that sends commands to running Open | ||
| * ovs-vswitchd, a daemon that implements the switch, along with | ||
| a companion Linux kernel module for flow-based switching. | ||
| * ovsdb-server, a lightweight database server that ovs-vswitchd | ||
| queries to obtain its configuration. | ||
| * ovs-dpctl, a tool for configuring the switch kernel module. | ||
| * 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. | ||
| * ovs-appctl, a utility that sends commands to running Open | ||
| vSwitch daemons. | ||
|
|
||
| Open vSwitch also provides some tools: | ||
|
|
||
| * ovs-ofctl, a utility for querying and controlling OpenFlow | ||
| switches and controllers. | ||
|
|
||
| * ovs-pki, a utility for creating and managing the public-key | ||
| infrastructure for OpenFlow switches. | ||
|
|
||
| * ovs-testcontroller, a simple OpenFlow controller that may be useful | ||
| for testing (though not for production). | ||
|
|
||
| * A patch to tcpdump that enables it to parse OpenFlow messages. | ||
| * ovs-ofctl, a utility for querying and controlling OpenFlow | ||
| switches and controllers. | ||
| * ovs-pki, a utility for creating and managing the public-key | ||
| infrastructure for OpenFlow switches. | ||
| * ovs-testcontroller, a simple OpenFlow controller that may be useful | ||
| for testing (though not for production). | ||
| * A patch to tcpdump that enables it to parse OpenFlow messages. | ||
|
|
||
| What other documentation is available? | ||
| -------------------------------------- | ||
|
|
@@ -84,18 +81,18 @@ 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 | ||
| - INSTALL.Debian | ||
| - INSTALL.Fedora | ||
| - INSTALL.RHEL | ||
| - INSTALL.XenServer | ||
|
|
||
| To use Open vSwitch... | ||
|
|
||
| - ...with KVM on Linux, read INSTALL, read INSTALL.KVM. | ||
| - ...with KVM on Linux, read INSTALL, read INSTALL.KVM. | ||
|
|
||
| - ...with Libvirt, read INSTALL.Libvirt. | ||
| - ...with Libvirt, read INSTALL.Libvirt. | ||
|
|
||
| - ...without using a kernel module, read INSTALL.userspace. | ||
| - ...without using a kernel module, read INSTALL.userspace. | ||
|
|
||
| For answers to common questions, read FAQ. | ||
|
|
||
|
|
@@ -109,8 +106,7 @@ of the manpages are customized to your configuration as part of the | |
| build process, so we recommend building Open vSwitch before reading | ||
| the manpages. | ||
|
|
||
| Contact | ||
| Contact | ||
| ------- | ||
|
|
||
| [email protected] | ||
| http://openvswitch.org/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters