NEWS: Note tunneling feature removals in the correct release.
[sliver-openvswitch.git] / NEWS
1 post-v1.10.0
2 ---------------------
3     - Stable bond mode has been removed.
4     - The autopath action has been removed.
5     - New support for the data encapsulation format of the LISP tunnel
6       protocol (RFC 6830).  An external control plane or manual flow
7       setup is required for EID-to-RLOC mapping.
8     - OpenFlow:
9       * The "dec_mpls_ttl" and "set_mpls_ttl" actions from OpenFlow
10         1.1 and later are now implemented.
11       * New "stack" extension for use in actions, to push and pop from
12         NXM fields.
13
14
15 v1.10.0 - xx xxx xxxx
16 ---------------------
17     - Bridge compatibility support has been removed.  Any uses that
18       rely on ovs-brcompatd will have to stick with Open vSwitch 1.9.x
19       or adapt to native Open vSwitch support (e.g. use ovs-vsctl instead
20       of brctl).
21     - The maximum size of the MAC learning table is now configurable.
22     - With the Linux datapath, packets for new flows are now queued
23       separately on a per-port basis, so it should no longer be
24       possible for a large number of new flows arriving on one port to
25       prevent new flows from being processed on other ports.
26     - Many "ovs-vsctl" database commands now accept an --if-exists option.
27       Please refer to the ovs-vsctl manpage for details.
28     - OpenFlow:
29       - Experimental support for newer versions of OpenFlow.  See
30         the "What versions of OpenFlow does Open vSwitch support?"
31         question in the FAQ for more details.
32       - The OpenFlow "dp_desc" may now be configured by setting the
33         value of other-config:dp-desc in the Bridge table.
34       - It is possible to request the OpenFlow port number with the
35         "ofport_request" column in the Interface table.
36       - The NXM flow_removed message now reports the OpenFlow table ID
37         from which the flow was removed.
38     - Tunneling:
39       - New support for the VXLAN tunnel protocol (see the IETF draft here:
40         http://tools.ietf.org/html/draft-mahalingam-dutt-dcops-vxlan-03).
41       - Tunneling requires the version of the kernel module paired with
42         Open vSwitch 1.9.0 or later.
43       - Inheritance of the Don't Fragment bit in IP tunnels (df_inherit)
44         is no longer supported.
45       - Path MTU discovery is no longer supported.
46       - CAPWAP tunneling support removed.
47       - Tunnels with multicast destination ports are no longer supported.
48     - ovs-dpctl:
49       - The "dump-flows" and "del-flows" no longer require an argument
50         if only one datapath exists.
51     - ovs-appctl:
52       - New "vlog/disable-rate-limit" and "vlog/enable-rate-limit"
53         commands available allow control over logging rate limits.
54       - New "dpif/dump-dps", "dpif/show", and "dpif/dump-flows" command
55         that mimic the equivalent ovs-dpctl commands.
56     - The ofproto library is now responsible for assigning OpenFlow port
57       numbers.  An ofproto implementation should assign them when
58       port_construct() is called.
59     - All dpif-based bridges of a particular type share a common
60       datapath called "ovs-<type>", e.g. "ovs-system".  The ovs-dpctl
61       commands will now return information on that shared datapath.  To
62       get the equivalent bridge-specific information, use the new
63       "ovs-appctl dpif/*" commands.
64     - Backward-incompatible changes:
65       - Earlier Open vSwitch versions treated ANY as a wildcard in flow
66         syntax.  OpenFlow 1.1 adds a port named ANY, which introduces a
67         conflict.  ANY was rarely used in flow syntax, so we chose to
68         retire that meaning of ANY in favor of the OpenFlow 1.1 meaning.
69     - Patch ports no longer require kernel support, so they now work
70       with FreeBSD and the kernel module built into Linux 3.3 and later.
71
72
73 v1.9.0 - xx xxx xxxx
74 --------------------
75     - Datapath:
76       - Support for ipv6 set action.
77       - SKB mark matching and setting.
78       - support for Linux kernels up to 3.8
79     - FreeBSD is now a supported platform, thanks to code contributions from
80       Gaetano Catalli, Ed Maste, and Giuseppe Lettieri.
81     - ovs-bugtool: New --ovs option to report only OVS related information.
82     - New %t and %T log escapes to identify the subprogram within a
83       cooperating group of processes or threads that emitted a log message.
84       The default log patterns now include this information.
85     - OpenFlow:
86       - Allow bitwise masking for SHA and THA fields in ARP, SLL and TLL
87         fields in IPv6 neighbor discovery messages, and IPv6 flow label.
88       - Adds support for writing to the metadata field for a flow.
89     - Tunneling:
90       - The tunneling code no longer assumes input and output keys are
91         symmetric.  If they are not, PMTUD needs to be disabled for
92         tunneling to work. Note this only applies to flow-based keys.
93       - New support for a nonstandard form of GRE that supports a 64-bit key.
94       - Tunnel Path MTU Discovery default value was set to 'disabled'.
95         This feature is deprecated and will be removed soon.
96       - Tunnel header caching removed.
97     - ovs-ofctl:
98       - Commands and actions that accept port numbers now also accept keywords
99         that represent those ports (such as LOCAL, NONE, and ALL).  This is
100         also the recommended way to specify these ports, for compatibility
101         with OpenFlow 1.1 and later (which use the OpenFlow 1.0 numbers
102         for these ports for different purposes).
103     - ovs-dpctl:
104       - Support requesting the port number with the "port_no" option in
105         the "add-if" command.
106     - ovs-pki: The "online PKI" features have been removed, along with
107       the ovs-pki-cgi program that facilitated it, because of some
108       alarmist insecurity claims.  We do not believe that these claims
109       are true, but because we do not know of any users for this
110       feature it seems better on balance to remove it.  (The ovs-pki-cgi
111       program was not included in distribution packaging.)
112     - ovsdb-server now enforces the immutability of immutable columns.  This
113       was not enforced in earlier versions due to an oversight.
114     - The following features are now deprecated.  They will be removed no
115       earlier than February 2013.  Please email dev@openvswitch.org with
116       concerns.
117         - Bridge compatibility.
118         - Stable bond mode.
119         - The autopath action.
120         - Interface type "null".
121         - Numeric values for reserved ports (see "ovs-ofctl" note above).
122         - Tunnel Path MTU Discovery.
123         - CAPWAP tunnel support.
124     - The data in the RARP packets can now be matched in the same way as the
125       data in ARP packets.
126
127
128 v1.8.0 - xx xxx xxxx
129 ------------------------
130     - New FAQ.  Please send updates and additions!
131     - Authors of controllers, please read the new section titled "Action
132       Reproduction" in DESIGN, which describes an Open vSwitch change in
133       behavior in corner cases that may affect some controllers.
134     - ovs-l3ping:
135         - A new test utility that can create L3 tunnel between two Open
136           vSwitches and detect connectivity issues.
137     - ovs-ofctl:
138         - New --sort and --rsort options for "dump-flows" command.
139         - "mod-port" command can now control all OpenFlow config flags.
140     - OpenFlow:
141       - Allow general bitwise masking for IPv4 and IPv6 addresses in
142         IPv4, IPv6, and ARP packets.  (Previously, only CIDR masks
143         were allowed.)
144       - Allow support for arbitrary Ethernet masks.  (Previously, only
145         the multicast bit in the destination address could be individually
146         masked.)
147       - New field OXM_OF_METADATA, to align with OpenFlow 1.1.
148       - The OFPST_QUEUE request now reports an error if a specified port or
149         queue does not exist, or for requests for a specific queue on all
150         ports, if the specified queue does not exist on any port.  (Previous
151         versions generally reported an empty set of results.)
152       - New "flow monitor" feature to allow controllers to be notified of
153         flow table changes as they happen.
154     - Additional protocols are not mirrored and dropped when forward-bpdu is
155       false.  For a full list, see the ovs-vswitchd.conf.db man page.
156     - Open vSwitch now sends RARP packets in situations where it previously
157       sent a custom protocol, making it consistent with behavior of QEMU and
158       VMware.
159     - All Open vSwitch programs and log files now show timestamps in UTC,
160       instead the local timezone, by default.
161
162
163 v1.7.0 - 30 Jul 2012
164 ------------------------
165     - kernel modules are renamed. openvswitch_mod.ko is now
166       openvswitch.ko and brcompat_mod.ko is now brcompat.ko.
167     - Increased the number of NXM registers to 8.
168     - Added ability to configure DSCP setting for manager and controller
169       connections.  By default, these connections have a DSCP value of
170       Internetwork Control (0xc0).
171     - Added the granular link health statistics, 'cfm_health', to an
172       interface.
173     - OpenFlow:
174         - Added support to mask nd_target for ICMPv6 neighbor discovery flows.
175         - Added support for OpenFlow 1.3 port description (OFPMP_PORT_DESC)
176           multipart messages.
177     - ovs-ofctl:
178         - Added the "dump-ports-desc" command to retrieve port
179           information using the new port description multipart messages.
180     - ovs-test:
181         - Added support for spawning ovs-test server from the client.
182         - Now ovs-test is able to automatically create test bridges and ports.
183     - "ovs-dpctl dump-flows" now prints observed TCP flags in TCP flows.
184     - Tripled flow setup performance.
185     - The "coverage/log" command previously available through ovs-appctl
186       has been replaced by "coverage/show".  The new command replies with
187       coverage counter values, instead of logging them.
188
189
190 v1.6.1 - 25 Jun 2012
191 ------------------------
192     - Allow OFPP_CONTROLLER as the in_port for packet-out messages.
193
194
195 v1.6.0 - 24 Feb 2012
196 ------------------------
197     *** Internal only release ***
198     - bonding
199         - LACP bonds no longer fall back to balance-slb when negotiations fail.
200           Instead they drop traffic.
201         - The default bond_mode changed from SLB to active-backup, to protect
202           unsuspecting users from the significant risks of SLB bonds (which are
203           documented in vswitchd/INTERNALS).
204         - Load balancing can be disabled by setting the bond-rebalance-interval
205           to zero.
206     - OpenFlow:
207         - Added support for bitwise matching on TCP and UDP ports.
208           See ovs-ofctl(8) for more information.
209         - NXM flow dumps now include times elapsed toward idle and hard
210           timeouts.
211         - Added an OpenFlow extension NXT_SET_ASYNC_CONFIG that allows
212           controllers more precise control over which OpenFlow messages they
213           receive asynchronously.
214         - New "fin_timeout" action.
215         - Added "fin_timeout" support to "learn" action.
216         - New Nicira action NXAST_CONTROLLER that offers additional features
217           over output to OFPP_CONTROLLER.
218     - When QoS settings for an interface do not configure a default queue
219       (queue 0), Open vSwitch now uses a default configuration for that
220       queue, instead of dropping all packets as in previous versions.
221     - Logging:
222         - Logging to console and file will have UTC timestamp as a default for
223           all the daemons. An example of the default format is
224           2012-01-27T16:35:17Z.  ovs-appctl can be used to change the default
225           format as before.
226         - The syntax of commands and options to set log levels was simplified,
227           to make it easier to remember.
228     - New support for limiting the number of flows in an OpenFlow flow
229       table, with configurable policy for evicting flows upon
230       overflow.  See the Flow_Table table in ovs-vswitch.conf.db(5)
231       for more information.
232     - New "enable-async-messages" column in the Controller table.  If set to
233       false, OpenFlow connections to the controller will initially have all
234       asynchronous messages disabled, overriding normal OpenFlow behavior.
235     - ofproto-provider interface:
236         - "struct rule" has a new member "used" that ofproto implementations
237           should maintain by updating with ofproto_rule_update_used().
238     - ovsdb-client:
239         - The new option --timestamp causes the "monitor" command to print
240           a timestamp with every update.
241     - CFM module CCM broadcasts can now be tagged with an 802.1p priority.
242
243
244 v1.5.0 - 01 Jun 2012
245 ------------------------
246     - OpenFlow:
247         - Added support for querying, modifying, and deleting flows
248           based on flow cookie when using NXM.
249         - Added new NXM_PACKET_IN format.
250         - Added new NXAST_DEC_TTL action.
251     - ovs-ofctl:
252         - Added daemonization support to the monitor and snoop commands.
253     - ovs-vsctl:
254         - The "find" command supports new set relational operators
255           {=}, {!=}, {<}, {>}, {<=}, and {>=}.
256     - ovsdb-tool now uses the typical database and schema installation
257       directories as defaults.
258     - The default MAC learning timeout has been increased from 60 seconds
259       to 300 seconds.  The MAC learning timeout is now configurable.
260
261
262 v1.4.0 - 30 Jan 2012
263 ------------------------
264     - Compatible with Open vSwitch kernel module included in Linux 3.3.
265     - New "VLAN splinters" feature to work around buggy device drivers
266       in old Linux versions.  (This feature is deprecated.  When
267       broken device drivers are no longer in widespread use, we will
268       delete this feature.)  See ovs-vswitchd.conf.db(5) for more
269       information.
270     - OpenFlow:
271        - Added ability to match on IPv6 flow label through NXM.
272        - Added ability to match on ECN bits in IPv4 and IPv6 through NXM.
273        - Added ability to match on TTL in IPv4 and IPv6 through NXM.
274        - Added ability to modify ECN bits in IPv4.
275        - Added ability to modify TTL in IPv4.
276     - ovs-vswitchd:
277        - Don't require the "normal" action to use mirrors.  Traffic will
278          now be properly mirrored for any flows, regardless of their
279          actions.
280        - Track packet and byte statistics sent on mirrors.
281        - The sFlow implementation can now usually infer the correct agent
282          device instead of having to be told explicitly.
283     - ovs-appctl:
284       - New "fdb/flush" command to flush bridge's MAC learning table.
285     - ovs-test:
286       - A new distributed testing tool that allows one to diagnose performance
287         and connectivity issues. This tool currently is not included in RH or
288         Xen packages.
289     - RHEL packaging now supports integration with Red Hat network scripts.
290     - bonding:
291       - Post 1.4.*, OVS will be changing the default bond mode from balance-slb
292         to active-backup.  SLB bonds carry significant risks with them
293         (documented vswitchd/INTERNALS) which we want to prevent unsuspecting
294         users from running into.  Users are advised to update any scripts or
295         configuration which may be negatively impacted by explicitly setting
296         the bond mode which they want to use.
297
298
299 v1.3.0 - 09 Dec 2011
300 ------------------------
301     - OpenFlow:
302       - Added an OpenFlow extension which allows the "output" action to accept
303         NXM fields.
304       - Added an OpenFlow extension for flexible learning.
305       - Bumped number of NXM registers from four to five.
306     - ovs-appctl:
307       - New "version" command to determine version of running daemon.
308       - If no argument is provided for "cfm/show", displays detailed
309         information about all interfaces with CFM enabled.
310       - If no argument is provided for "lacp/show", displays detailed
311         information about all ports with LACP enabled.
312     - ovs-dpctl:
313       - New "set-if" command to modify a datapath port's configuration.
314     - ovs-vswitchd:
315       - The software switch now supports 255 OpenFlow tables, instead
316         of just one.  By default, only table 0 is consulted, but the
317         new NXAST_RESUBMIT_TABLE action can look up in additional
318         tables.  Tables 128 and above are reserved for use by the
319         switch itself; please use only tables 0 through 127.
320       - Add support for 802.1D spanning tree (STP).
321     - Fragment handling extensions:
322       - New OFPC_FRAG_NX_MATCH fragment handling mode, in which L4
323         fields are made available for matching in fragments with
324         offset 0.
325       - New NXM_NX_IP_FRAG match field for matching IP fragments (usable
326         via "ip_frag" in ovs-ofctl).
327       - New ovs-ofctl "get-frags" and "set-frags" commands to get and set
328         fragment handling policy.
329     - CAPWAP tunneling now supports an extension to transport a 64-bit key.
330       By default it remains compatible with the old version and other
331       standards-based implementations.
332     - Flow setups are now processed in a round-robin manner across ports
333       to prevent any single client from monopolizing the CPU and conducting
334       a denial of service attack.
335     - Added support for native VLAN tagging.  A new "vlan_mode"
336       parameter can be set for "port". Possible values: "access",
337       "trunk", "native-tagged" and "native-untagged".
338     - test-openflowd has been removed.  Please use ovs-vswitchd instead.
339
340 v1.2.0 - 03 Aug 2011
341 ------------------------
342     - New "ofproto" abstraction layer to ease porting to hardware
343       switching ASICs.
344     - Packaging for Red Hat Enterprise Linux 5.6 and 6.0.
345     - Datapath support for Linux kernels up to 3.0.
346     - OpenFlow:
347       - New "bundle" and "bundle_load" action extensions.
348     - Database:
349       - Implement table unique constraints.
350       - Support cooperative locking between callers.
351     - ovs-dpctl:
352       - New "-s" option for "show" command prints packet and byte
353         counters for each port.
354     - ovs-ofctl:
355       - New "--readd" option for "replace-flows".
356     - ovs-vsctl:
357       - New "show" command to print an overview of configuration.
358       - New "comment" command to add remark that explains intentions.
359     - ovs-brcompatd has been rewritten to fix long-standing bugs.
360     - ovs-openflowd has been renamed test-openflowd and moved into the
361       tests directory.  Its presence confused too many users.  Please
362       use ovs-vswitchd instead.
363     - New ovs-benchmark utility to test flow setup performance.
364     - A new log level "off" has been added.  Configuring a log facility
365       "off" prevents any messages from being logged to it.  Previously,
366       "emer" was effectively "off" because no messages were ever logged at
367       level "emer".  Now, errors that cause a process to exit are logged
368       at "emer" level.
369     - "configure" option --with-l26 has been renamed --with-linux, and
370       --with-l26-source has been renamed --with-linux-source.  The old
371       names will be removed after the next release, so please update
372       your scripts.
373     - The "-2.6" suffix has been dropped from the datapath/linux-2.6 and
374       datapath/linux-2.6/compat-2.6 directories.
375     - Feature removals:
376       - Dropped support for "tun_id_from_cookie" OpenFlow extension.
377            Please use the extensible match extensions instead.
378       - Removed the Maintenance_Point and Monitor tables in an effort
379         to simplify 802.1ag configuration.
380     - Performance and scalability improvements
381     - Bug fixes
382
383 v1.1.0 - 05 Apr 2011
384 ------------------------
385     - Ability to define policies over IPv6
386     - LACP
387     - 802.1ag CCM
388     - Support for extensible match extensions to OpenFlow
389     - QoS:
390       - Support for HFSC qdisc.
391       - Queue used by in-band control can now be configured.
392     - Kernel:
393       - Kernel<->userspace interface has been reworked and should be
394         close to a stable ABI now.
395       - "Port group" concept has been dropped.
396     - GRE over IPSEC tunnels
397     - Bonding:
398       - New active backup bonding mode.
399       - New L4 hashing support when LACP is enabled.
400       - Source MAC hash now includes VLAN field also.
401       - miimon support.
402     - Greatly improved handling of large flow tables
403     - ovs-dpctl:
404       - "show" command now prints full vport configuration.
405       - "dump-groups" command removed since kernel support for
406         port groups was dropped.
407     - ovs-vsctl:
408       - New commands for working with the new Managers table.
409       - "list" command enhanced with new formatting options and --columns
410         option.
411       - "get" command now accepts new --id option.
412       - New "find" command.
413     - ovs-ofctl:
414       - New "queue-stats" command for printing queue stats.
415       - New commands "replace-flows" and "diff-flows".
416       - Commands to add and remove flows can now read from files.
417       - New --flow-format option to enable or disable NXM.
418       - New --more option to increase OpenFlow message verbosity.
419       - Removed "tun-cookie" command, which is no longer useful.
420     - ovs-controller enhancements for testing various features.
421     - New ovs-vlan-test command for testing for Linux kernel driver VLAN
422       bugs.  New ovs-vlan-bug-workaround command for enabling and
423       disabling a workaround for these driver bugs.
424     - OpenFlow support:
425       - "Resubmit" actions now update flow statistics.
426       - New "register" extension for use in matching and actions, via NXM.
427       - New "multipath" experimental action extension.
428       - New support for matching multicast Ethernet frames, via NXM.
429       - New extension for OpenFlow vendor error codes.
430       - New extension to set the QoS output queue without actually
431         sending to an output port.
432       - Open vSwitch now reports a single flow table, instead of
433         separate hash and wildcard tables.  This better models the
434         current implementation.
435       - New experimental "note" action.
436       - New "ofproto/trace" ovs-appctl command and associated utilities
437         to ease debugging complex flow tables.
438     - Database:
439       - Schema documentation now includes an entity-relationship diagram.
440       - The database is now garbage collected.  In most tables,
441         unreferenced rows will be deleted automatically.
442       - Many tables now include statistics updated periodically by
443         ovs-vswitchd or ovsdb-server.
444       - Every table now has an "external-ids" column for use by OVS
445         integrators.
446       - There is no default controller anymore.  Each bridge must have its
447         controller individually specified.
448       - The "fail-mode" is now a property of a Bridge instead of a Controller.
449       - New versioning and checksum features.
450       - New Managers table and manager_options column in Open_vSwitch table
451         for specifying managers.  The old "managers" column in the
452         Open_vSwitch table has been removed.
453       - Many "name" columns are now immutable.
454     - Feature removals:
455       - Dropped support for XenServer pre-5.6.100.
456       - Dropped support for Linux pre-2.6.18.
457       - Dropped controller discovery support.
458       - Dropped "ovs-ofctl status" and the OpenFlow extension that it used.
459         Statistics reporting in the database is a rough equivalent.
460       - Dropped the "corekeeper" package (now separate, at
461         http://openvswitch.org/cgi-bin/gitweb.cgi?p=corekeeper).
462     - Performance and scalability improvements
463     - Bug fixes
464
465 v1.1.0pre2 - 13 Sep 2010
466 ------------------------
467     - Bug fixes
468
469 v1.1.0pre1 - 31 Aug 2010
470 ------------------------
471     - OpenFlow 1.0 slicing (QoS) functionality
472     - Python bindings for configuration database (no write support)
473     - Performance and scalability improvements
474     - Bug fixes
475
476 v1.0.1 - 31 May 2010
477 --------------------
478     - New "patch" interface type
479     - Bug fixes
480
481 v1.0.0 - 15 May 2010
482 --------------------
483     - Configuration database with remote management
484     - OpenFlow 1.0
485     - GRE tunneling
486     - Support for XenServer 5.5 and 5.6
487     - Performance and scalability improvements
488     - Bug fixes
489
490 v0.99.2 - 18 Feb 2010
491 ---------------------
492     - Bug fixes
493
494 v0.99.1 - 25 Jan 2010
495 ---------------------
496     - Add support for sFlow(R)
497     - Make headers compatible with C++
498     - Bug fixes
499
500 v0.99.0 - 14 Jan 2010
501 ---------------------
502     - User-space forwarding engine
503     - Bug fixes
504
505 v0.90.7 - 29 Nov 2009
506 ---------------------
507     - Add support for NetFlow active timeouts
508     - Bug fixes
509
510 v0.90.6 - 6 Oct 2009
511 --------------------
512     - Bug fixes
513
514 v0.90.5 - 21 Sep 2009
515 ---------------------
516     - Generalize in-band control to more diverse network setups
517     - Bug fixes