docs: Add features by release section

Change-Id: Ibcae8c8ecdf8a3c2d7bcf96bf7cd5b741e2fad22
Signed-off-by: Scitt Keeler <skeeler@cisco.com>

10 files changed, 705 insertions, 0 deletions

diff --git a/docs/featuresbyrelease/index.rst b/docs/featuresbyrelease/index.rst
new file mode 100644
index 00000000000..4ea46932cb5
--- /dev/null
+++ b/docs/featuresbyrelease/index.rst
@@ -0,0 +1,21 @@
+.. _featuresbyrelease:

+

+#####################

+Features by Release 

+#####################

+

+This section provides information about the features that are provided for each release that covers the following releases:

+

+.. toctree::

+   :maxdepth: 1

+

+   vpp18.07

+   vpp18.04

+   vpp18.01

+   vpp17.10

+   vpp17.07

+   vpp17.04

+   vpp17.01

+   vpp16.09

+   vpp16.06

+   
\ No newline at end of file
diff --git a/docs/featuresbyrelease/vpp16.06.rst b/docs/featuresbyrelease/vpp16.06.rst
new file mode 100644
index 00000000000..b8d213b15a6
--- /dev/null
+++ b/docs/featuresbyrelease/vpp16.06.rst
@@ -0,0 +1,35 @@
+.. _vpp16.06:

+

+###############################

+Features for Release 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/docs/featuresbyrelease/vpp16.09.rst b/docs/featuresbyrelease/vpp16.09.rst
new file mode 100644
index 00000000000..3f7b60243c5
--- /dev/null
+++ b/docs/featuresbyrelease/vpp16.09.rst
@@ -0,0 +1,71 @@
+.. _vpp16.09:

+

+###############################

+Features for Release VPP 16.09

+###############################

+

+This section lists those features that became available in VPP Release 16.09:

+

+* Integrated July 2016 DPDK release

+   - 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)

+   - Binding for python

+* 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

+* Performance, characterize and document performance for this release (more information on CSIT page)

+   - 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)

+* Resolved all static analysis issues found by Coverity

+   - Beginning of 16.09 cycle: 505 issues

+   - Release: 0 outstanding issues

