diff options
| -rw-r--r-- | README.md | 19 | ||||
| -rw-r--r-- | RELEASE.md | 200 | ||||
| -rw-r--r-- | doxygen/user_doc.md | 1 |
3 files changed, 213 insertions, 7 deletions
diff --git a/README.md b/README.md index bf26c9debc6..cf43a4df8a5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Vector Packet Processing ======================== -## Introduction. +## Introduction The VPP platform is an extensible framework that provides out-of-the-box production quality switch/router functionality. It is the open source version @@ -16,7 +16,13 @@ For more information on VPP and its features please visit the [What is VPP?](https://wiki.fd.io/view/VPP/What_is_VPP%3F) pages. -## Directory layout. +## Changes + +Details of the changes leading up to this version of VPP can be found under +@ref release_notes. + + +## Directory layout Directory name | Description ---------------------- | ------------------------------------------- @@ -25,7 +31,6 @@ Directory name | Description doxygen | Documentation generator configuration dpdk | DPDK patches and build infrastructure g2 | Event log visualization tool - gmod | perf related? perftool | Performance tool @ref plugins | VPP bundled plugins directory @ref svm | Shared virtual memory allocation library @@ -43,7 +48,7 @@ Directory name | Description ignore any @@ref labels in the above table.) -## Getting started. +## Getting started In general anyone interested in building, developing or running VPP should consult the [VPP wiki](https://wiki.fd.io/view/VPP) for more complete @@ -57,7 +62,7 @@ coverage of the topic. For the impatient, some salient information is distilled below. -### Quick-start: On an existing Linux host. +### Quick-start: On an existing Linux host To install system dependencies, build VPP and then install it, simply run the build script. This should be performed a non-privileged user with `sudo` @@ -73,7 +78,7 @@ interest. To see the available targets run: make -### Quick-start: Vagrant. +### Quick-start: Vagrant The directory `build-root/vagrant` contains a `VagrantFile` and supporting scripts to bootstrap a working VPP inside a Vagrant-managed Virtual Machine. @@ -88,7 +93,7 @@ for this can be found [on the Setting up Vagrant wiki page] (https://wiki.fd.io/view/DEV/Setting_Up_Vagrant). -## More information. +## More information Several modules provide documentation, see @subpage user_doc for more information. diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000000..3ed72d06ffa --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,200 @@ +# Release Notes {#release_notes} + +* @subpage release_notes_1701 +* @subpage release_notes_1609 +* @subpage release_notes_1606 + +@page release_notes_1701 Release notes for VPP 17.01 + +@note This release was for a while known as 16.12. +@todo Release 17.01 needs release notes. + +## Features + +## Known issues + +## Issues fixed + + +@page release_notes_1609 Release notes for VPP 16.09 + +## Features + +- [Integrated July 2016 DPDK release](http://www.dpdk.org/doc/guides/rel_notes/release_16_07.html) + - DPDK-vhost is depreciated pending a complete rework of the original integration and + addressing of rx performance deltas. + - Patches required for DPDK 16.07: + - Correctly setting the Packet Type in the IGB, IXGBE and i40e drivers. + - Correctly setting checksum in the i40e driver. + - NXP DPAA2 PMD Driver. + - rte_delay (yield) functionality. + +- Add “in tree” plugins: + - IPv6 ILA. + - iOAM. + - Load Balancer. + - SNAT. + +- High-performance (line-rate) “neutron like” L4 port-filtering. + +- API refactoring - addressing some of the issues around JVPP bindings. + - Accommodating plugins [(e.g. NSH_SFC)](https://wiki.fd.io/view/NSH_SFC) + - Binding for [python](https://wiki.fd.io/view/VPP/Python_API) + +- LISP + - L2 LISP overlays + - Multitenancy + - Multihoming + - RTR mode + - Map-resolver failover algorithm + +- Support 64-bit vector lengths, huge shared-memory segments. + +- Dynamic IP Feature ordering + - IP Features can now specify features they appear before and after + +- 16.09 Builds + - Ubuntu 14.04 LTS - Trusty Tahr + - Ubuntu 16.04 LTS - Xenial Xerus + - CentOS 7 + - More information on [VPP wiki](https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages) + +- Performance, characterize and document performance for this release + [(more information on CSIT page)](https://wiki.fd.io/view/CSIT) + + - IPv4 and IPv6 Scale - performance tests. + - Bidirectional 10k/100k/1M flows. + - 64B,570B, 1518B,9000B packet sizes. + - IPv6 iACL - performance + - DUT1 and DUT2 are configured with IPv6 routing, two static IPv6 /64 routes and IPv6 iAcl + security whitelist ingress /64 filter entries applied on links. + - TG traffic profile contains two L3 flow-groups (flow-group per direction, 253 flows per + flow-group) with all packets containing Ethernet header, IPv6 header and generated payload. + MAC addresses are matching MAC addresses of the TG node interfaces. + + - L2XC VXLANoIPv4 - performance + - DUT1 and DUT2 are configured with L2 cross-connect. VXLAN tunnels are configured between + L2XCs on DUT1 and DUT2. + - TG traffic profile contains two L3 flow-groups (flow-group per direction, 253 flows per + flow-group) with all packets containing Ethernet header, IPv4 header with IP protocol=61 + and generated payload. MAC addresses are matching MAC addresses of the TG node interfaces. + +- Documentation + - Autogenerated CLI documentation. + - Using doxygen to automate API/Node documentation. + - [(available online)](https://docs.fd.io/vpp/16.09/) + +- Resolved all static analysis issues found by Coverity + - Beginning of 16.09 cycle: 505 issues. + - Release: 0 outstanding issues. + + +## Known issues + +Issues in fd.io are tracked in [JIRA](https://jira.fd.io). + +Issue | Description +--- | --- +VPP-391 | vpp debug version assert appeared in the process of start +VPP-380 | Mapping algorithm compute wrong ea-bits when IPv4 prefix 0.0.0.0/0 +VPP-371 | load_one_plugin:63: Loaded plugin: message from vppctl +VPP-367 | vpp packages need to depend on specific versions of each other +VPP-312 | IP6 FIB gets in indeterminate state by duplicating commands +VPP-224 | Lookup-in-vrf can not be set correctly +VPP-206 | Fix classify table delete +VPP-203 | Fix binary API for reading vpp node graph +VPP-147 | Inconsistent behaviour when adding L2 FIB filter entry +VPP-99 | VPP doesn't discard DHCPOFFER message with wrong XID + + +## Issues fixed + +Issues in fd.io are tracked in [JIRA](https://jira.fd.io). + +Issue | Description +--- | --- +VPP-396 | Ubuntu systems Graphviz bug +VPP-390 | vpp-lib rpm fails to include *.so symlinks, causing linking problems with out of tree builds +VPP-388 | IPSec output feature assumes packets have been ethernet rewritten +VPP-385 | ARP for indirect adjacencies not working correctly +VPP-361 | Memory leak on delete of VXLAN over IPv6 tunnel +VPP-357 | VNI not set correctly when removing LISP fwd entries +VPP-349 | sw_interface_vhost_user_dump not working +VPP-345 | net/enic: bad L4 checksum ptype set on ICMP packets +VPP-340 | MAP-T wrong destination address +VPP-330 | Use fifo to store LISP pending map-requests +VPP-326 | map_add_domain VAT command: unable to configure domain with mtu parameter +VPP-318 | The map_add_domain VAT command accepts invalid arguments +VPP-315 | Fix "show vxlan-gpe" issue +VPP-310 | Mapping algorithm compute wrong ea-bits +VPP-239 | LISP IP forwarding does not tag packets that hit negative mapping entries +VPP-235 | Invalid help in VAT for sw_interface_set_l2_bridge +VPP-228 | Mapping algorithm sends packet to wrong IPv6 address +VPP-214 | vpp-api-test: api_ipsec_sad_add_del_entry: vector "ck" not initialized +VPP-200 | VPP - TAP port create problem +VPP-189 | Coverity Issues for 16.09 +VPP-184 | u16 translating to char ,not short +VPP-179 | Adjacency share-count botch +VPP-163 | "show ip6 interface" ignores non-global addresses +VPP-155 | Netmap: Inconsistency in interface state between "show hardware" and "show interface" +VPP-145 | Dynamically compute IP feature ordering based on constraints +VPP-137 | VPP sends ARP with wrong requested IP +VPP-118 | JVpp: 0 length arrays not handled properly in VPP responses +VPP-112 | linux kernel info missing from build log +VPP-110 | vxlan encap node should never touch a deleted tunnel +VPP-107 | RPM build broken in master +VPP-92 | segment routing is not properly filling out the segment list +VPP-91 | segment routing add/del tunnel lookup doesn't work +VPP-84 | af_packet throws a fatal error on EAGAIN +VPP-74 | Clang compile fails due to warning in vlib/unix/cli.c +VPP-64 | Top level "make pkg-deb" fails if CDPATH is set in user env. +VPP-48 | Traceroute does not terminate when VPP is the target +VPP-23 | CLI pager does not gracefully handle lines longer than the terminal width + + +@page release_notes_1606 Release notes for VPP 16.06 + + +The FD.io Project, relentlessly focused on data IO speed and efficiency +supporting the creation of high performance, flexible, and scalable software +defined infrastructures, announces the availability of the community’s first +software release (16.06). + +In the four months since launching, FD.io has brought together more than 75 +developers from 11 different companies including network operators, solution +providers chip vendors, and network equipment vendors who are collaborating to +enhance and innovate around the Vector Packet Processing (VPP) technology. The +FD.io community has quickly formed to grow the number of projects from the +initial VPP project to an additional 6 projects addressing a diverse set of +requirements and usability across a variety of deployment environments. + +The 16.06 release brings unprecedented performance: 480Gbps/200mpps with 8 +million routes and 2k whitelist entries on standard high volume x86 servers. + + +## Features + +In addition to the existing full suite of vswitch/vrouter features, the new +16.06 release adds: + +* Enhanced Switching and Routing: + * IPv6 Segment Routing multicast support. + * LISP xTR support. + * VXLAN over IPv6 underlay. + * Per interface whitelists. + * Shared adjacencies in FIB. + +* New and improved interface support: + * Jumbo frame support for vhost-user. + * Netmap interface support. + * AF_Packet interface support. + +* Expanded and improved programmability: + * Python API bindings. + * Enhanced JVPP Java API bindings. + * Debugging CLI. + +* Expanded Hardware and Software Support: + * Support for ARM 32 targets including Rasberry Pi single-board computer. + * Support for DPDK 16.04. + diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md index b08ac86a74e..48a9fff3e9b 100644 --- a/doxygen/user_doc.md +++ b/doxygen/user_doc.md @@ -3,6 +3,7 @@ User Configuration Examples {#user_doc} Several modules provide operational documentation. +- [GUI guided user demo](https://wiki.fd.io/view/VPP_Sandbox/vpp-userdemo) - @subpage ipsec_gre_doc - @subpage map_doc - @subpage lldp_doc |