docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / aboutvpp / releasenotes / v17.10.rst
1 Release notes for VPP 17.10
2 ===========================
3
4 More than 400 commits since the 1707 release.
5
6 Features
7 --------
8
9 -  Infrastructure
10
11    -  DPDK 17.08
12    -  IP reassembly
13    -  Bounded-index extensible hash bucket-level LRU cache
14    -  Templated timer wheel improvements
15
16 -  API
17
18    -  C/C++ language binding
19    -  API stats
20
21 -  Host stack
22
23    -  VPP TCP stack scale/congestion improvements
24    -  VPP Comms Library (VCL)
25    -  Overall performance, scale and hardening
26
27 -  Network features
28
29    -  IPSec rework - utilize new FIB
30
31    -  VPLS and VPWS implementation
32
33    -  NAT
34
35       -  Renamed SNAT to NAT
36       -  Performance / Scale
37       -  Destination NAT44 with load-balancing
38       -  In2out translation as an output feature on the outside
39          interface
40       -  Fullback to 3-tuple key for non TCP/UDP/ICMP sessions
41
42    -  Security Groups/ACLs
43
44       -  “Replace” semantics for adding a new MacIP acl
45       -  Test suite tests for MacIP ACLs
46
47    -  ONE-LISP
48
49       -  Map-server fallback support
50       -  Preemptive re-fetch of active mappings that are about to expire
51       -  ND termination
52
53    -  PPPoE
54
55       -  PPPoE Control Plane packet dispatch
56       -  PPPoE decapsulation
57       -  PPPoE encapsulation
58
59 Known issues
60 ------------
61
62 For the full list of issues please refer to fd.io
63 `JIRA <https://jira.fd.io>`__.
64
65 Issues fixed
66 ------------
67
68 For the full list of fixed issues please refer to:
69
70 - fd.io `JIRA <https://jira.fd.io>`__
71 - git `commit log <https://git.fd.io/vpp/log/?h=stable/1710>`__
72
73
74 API changes
75 -----------
76
77 ======================================== ==================
78 Message Name                             Result
79 ======================================== ==================
80 bridge_domain_add_del                    definition changed
81 bridge_domain_details                    definition changed
82 connect_session                          definition changed
83 connect_sock                             definition changed
84 connect_sock_reply                       definition changed
85 connect_uri_reply                        definition changed
86 create_vhost_user_if                     definition changed
87 dhcp_client_config                       definition changed
88 ip4_arp_event                            definition changed
89 ip6_fib_details                          definition changed
90 ip6_nd_event                             definition changed
91 ip_add_del_route                         definition changed
92 ip_fib_details                           definition changed
93 ip_table_add_del                         definition changed
94 l2_macs_event                            only in image
95 macip_acl_add_replace                    definition changed
96 macip_acl_interface_list_details         only in image
97 macip_acl_interface_list_dump            only in image
98 modify_vhost_user_if                     definition changed
99 mpls_fib_details                         definition changed
100 mpls_route_add_del                       definition changed
101 mpls_table_add_del                       definition changed
102 mpls_tunnel_add_del                      definition changed
103 nat44_add_del_address_range              definition changed
104 nat44_add_del_interface_addr             definition changed
105 nat44_add_del_lb_static_mapping          definition changed
106 nat44_add_del_static_mapping             definition changed
107 nat44_address_details                    only in image
108 nat44_address_dump                       only in image
109 nat44_interface_add_del_feature          definition changed
110 nat44_interface_add_del_output_feature   definition changed
111 nat44_interface_addr_details             only in image
112 nat44_interface_addr_dump                only in image
113 nat44_interface_details                  only in image
114 nat44_interface_dump                     only in image
115 nat44_interface_output_feature_details   only in image
116 nat44_interface_output_feature_dump      only in image
117 nat44_lb_static_mapping_details          only in image
118 nat44_lb_static_mapping_dump             only in image
119 nat44_static_mapping_details             only in image
120 nat44_static_mapping_dump                only in image
121 nat44_user_details                       only in image
122 nat44_user_dump                          only in image
123 nat44_user_session_details               only in image
124 nat44_user_session_dump                  only in image
125 nat_control_ping                         definition changed
126 nat_det_add_del_map                      definition changed
127 nat_det_close_session_in                 definition changed
128 nat_det_close_session_out                definition changed
129 nat_det_forward                          definition changed
130 nat_det_get_timeouts                     definition changed
131 nat_det_map_details                      only in image
132 nat_det_map_dump                         only in image
133 nat_det_reverse                          definition changed
134 nat_det_session_details                  only in image
135 nat_det_session_dump                     only in image
136 nat_det_set_timeouts                     definition changed
137 nat_ipfix_enable_disable                 definition changed
138 nat_set_workers                          definition changed
139 nat_show_config                          definition changed
140 nat_worker_details                       only in image
141 nat_worker_dump                          only in image
142 one_add_del_ndp_entry                    definition changed
143 one_enable_disable_petr_mode             definition changed
144 one_enable_disable_pitr_mode             definition changed
145 one_enable_disable_xtr_mode              definition changed
146 one_get_transport_protocol               definition changed
147 one_map_register_fallback_threshold      definition changed
148 one_map_register_set_ttl                 definition changed
149 one_ndp_bd_get                           definition changed
150 one_ndp_entries_get                      definition changed
151 one_set_transport_protocol               definition changed
152 one_show_petr_mode                       definition changed
153 one_show_pitr_mode                       definition changed
154 one_show_xtr_mode                        definition changed
155 p2p_ethernet_add                         definition changed
156 pppoe_add_del_session                    definition changed
157 pppoe_session_details                    only in image
158 pppoe_session_dump                       only in image
159 punt_socket_deregister                   definition changed
160 punt_socket_register                     definition changed
161 show_one_map_register_fallback_threshold definition changed
162 show_one_map_register_ttl                definition changed
163 snat_interface_add_del_output_feature    definition changed
164 snat_interface_output_feature_details    only in image
165 snat_interface_output_feature_dump       only in image
166 sw_interface_event                       only in image
167 sw_interface_set_flags                   definition changed
168 sw_interface_span_dump                   definition changed
169 sw_interface_span_enable_disable         definition changed
170 sw_interface_vhost_user_details          definition changed
171 tcp_configure_src_addresses              definition changed
172 vnet_per_interface_combined_counters     only in image
173 vnet_per_interface_simple_counters       only in image
174 want_interface_combined_stats            definition changed
175 want_interface_simple_stats              definition changed
176 want_ip4_fib_stats                       definition changed
177 want_ip4_nbr_stats                       definition changed
178 want_ip6_fib_stats                       definition changed
179 want_ip6_nbr_stats                       definition changed
180 want_l2_macs_events                      definition changed
181 want_per_interface_combined_stats        definition changed
182 want_per_interface_simple_stats          definition changed
183 ======================================== ==================
184
185 Found 103 api message signature differences
186
187 Patches that updated the API files
188 ----------------------------------
189 * ``./src/plugins/pppoe/pppoe.api`` 62f9cdd8 Add PPPoE Plugin
190 * ``./src/plugins/acl/acl.api`` c29940c5 ACL-plugin add “replace” semantics
191   for adding a new MacIP acl de9fbf43 MAC IP ACL interface list dump (as
192   an alternative to the get/reply)
193 * ``./src/plugins/nat/nat.api`` 704018cf NAT: Destination NAT44 with
194   load-balancing (VPP-954) 2ba92e32 NAT: Rename snat plugin to nat
195   (VPP-955)
196 * ``./src/vnet/interface.api`` 831fb59f Stats refactor d292ab1e No context in
197   SW interface event a07bd708 Dedicated SW Interface Event
198 * ``./src/vnet/dhcp/dhcp.api`` 51822bf0 DHCP client option 61 “client_id”
199   4729b1ec DHCP complete event sends mask length
200 * ``./src/vnet/lldp/lldp.api`` 99a0e60e Add API support for LLDP
201   config/interface set
202 * ``./src/vnet/lisp-cp/one.api`` d630713d LISP: add neighbor discovery and CP
203   protocol separation APIs 111a5cea LISP: Add APIs for enable/disable
204   xTR/P-ITR/P-ETR modes 7048ff1e LISP: Map-server fallback feature
205   1e553a00 LISP: make TTL for map register messages configurable
206 * ``./src/vnet/ethernet/p2p_ethernet.api`` 15ac81c1 P2P Ethernet
207 * ``./src/vnet/mpls/mpls.api`` 2297af01 Add a name to the creation of an IP
208   and MPLS table 28ab9cc1 FIB table add/delete API only da78f957 L2 over
209   MPLS a0a908f1 FIB path weight incorrect in dump (VPP-922) 57b5860f FIB
210   path preference
211 * ``./src/vnet/session/session.api`` 33e002b1 Fix session connect api message
212   handling.
213 * ``./src/vnet/span/span.api`` 5b311202 SPAN/API:enable L2 dump 001fd406
214   SPAN:add l2 mirror
215 * ``./src/vnet/devices/virtio/vhost_user.api`` 4ba75f54 vhost: Remove
216   operation mode in the API
217 * ``./src/vnet/vxlan-gpe/vxlan_gpe.api`` 04ffd0ad VPP crash on creating vxlan
218   gpe interface. VPP-875
219 * ``./src/vnet/tcp/tcp.api`` 3bbcfab1 TCP source address automation
220 * ``./src/vnet/ip/ip.api`` 2297af01 Add a name to the creation of an IP and
221   MPLS table 28ab9cc1 FIB table add/delete API only 57b5860f FIB path
222   preference
223 * ``./src/vnet/lisp-gpe/lisp_gpe.api`` af3d9771 Remove unused retval from
224   gpe_native_fwd_rpath type definition
225 * ``./src/vnet/l2/l2.api`` 50570ece Update of free text tag patch for BD
226   48304141 Support for bridge domain free text tag e531f4cb Increase
227   default MAC learn limit and check it in learn-update path 8d00fff8 Add
228   support for API client to receive L2 MAC events
229 * ``./src/vpp/api/vpe.api`` 8a19f12a Allow individual stats API and introduce
230   stats.api 4802632d Punt socket: Fix coverity error for pathname length
231   mismatch between API and sun_path. f7a55ad7 PUNT socket: External
232   control plane processes connected via UNIX domain sockets. 75e2f2ac
233   API:fix arp/ND event messages - remove context 99a0e60e Add API support
234   for LLDP config/interface set
235 * ``./src/vpp/stats/stats.api`` 831fb59f Stats refactor 8a19f12a Allow
236   individual stats API and introduce stats.api