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