+

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1609>`_
\ No newline at end of file
diff --git a/docs/featuresbyrelease/vpp17.01.rst b/docs/featuresbyrelease/vpp17.01.rst
new file mode 100644
index 00000000000..a52a3064cc2
--- /dev/null
+++ b/docs/featuresbyrelease/vpp17.01.rst
@@ -0,0 +1,71 @@
+.. _vpp17.01:

+

+###############################

+Features for Release VPP 17.01

+###############################

+

+This section lists those features that became available in VPP Release 17.01:

+

+Features

+---------

+

+* Integrated November 2016 DPDK release

+* Complete rework of Forwarding Information Base (FIB)

+* Performance Improvements

+   - Improvements in DPDK input and output nodes

+   - Improvements in L2 path

+   - Improvmeents in IPv4 lookup node

+* Feature Arcs Improvements

+   - Consolidation of the code

+   - New feature arcs

+      + device-input

+      + interface-output

+* DPDK Cryptodev Support

+   - Software and Hardware Crypto Support

+* DPDK HQoS support

+* Simple Port Analyzer (SPAN)

+* Bidirectional Forwarding Detection

+   - Basic implementation

+* IPFIX Improvements

+* L2 GRE over IPSec tunnels

+* Link Layer Discovery Protocol (LLDP)

+* Vhost-user Improvements

+   - Performance Improvements

+   - Multiqueue

+   - Reconnect

+* LISP Enhancements

+   - Source/Dest control plane support

+   - L2 over LISP and GRE

+   - Map-Register/Map-Notify/RLOC-probing support

+   - L2 API improvements, overall code hardening

+* Plugins:

+   - New: ACL

+   - New: Flow per Packet

+   - Improved: SNAT

+      + Mutlithreading

+      + Flow export

+* Doxygen Enhancements

+* Luajit API bindings

+* API Refactoring

+   - file split

+   - message signatures

+* Python and Scapy based unit testing infrastructure

+   - Infrastructure

+   - Various tests

+* Packet Generator improvements

+* TUN/TAP jumbo frames support

+* Other various bug fixes and improvements

+

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_

diff --git a/docs/featuresbyrelease/vpp17.04.rst b/docs/featuresbyrelease/vpp17.04.rst
new file mode 100644
index 00000000000..f62b880e03b
--- /dev/null
+++ b/docs/featuresbyrelease/vpp17.04.rst
@@ -0,0 +1,128 @@
+.. _vpp17.04:

+

+###############################

+Features for Release VPP 17.04

+###############################

+

+This section lists those features that became available in VPP Release 17.04:

+

+Features

+---------

+

+Infrastructure

++++++++++++++++

+

+

+* make test improvements

+* vnet: add device-input threadplacement infra

+* 64 bit per-thread counters

+* process restart cli

+* High performance timer wheels

+* Plugin infrastructure improvements

+   -  Support for .default_disabled, .version_required

+* Added MAINTAINERS file

+

+	

+Host stack

++++++++++++

+

+* TCP stack (experimental)

+* DHCPv4 / DHCPv6 relay multi-destination

+* DHCPv4 option 82

+* ND proxy

+* Attached hosts

+* Consolidated DHCPv4 and DHCPv6 implementation

+

+Interfaces

+++++++++++++++

+

+* DPDK 17.02 (retire support for DPDK 16.07)

+* Add memif - packet memory interface for intra-host communication

+* vhost: support interrupt mode

+* DPDK as plugin (retired vpp_lite)

+* DPDPK input optimizations

+* Loopback interface allocation scheme

+

+

+Network features

+++++++++++++++++++

+

+* IP Multicast FIB

+* Bridging

+   -  Learning on local interfaces

+   -  Flushing of MACs from the L2 FIB

+* SNAT

+   -  CGN (Deterministic and dynamic)

+   -  CGN configurable port allocation algorithm

+   -  ICMP support

+   -  Tentant VRF id for SNAT outside addresses

+   -  Session dump / User dump

+   -  Port allocation per protocol

+* Security groups

+   -  Routed interface support

+   -  L2+L3 unified processing node

+   -  Improve fragment handling

+* Segement routing v6

+   -  SR policies with weighted SID lists

+   -  Binding SID

+   -  SR steering policies

+   -  SR Local SIDs

+   -  Framework to expand local SIDs w/plugins

+   -  Documentation

+* IOAM

+   -  UDP Pinger w/path fault isolation

+   -  IOAM as type 2 metadata in NSH

+   -  IAOM raw IPFIX collector and analyzer

+   -  Anycast active server selection

+   -  Documentation

+   -  SRv6 Local SID

+   -  IP6 HBH header and SR header co-existence

+   -  Active probe

+* LISP

+   -  Statistics collection

+   -  Generalize encap for overlay transport (vxlan-gpe support)

+   -  Improve data plane speed

+* GPE

+   -  CLI

+   -  NSH added to encap/decap path

+   -  Renamed LISP GPE API to GPE

+* MPLS

+   -  Performance improvements (quad loop)

+* BFD

+   -  Command line interface

+   -  Echo function

+   -  Remote demand mode

+   -  SHA1 authentication

+* IPsec

+   -  IKEv2 initiator features

+* VXLAN

+   -  unify IP4/IP6 control plane handling

+

+API changes

+++++++++++++++

+

+* Python API: To avoid conflicts between VPP API messages names and the Python API binding function names, the VPP API methods are put into a separate proxy object https://gerrit.fd.io/r/#/c/5570/ 

+

+  The api methods are now referenced as: vpp_handle = VPP(jsonfiles) vpp_handle.connect(...) vpp = vpp_handle.api vpp.show_version() vpp_handle.disconnect()

+

+  For backwards compatibility VPP API methods are left in the main name space (VPP), but will be removed from 17.07.

+

+   -  Python API: Change from cPython to CFFI.

+   

+* create_loopback message to be replaced with create_loopback_instance create_loopback will be removed from 17.07. `<https://gerrit.fd.io/r/#/c/5572/>`_ 

