docs: Forward-port missing 17.01 release notes
[vpp.git] / RELEASE.md
1 # Release Notes    {#release_notes}
2
3 * @subpage release_notes_1704
4 * @subpage release_notes_17011
5 * @subpage release_notes_1701
6 * @subpage release_notes_1609
7 * @subpage release_notes_1606
8
9 @page release_notes_1704 Release notes for VPP 17.04
10
11 ## API changes
12
13 - Python API: To avoid conflicts between VPP API messages names and
14   the Python API binding function names, VPP API methods are put in a
15   separate proxy object.
16   https://gerrit.fd.io/r/#/c/5570/
17   The api methods are now referenced as:
18     vpp_handle = VPP(jsonfiles)
19     vpp_handle.connect(...)
20     vpp = vpp_handle.api
21     vpp.show_version()
22     vpp_handle.disconnect()
23
24   For backwards compatibility VPP API methods are left in the main
25   name space (VPP), but will be removed from 17.07.
26
27 - create_loopback message to be replaced with create_loopback_instance
28   create_loopback will be removed from 17.07.
29   https://gerrit.fd.io/r/#/c/5572/
30
31 @todo Release 17.04 needs release notes.
32
33
34 @page release_notes_17011 Release notes for VPP 17.01.1
35
36 This is bug fix release.
37
38 For the full list of fixed issues please reffer to:
39 - fd.io [JIRA](https://jira.fd.io)
40 - git [commit log](https://git.fd.io/vpp/log/?h=stable/1701)
41
42 @page release_notes_1701 Release notes for VPP 17.01
43
44 @note This release was for a while known as 16.12.
45
46 ## Features
47
48 - [Integrated November 2016 DPDK release](http://www.dpdk.org/doc/guides/rel_notes/release_16_11.html)
49
50 - Complete rework of Forwarding Information Base (FIB)
51
52 - Performance Improvements
53   - Improvements in DPDK input and output nodes
54   - Improvements in L2 path
55   - Improvmeents in IPv4 lookup node
56
57 - Feature Arcs Improvements
58   - Consolidation of the code
59   - New feature arcs
60     - device-input
61     - interface-output
62
63 - DPDK Cryptodev Support
64   - Software and Hardware Crypto Support
65
66 - DPDK HQoS support
67
68 - Simple Port Analyzer (SPAN)
69
70 - Bidirectional Forwarding Detection
71   - Basic implementation
72
73 - IPFIX Improvements
74
75 - L2 GRE over IPSec tunnels
76
77 - Link Layer Discovery Protocol (LLDP)
78
79 - Vhost-user Improvements
80   - Performance Improvements
81   - Multiqueue
82   - Reconnect
83
84 - LISP Enhancements
85   - Source/Dest control plane support
86   - L2 over LISP and GRE
87   - Map-Register/Map-Notify/RLOC-probing support
88   - L2 API improvements, overall code hardening
89
90 - Plugins:
91   - New: ACL
92   - New: Flow per Packet
93   - Improved: SNAT
94     - Mutlithreading
95     - Flow export
96
97 - Doxygen Enhancements
98
99 - Luajit API bindings
100
101 - API Refactoring
102   - file split
103   - message signatures
104
105 - Python and Scapy based unit testing infrastructure
106   - Infrastructure
107   - Various tests
108
109 - Packet Generator improvements
110
111 - TUN/TAP jumbo frames support
112
113 - Other various bug fixes and improvements
114
115 ## Known issues
116
117 For the full list of issues please reffer to fd.io [JIRA](https://jira.fd.io).
118
119 ## Issues fixed
120
121 For the full list of fixed issues please reffer to:
122 - fd.io [JIRA](https://jira.fd.io)
123 - git [commit log](https://git.fd.io/vpp/log/?h=stable/1701)
124
125
126 @page release_notes_1609 Release notes for VPP 16.09
127
128 ## Features
129
130 - [Integrated July 2016 DPDK release](http://www.dpdk.org/doc/guides/rel_notes/release_16_07.html)
131   - DPDK-vhost is depreciated pending a complete rework of the original integration and
132     addressing of rx performance deltas.
133   - Patches required for DPDK 16.07:
134     - Correctly setting the Packet Type in the IGB, IXGBE and i40e drivers.
135     - Correctly setting checksum in the i40e driver.
136     - NXP DPAA2 PMD Driver.
137     - rte_delay (yield) functionality.
138
139 - Add “in tree” plugins:
140   - IPv6 ILA.
141   - iOAM.
142   - Load Balancer.
143   - SNAT.
144
145 - High-performance (line-rate) “neutron like” L4 port-filtering.
146
147 - API refactoring - addressing some of the issues around JVPP bindings.
148   - Accommodating plugins [(e.g. NSH_SFC)](https://wiki.fd.io/view/NSH_SFC)
149   - Binding for [python](https://wiki.fd.io/view/VPP/Python_API)
150
151 - LISP
152   - L2 LISP overlays
153   -  Multitenancy
154   - Multihoming
155   - RTR mode
156   - Map-resolver failover algorithm
157
158 - Support 64-bit vector lengths, huge shared-memory segments.
159
160 - Dynamic IP Feature ordering
161   - IP Features can now specify features they appear before and after
162
163 - 16.09 Builds
164   - Ubuntu 14.04 LTS - Trusty Tahr
165   - Ubuntu 16.04 LTS - Xenial Xerus
166   - CentOS 7
167   - More information on [VPP wiki](https://wiki.fd.io/view/VPP/Installing_VPP_binaries_from_packages)
168
169 - Performance, characterize and document performance for this release
170   [(more information on CSIT page)](https://wiki.fd.io/view/CSIT)
171
172    - IPv4 and IPv6 Scale - performance tests.
173      - Bidirectional 10k/100k/1M flows.
174      - 64B,570B, 1518B,9000B packet sizes.
175    - IPv6 iACL - performance
176      - DUT1 and DUT2 are configured with IPv6 routing, two static IPv6 /64 routes and IPv6 iAcl
177        security whitelist ingress /64 filter entries applied on links.
178      - TG traffic profile contains two L3 flow-groups (flow-group per direction, 253 flows per
179        flow-group) with all packets containing Ethernet header, IPv6 header and generated payload.
180        MAC addresses are matching MAC addresses of the TG node interfaces.
181
182    - L2XC VXLANoIPv4 - performance
183      - DUT1 and DUT2 are configured with L2 cross-connect. VXLAN tunnels are configured between
184        L2XCs on DUT1 and DUT2.
185      - TG traffic profile contains two L3 flow-groups (flow-group per direction, 253 flows per
186        flow-group) with all packets containing Ethernet header, IPv4 header with IP protocol=61
187        and generated payload. MAC addresses are matching MAC addresses of the TG node interfaces.
188
189 - Documentation
190   - Autogenerated CLI documentation.
191   - Using doxygen to automate API/Node documentation.
192   - [(available online)](https://docs.fd.io/vpp/16.09/)
193
194 - Resolved all static analysis issues found by Coverity
195   - Beginning of 16.09 cycle: 505 issues.
196   - Release: 0 outstanding issues.
197
198
199 ## Known issues
200
201 Issues in fd.io are tracked in [JIRA](https://jira.fd.io).
202
203 Issue | Description
204 --- | ---
205 VPP-391 |   vpp debug version assert appeared in the process of start
206 VPP-380 |   Mapping algorithm compute wrong ea-bits when IPv4 prefix 0.0.0.0/0
207 VPP-371 |   load_one_plugin:63: Loaded plugin: message from vppctl
208 VPP-367 |   vpp packages need to depend on specific versions of each other
209 VPP-312 |   IP6 FIB gets in indeterminate state by duplicating commands
210 VPP-224 |   Lookup-in-vrf can not be set correctly
211 VPP-206 |   Fix classify table delete
212 VPP-203 |   Fix binary API for reading vpp node graph
213 VPP-147 |   Inconsistent behaviour when adding L2 FIB filter entry
214 VPP-99  |  VPP doesn't discard DHCPOFFER message with wrong XID
215
216
217 ## Issues fixed
218
219 Issues in fd.io are tracked in [JIRA](https://jira.fd.io).
220
221 Issue | Description
222 --- | ---
223 VPP-396 |   Ubuntu systems Graphviz bug
224 VPP-390 |   vpp-lib rpm fails to include *.so symlinks, causing linking problems with out of tree builds
225 VPP-388 |   IPSec output feature assumes packets have been ethernet rewritten
226 VPP-385 |   ARP for indirect adjacencies not working correctly
227 VPP-361 |   Memory leak on delete of VXLAN over IPv6 tunnel
228 VPP-357 |   VNI not set correctly when removing LISP fwd entries
229 VPP-349 |   sw_interface_vhost_user_dump not working
230 VPP-345 |   net/enic: bad L4 checksum ptype set on ICMP packets
231 VPP-340 |   MAP-T wrong destination address
232 VPP-330 |   Use fifo to store LISP pending map-requests
233 VPP-326 |   map_add_domain VAT command: unable to configure domain with mtu parameter
234 VPP-318 |   The map_add_domain VAT command accepts invalid arguments
235 VPP-315 |   Fix "show vxlan-gpe" issue
236 VPP-310 |   Mapping algorithm compute wrong ea-bits
237 VPP-239 |   LISP IP forwarding does not tag packets that hit negative mapping entries
238 VPP-235 |   Invalid help in VAT for sw_interface_set_l2_bridge
239 VPP-228 |   Mapping algorithm sends packet to wrong IPv6 address
240 VPP-214 |   vpp-api-test: api_ipsec_sad_add_del_entry: vector "ck" not initialized
241 VPP-200 |   VPP - TAP port create problem
242 VPP-189 |   Coverity Issues for 16.09
243 VPP-184 |   u16 translating to char ,not short
244 VPP-179 |   Adjacency share-count botch
245 VPP-163 |   "show ip6 interface" ignores non-global addresses
246 VPP-155 |   Netmap: Inconsistency in interface state between "show hardware" and "show interface"
247 VPP-145 |   Dynamically compute IP feature ordering based on constraints
248 VPP-137 |   VPP sends ARP with wrong requested IP
249 VPP-118 |   JVpp: 0 length arrays not handled properly in VPP responses
250 VPP-112 |   linux kernel info missing from build log
251 VPP-110 |   vxlan encap node should never touch a deleted tunnel
252 VPP-107 |   RPM build broken in master
253 VPP-92  |   segment routing is not properly filling out the segment list
254 VPP-91  |   segment routing add/del tunnel lookup doesn't work
255 VPP-84  |   af_packet throws a fatal error on EAGAIN
256 VPP-74  |   Clang compile fails due to warning in vlib/unix/cli.c
257 VPP-64  |   Top level "make pkg-deb" fails if CDPATH is set in user env.
258 VPP-48  |   Traceroute does not terminate when VPP is the target
259 VPP-23  |   CLI pager does not gracefully handle lines longer than the terminal width
260
261
262 @page release_notes_1606 Release notes for VPP 16.06
263
264
265 The FD.io Project, relentlessly focused on data IO speed and efficiency
266 supporting the creation of high performance, flexible, and scalable software
267 defined infrastructures, announces the availability of the community’s first
268 software release (16.06).
269
270 In the four months since launching, FD.io has brought together more than 75
271 developers from 11 different companies including network operators, solution
272 providers chip vendors, and network equipment vendors who are collaborating to
273 enhance and innovate around the Vector Packet Processing (VPP) technology. The
274 FD.io community has quickly formed to grow the number of projects from the
275 initial VPP project to an additional 6 projects addressing a diverse set of
276 requirements and usability across a variety of deployment environments.
277
278 The 16.06 release brings unprecedented performance: 480Gbps/200mpps with 8
279 million routes and 2k whitelist entries on standard high volume x86 servers.
280
281
282 ## Features
283
284 In addition to the existing full suite of vswitch/vrouter features, the new
285 16.06 release adds:
286
287 * Enhanced Switching and Routing:
288   * IPv6 Segment Routing multicast support.
289   * LISP xTR support.
290   * VXLAN over IPv6 underlay.
291   * Per interface whitelists.
292   * Shared adjacencies in FIB.
293
294 * New and improved interface support:
295   * Jumbo frame support for vhost-user.
296   * Netmap interface support.
297   * AF_Packet interface support.
298
299 * Expanded and improved programmability:
300   * Python API bindings.
301   * Enhanced JVPP Java API bindings.
302   * Debugging CLI.
303
304 * Expanded Hardware and Software Support:
305   * Support for ARM 32 targets including Rasberry Pi single-board computer.
306   * Support for DPDK 16.04.
307