+

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1704>`_

+

+

diff --git a/docs/featuresbyrelease/vpp17.07.rst b/docs/featuresbyrelease/vpp17.07.rst
new file mode 100644
index 00000000000..e91d27a97f4
--- /dev/null
+++ b/docs/featuresbyrelease/vpp17.07.rst
@@ -0,0 +1,70 @@
+.. _vpp17.07:

+

+###############################

+Features for Release VPP 17.07

+###############################

+

+This section lists those features that became available in VPP Release 17.07:

+

+Features

+---------

+

+Infrastructure

++++++++++++++++

+

+* make test; improved debuggability.

+* TAB auto-completion on the CLI

+* DPDK 17.05

+* python 3 support in test infra

+	

+Host stack

++++++++++++

+

+* Improved Linux TCP stack compatibility using IWL test suite (https://jira.fd.io/browse/VPP-720)

+* Improved loss recovery (RFC5681, RFC6582, RF6675)

+* Basic implementation of Eifel detection algorithm (RFC3522)

+* Basic support for buffer chains

+* Refactored session layer API

+* Overall performance, scale and hardening

+

+Interfaces

+++++++++++++++

+

+* memif: IP mode, jumbo frames, multi queue

+* virtio-user support

+* vhost-usr; adaptive (poll/interupt) support.

+

+Network features

+++++++++++++++++++

+

+* MPLS Multicast FIB

+* BFD FIB integration

+* NAT64 support

+* GRE over IPv6

+* Segement routing MPLS

+* IOAM configuration for SRv6 localsid

+* LISP

+   -  NSH support

+   -  native forward static routes

+   -  L2 ARP

+* ACL multi-core suuport

+* Flowprobe:

+   -  Add flowstartns, flowendns and tcpcontrolbits

+   -  Stateful flows and IPv6, L4 recording

+* GTP-U support

+* VXLAN GPE support for FIB2.0 and bypass.

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_

+

+

diff --git a/docs/featuresbyrelease/vpp17.10.rst b/docs/featuresbyrelease/vpp17.10.rst
new file mode 100644
index 00000000000..3348f7366ce
--- /dev/null
+++ b/docs/featuresbyrelease/vpp17.10.rst
@@ -0,0 +1,69 @@
+.. _vpp17.10:

+

+###############################

+Features for Release VPP 17.10

+###############################

+

+This section lists those features that became available in VPP Release 17.10:

+

+Features

+---------

+

+Infrastructure

++++++++++++++++

+

+* DPDK 17.08

+* IP reassembly

+* Bounded-index extensible hash bucket-level LRU cache

+* Templated timer wheel improvements

+

+API

+++++++++++++++

+

+* C/C++ language binding

+* API stats

+	

+Host stack

++++++++++++

+

+* VPP TCP stack scale/congestion improvements

+* VPP Comms Library (VCL)

+* Overall performance, scale and hardening

+

+Network features

+++++++++++++++++++

+

+* IPSec rework - utilize new FIB

+* VPLS and VPWS implementation

+* NAT

+   -  Renamed SNAT to NAT

+   -  Performance / Scale

+   -  Destination NAT44 with load-balancing

+   -  In2out translation as an output feature on the outside interface

+   -  Fullback to 3-tuple key for non TCP/UDP/ICMP sessions

+* Security Groups/ACLs

+   -  "Replace" semantics for adding a new MacIP acl

+   -  Test suite tests for MacIP ACLs

+* ONE-LISP

+   -  Map-server fallback support

+   -  Preemptive re-fetch of active mappings that are about to expire

+   -  ND termination

+* PPPoE

+   -  PPPoE Control Plane packet dispatch

+   -  PPPoE decapsulation

+   -  PPPoE encapsulation

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_

+

+

diff --git a/docs/featuresbyrelease/vpp18.01.rst b/docs/featuresbyrelease/vpp18.01.rst
new file mode 100644
index 00000000000..173fc4aa8d8
--- /dev/null
+++ b/docs/featuresbyrelease/vpp18.01.rst
@@ -0,0 +1,88 @@
+.. _vpp18.01:

+

+###############################

+Features for Release VPP 18.01

+###############################

+

+This section lists those features that became available in VPP Release 18.01:

+

+Features

+----------

+

+Infrastructure

++++++++++++++++

+

+* DPDK 17.11

+* TCP Checksum Offload

+* Arm64/Arm-v8 support

+* SUSE packaging

+* bihash_vec8_8 variant

+* PCI rework to support VFIO

+* chi-squared test calculator

+

+SNAT / NAT

+++++++++++++

+

+* One armed NAT

+* Twice NAT44

+* NAT hairpinning rework

+* NAT64 multi-thread

+* NAT64 IPFIX

+* NAT64 Fragmentation

+* NAT: DS-Lite

+* Remove old SNAT API

+* ACL-based NAT

+

+VNET 

++++++++

+    

+* DNS name resolver

+* BIER

+* GENEVE Tunnel

+* IPSec Openssl 1.1.0 api support

+* FIB improvements

+* tap v2

+

+API

++++++++

+

+* VPP stats (Broadcast & Multicast support)

+* SR MPLS

+* VPP Object Model (VOM)

+

+Host stack

++++++++++++

+

+* VPP TCP Stack scale / congestion improvements

+* Refactor UDP

+* Namespace support

+* Session rules table

+* VPP Comms Library (VCL) improvements

+

+

+ACL

++++++

+

+* ACL stats

+

+Plugins

+++++++++++

+

+* Kube-proxy

+* L2 Emulation

+* Memif

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1801>`_

+

+

diff --git a/docs/featuresbyrelease/vpp18.04.rst b/docs/featuresbyrelease/vpp18.04.rst
new file mode 100644
index 00000000000..d5e2ca54b48
--- /dev/null
+++ b/docs/featuresbyrelease/vpp18.04.rst
@@ -0,0 +1,77 @@
+.. _vpp18.04:

+

+###############################

+Features for Release VPP 18.04

+###############################

+

+This section lists those features that became available in VPP Release 18.04. There is a summary graphic that identifies what areas the features are associated with, followed by a list of all the features for this release:

+

+.. image:: /_images/Features1804.png

+

+Infrastructure

++++++++++++++++

+

+* DPDK 18.02.1

+* ARM aarch64 integrated into CI

+

+VNET & Plugins

++++++++++++++++

+

+* ERSPAN

+* L3DSR load balancing support

+* VPC bonding / LACP

+* IPv4/IPv6 packet reassembly

+* IPv6 link-local support

+* Asymmetrical static NAT

+* 464XLAT for NAT44

+* MAP-T CE support

+* Intel Adaptive Virtual Function native device driver plugin

+* Marvell device plugin

+* SRv6 static, dynamic and masquerading proxy plugins

+* MPLS Uniform mode

+* IGMP plugin

+* IPIP tunnel support (IPv4/IPv6 over IPv4/IPv6)

+* IPv6 Router Discovery mechanism

+

+VLIB

++++++

+

+* ARM-optimized library variations for key functions

+* Better handling of physmem on non-NUMA kernels

+

+Host stack

++++++++++++

+

+* TLS support via OpenSSL or mbedtls software engines

+* Session layer can utilize both shm and memfd (secure) FIFO segments

+* STCP

+* VCL logging / tracing

+

+API framework

+++++++++++++++

+

+* New API definition compiler (vppapigen)

+* Memory (shm) and socket APIs refactored

+* API handlers refactored to make them transport (shared memory or socket) agnostic

+* Improved support for bootstrapping of the shm API with memfd segments over the socket API

+

+Packaging

+++++++++++

+

+* SELinux for RPM builds

+* Debuginfo RPMs

+* ARM aarch64 for Ubuntu

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_

+

diff --git a/docs/featuresbyrelease/vpp18.07.rst b/docs/featuresbyrelease/vpp18.07.rst
new file mode 100644
index 00000000000..a14435b5cac
--- /dev/null
+++ b/docs/featuresbyrelease/vpp18.07.rst
@@ -0,0 +1,75 @@
+.. _vpp18.07:

+

+###############################

+Features for Release VPP 18.07

+###############################

+

+This section lists those features that became available in VPP Release 18.07: 

+

+Infrastructure

++++++++++++++++

+

+* DPDK 18.02.1

+

+   - Complete rework of the dpdk-input node

+   - Display rx/tx burst function name in "show hardware detail"

+   - Improve buffer alloc perfomance

+      + This is ~50% improvement in buffer alloc performance. For a 256 buffer allocation, it was ~10 clocks/buffer, now is < 5 clocks.

+   - Add per-numa page allocation info to 'show memory'

+   - Vectorized bihash_{48,40,24,16}_8 key compare

+      + bihash_48_8 case:

+         * Scalar code: 6 clocks

+         * SSE4.2 code: 3 clocks

+         * AVX2 code: 2.27 clocks

+         * AVX512 code: 1.5 clocks

+   - Pollable Stats

+      + Stats are now available to a client in a shared memory segment and in the form of a directory, allowing very high performance polling of stats without directly querying VPP.

+

+VNET & Plugins

++++++++++++++++

+

+* IGMP improvements

+   - Enable/Disable an interface for IGMP

+   - improve logging

+   - refactor common code

+   - no orphaned timers

+   - IGMP state changes in main thread only

+   - Large groups split over multiple state-change reports

+   - SSM range configuration API.

+   - more tests

+* IP: vectorized IP checksum

+* VXLAN : HW offload RX flow

+* Rework kube-proxy into LB plugin and add NATA66

+* NAT:

+   - Code refactor

+   - Syslog

+   - Multiple outside interfaces

+   - Endpoint dependent filtering and mapping

+* ACL:

+   - Tuple Merge algorithm cleanup and integration

+   - Processing pipeline optimizations

+   - Refactoring

+* Experimental AVF driver

+

+

+Host stack

++++++++++++

+

+* Session: performance improvements, add support for connectionless transports, datagram reception and transmission

+* TCP: congestion control improvements and overall fixes

+* UDP: datagram mode

+* TLS async support

+

+Known issues

+---------------

+

+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.

+

+Issues fixed

+--------------

+

+For the full list of fixed issues please refer to:

+

+* fd.io `JIRA <https://jira.fd.io/>`_

+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_

+