manuals/install-guide/src/main/asciidoc/core-release-notes.adoc

   1 == OpenDaylight Release Notes
   2
   3 === Key Features
   4
   5 A list of the key functionality provided in OpenDaylight Helium can be found in the table in the <<_installing_components,section below>>.
   6
   7 ////
   8 The following table describes the key features provided by OpenDaylight Helium.
   9
  10 [cols="2",option="headers"]
  11 |==============================================
  12 | *Feature* | *Description*
  13 |  Maven support | Used to simplify build automation.
  14 | OSGi framework | Serves as the controller&#8217;s back-end, allowing it to dynamically load bundles, package JAR files, and bind bundles together when exchanging information.
  15 | Java interface support | Used by specific bundles to implement call-back functions for events and indicate the awareness of specific states.
  16 | Model- Driven Service Abstraction Layer (MD-SAL) | Allows the controller to support multiple protocols (such as BGP-LS and OpenFlow) on the southbound interface. Also provides consistent services for modules and applications (which is where the business logic is embedded).
  17 | Switch Manager | Once a network element has been discovered, its details (such as device type, software version, etc.) are stored by the Switch Manager.
  18 | High Availability (HA) | The controller supports cluster-based HA, allowing you to connect multiple controllers and configure them to act as one in order      to ensure the controller&#8217;s continuous operation.
  19 |==============================================
  20 ////
  21 === Target Environment
  22
  23 NOTE: If you are using Oracle, JDK version 1.7.0_45 or later is required.
  24
  25 ==== For Execution
  26
  27 The OpenDaylight controller source files are completely portable and only require a Java 7-compliant JVM to run.
  28
  29 ==== For Development
  30
  31 Although the OpenDaylight controller is developed as a normal Java project, it makes heavy use of the Xtend language in some places. While development is possible with bare tools, we recommend you use Eclipse with the Xtend plugin.
  32
  33 === Helium-SR1 Release Notes
  34
  35 This section details changes and bug fixes between the Helium release of OpenDaylight and the first Helium Stability Release (Helium-SR1) of OpenDaylight. First, we list projects with no noteworthy changes followed by a list of the bugs fixed and/or changes for each project.
  36
  37 ==== Projects with no noteworthy changes
  38
  39 The following projects had no changes in the Helium-SR1 release:
  40
  41 * L2 Switch
  42 * ODL-SDNi Application
  43 * OpenFlow Protocol Library
  44 * PacketCable PCMM
  45 * SNMP4SDN
  46 * Secure Network Bootstrapping Infrastructure
  47 * Service Function Chaining
  48 * Southbound plugin to the OpenContrail Platform
  49 * TCP-MD5
  50 * Table Type Patterns
  51
  52 ==== AAA
  53
  54 * https://bugs.opendaylight.org/show_bug.cgi?id=2292[BUG-2292]: CORS Basic Auth Fix
  55
  56 ==== BGP LS PCEP
  57
  58 * https://bugs.opendaylight.org/show_bug.cgi?id=1921[BUG-1921]: features-bgpcep has incorrect guava version
  59 * https://bugs.opendaylight.org/show_bug.cgi?id=1924[BUG-1924]: features.xml lists multiple commons-codec versions
  60 * https://bugs.opendaylight.org/show_bug.cgi?id=1931[BUG-1931]: Overridden version of junit
  61 * https://bugs.opendaylight.org/show_bug.cgi?id=2082[BUG-2082]: feature.xml is missing dependencies on tcp-md5
  62 * https://bugs.opendaylight.org/show_bug.cgi?id=2109[BUG-2109]: Ghost BGP session could not be cleaned
  63 * https://bugs.opendaylight.org/show_bug.cgi?id=2115[BUG-2115]: close() method of BGPSessionImpl should set the error subcode
  64 * https://bugs.opendaylight.org/show_bug.cgi?id=2167[BUG-2167]: pcc-mock is not bindable to different source addresses
  65 * https://bugs.opendaylight.org/show_bug.cgi?id=2171[BUG-2171]: pcc-mock: enable logging level configuration
  66 * https://bugs.opendaylight.org/show_bug.cgi?id=2201[BUG-2201]: routes announced after initial synchronization not present in loc-rib
  67 * https://bugs.opendaylight.org/show_bug.cgi?id=2204[BUG-2204]: pcc-mock does not support mocking pcc with zero initial lsps
  68
  69 ==== Controller
  70
  71 * https://bugs.opendaylight.org/show_bug.cgi?id=1577[BUG-1577]: Gates access to Shard actor until its initialized
  72 * https://bugs.opendaylight.org/show_bug.cgi?id=1607[BUG-1607]: Clustering : Remove actorFor (deprecated) call from TransactionProxy.java
  73 * https://bugs.opendaylight.org/show_bug.cgi?id=1631[BUG-1631]: Refactored RaftActorBehavior#handleMessage (and related methods) to return RaftActorBehavior instead of RaftActorState.
  74 * https://bugs.opendaylight.org/show_bug.cgi?id=1833[BUG-1833]: Remove all unused code from sal-clustering-commons
  75 * https://bugs.opendaylight.org/show_bug.cgi?id=1839[BUG-1839]: HTTP delete of non existing data
  76 * https://bugs.opendaylight.org/show_bug.cgi?id=1965[BUG-1965]: Fixed DataChangedReply sent to deadletters
  77 * https://bugs.opendaylight.org/show_bug.cgi?id=1966[BUG-1966]: change message logging level (info -> trace)
  78 * https://bugs.opendaylight.org/show_bug.cgi?id=2002[BUG-2002]: Classpath error when loading neutron northbound api
  79 * https://bugs.opendaylight.org/show_bug.cgi?id=2002[BUG-2002]: Classpath error when loading neutron northbound api
  80 * https://bugs.opendaylight.org/show_bug.cgi?id=2003[BUG-2003]: CDS serialization improvements
  81 * https://bugs.opendaylight.org/show_bug.cgi?id=2017[BUG-2017]: Fix possible concurrent modification ex in config subsystem
  82 * https://bugs.opendaylight.org/show_bug.cgi?id=2038[BUG-2038]: Ensure only one concurrent 3-phase commit in Shard
  83 * https://bugs.opendaylight.org/show_bug.cgi?id=2047[BUG-2047]: HTTP GET - no returning error message
  84 * https://bugs.opendaylight.org/show_bug.cgi?id=2055[BUG-2055]: Handle Tx create in TransactionProxy resiliently
  85 * https://bugs.opendaylight.org/show_bug.cgi?id=2055[BUG-2055]: Handle shard not initialized resiliently
  86 * https://bugs.opendaylight.org/show_bug.cgi?id=2086[BUG-2086]: Adding normalized node  stream reader and writer
  87 * https://bugs.opendaylight.org/show_bug.cgi?id=2098[BUG-2098]: sal-compatibility not get up-to-date flow information
  88 * https://bugs.opendaylight.org/show_bug.cgi?id=2114[BUG-2114]: Adds handling of "leaf" node at the module level.
  89 * https://bugs.opendaylight.org/show_bug.cgi?id=2131[BUG-2131]: NPE when starting controller
  90 * https://bugs.opendaylight.org/show_bug.cgi?id=2134[BUG-2134]: Fix intermittent RaftActorTest failure
  91 * https://bugs.opendaylight.org/show_bug.cgi?id=2134[BUG-2134]: Make persistence configurable at the datastore level
  92 * https://bugs.opendaylight.org/show_bug.cgi?id=2135[BUG-2135]: Create ShardInformation on startup
  93 * https://bugs.opendaylight.org/show_bug.cgi?id=2136[BUG-2136]: Clustering : When a transaction is local then do not serialize the Reading/Writing of data
  94 * https://bugs.opendaylight.org/show_bug.cgi?id=2160[BUG-2160]: Added concurrent 3-phase commit coordinator
  95 * https://bugs.opendaylight.org/show_bug.cgi?id=2174[BUG-2174]: XSQL log file is hardcode to /tmp/xql.log
  96 * https://bugs.opendaylight.org/show_bug.cgi?id=2184[BUG-2184]: Fix config.yang module(add type as a key for modules list)
  97 * https://bugs.opendaylight.org/show_bug.cgi?id=2184[BUG-2184]: Fix subtree filtering for identity-ref leaves
  98 * https://bugs.opendaylight.org/show_bug.cgi?id=2207[BUG-2207]: Make reconnect promise reconnect even if session was dropped during negotiation
  99 * https://bugs.opendaylight.org/show_bug.cgi?id=2210[BUG-2210]: Fixed initial DCL notification on registration
 100 * https://bugs.opendaylight.org/show_bug.cgi?id=2217[BUG-2217]: Add missing namespace to serialized inner runtime beans
 101 * https://bugs.opendaylight.org/show_bug.cgi?id=2221[BUG-2221]: Add metering to ShardTransaction actor
 102 * https://bugs.opendaylight.org/show_bug.cgi?id=2252[BUG-2252]: Terminate ShardWriteTransaction actor on ready
 103 * https://bugs.opendaylight.org/show_bug.cgi?id=2265[BUG-2265]: Modified NormalizedNodeOutputStreamWriter to implement yangtools interface
 104 * https://bugs.opendaylight.org/show_bug.cgi?id=2290[BUG-2290]: Add IPv6 support Neutron APIs
 105 * https://bugs.opendaylight.org/show_bug.cgi?id=2294[BUG-2294]: Handle Shard backwards compatibility
 106 * https://bugs.opendaylight.org/show_bug.cgi?id=2296[BUG-2296]: TransactionProxy should support the ability to accept a local TPC actor path
 107 * https://bugs.opendaylight.org/show_bug.cgi?id=2318[BUG-2318]: Ensure previous Tx in chain is readied before creating the next
 108 * https://bugs.opendaylight.org/show_bug.cgi?id=2325[BUG-2325]: Value type of byte[] not recognized by the NormalizedNodeSerializer
 109 * Fix intermittent failure in DataChangeListenerTest
 110
 111 .Reverted for Helium-SR1, but should be expected in Helium SR2
 112 * https://bugs.opendaylight.org/show_bug.cgi?id=1764[BUG-1764]
 113 * https://bugs.opendaylight.org/show_bug.cgi?id=2254[BUG-2254]
 114
 115 ==== Defense4All
 116
 117 * Fixing RPM/DEB pkgs versions
 118
 119 ==== DLUX
 120
 121 * Flow links broken; fixed duplicate ENV call to get the correct restconf url
 122
 123 ==== Group Based Policy
 124
 125 * https://bugs.opendaylight.org/show_bug.cgi?id=2112[BUG-2112]: Workaround for missing flows in POC demo.
 126
 127 ==== Integration
 128
 129 * https://bugs.opendaylight.org/show_bug.cgi?id=2274[BUG-2274]: User odl-restconf-noauth feature by default" into stable/helium
 130 * Added a docker distribution
 131
 132 ==== Lisp Flow Mapping
 133
 134 * Fix SMR not being built on IPv6 enabled hosts
 135
 136 ==== OpenFlow Plugin
 137
 138 * https://bugs.opendaylight.org/show_bug.cgi?id=1491[BUG-1491]: OF plugin does not handle SET_TP_SRC/SET_TP_DST actions
 139 * https://bugs.opendaylight.org/show_bug.cgi?id=1680[BUG-1680]: pushing of default table-miss-entry feature should be pulled out into separate module
 140 * https://bugs.opendaylight.org/show_bug.cgi?id=2098[BUG-2098]: Multipart Request flow was not set to the flow case
 141 * https://bugs.opendaylight.org/show_bug.cgi?id=2126[BUG-2126]: MatchConvertorImpl.OfMatchToSALMatchConvertor() converts OF13 match into incorrect MD-SAL match
 142 * https://bugs.opendaylight.org/show_bug.cgi?id=2127[BUG-2127]: IllegalArgumentException in MatchConvertorImpl.fromOFMatchV10ToSALMatch().
 143 * https://bugs.opendaylight.org/show_bug.cgi?id=2128[BUG-2128]: Large PACKET_IN message from OF10 switch may be truncated
 144
 145 ==== Open vSwitch Database (OVSDB) Integration
 146
 147 * https://bugs.opendaylight.org/show_bug.cgi?id=2076[BUG-2076]: Routing does not work unless node contains vms on all vlans (segIds)
 148 * https://bugs.opendaylight.org/show_bug.cgi?id=2192[BUG-2192]: Fix access to custom.properties, so non-default values can be provided
 149 * https://bugs.opendaylight.org/show_bug.cgi?id=2214[BUG-2214]: Unable to set the external_ids field of the Qos object
 150 * Fix issue found by sonar: Method call on object which may be null
 151 * Ignore testGetOpenflowVersion: it is no longer applicable
 152
 153 ==== Virtual Tenant Networking
 154
 155 * https://bugs.opendaylight.org/show_bug.cgi?id=1992[BUG-1992]: Failed to get up-to-date flow statistics.
 156 * https://bugs.opendaylight.org/show_bug.cgi?id=2235[BUG-2235]: PathPolicy(long, List) always throws NullPointerException.
 157 * https://bugs.opendaylight.org/show_bug.cgi?id=2236[BUG-2236]: PathMap class handles mapIndex field incorrectly.
 158 * https://bugs.opendaylight.org/show_bug.cgi?id=2239[BUG-2239]: Minor bugs in manager.neutron bundle.
 159
 160 ==== YANG Tools
 161
 162 * https://bugs.opendaylight.org/show_bug.cgi?id=1957[BUG-1957]: StackOverFlowError in YangParserImpl
 163 * https://bugs.opendaylight.org/show_bug.cgi?id=1975[BUG-1975]: yang unkeyed list is transformed to map node
 164 * https://bugs.opendaylight.org/show_bug.cgi?id=2117[BUG-2117]: Inner grouping used in outer grouping's choice case
 165 * https://bugs.opendaylight.org/show_bug.cgi?id=2147[BUG-2147]: JSON does not properly encode multiline string
 166 * https://bugs.opendaylight.org/show_bug.cgi?id=2155[BUG-2155]: depth parameter in NormalizedNodeWriter
 167 * https://bugs.opendaylight.org/show_bug.cgi?id=2156[BUG-2156]: Unsupported augment target
 168 * https://bugs.opendaylight.org/show_bug.cgi?id=2172[BUG-2172]: AbstractGeneratedTypeBuilder check for duplicate elements.
 169 * https://bugs.opendaylight.org/show_bug.cgi?id=2176[BUG-2176]: add property with name == null fix.
 170 * https://bugs.opendaylight.org/show_bug.cgi?id=2180[BUG-2180]: schema aware builders for ordered list and leaf-list are absent
 171 * https://bugs.opendaylight.org/show_bug.cgi?id=2183[BUG-2183]: ClassCastException in AbstractTypeMemberBuilder fix
 172 * https://bugs.opendaylight.org/show_bug.cgi?id=2191[BUG-2191]: Invalid use of addType in ChoiceCaseBuilder
 173 * https://bugs.opendaylight.org/show_bug.cgi?id=2202[BUG-2202]: DerivableSchemaNode API incorrect Javadoc
 174 * https://bugs.opendaylight.org/show_bug.cgi?id=2271[BUG-2271]: Fixed potentional NPE in generateTypesFromChoiceCases
 175 * https://bugs.opendaylight.org/show_bug.cgi?id=2279[BUG-2279]: top level element should be entry and not list
 176 * https://bugs.opendaylight.org/show_bug.cgi?id=2291[BUG-2291]: When revision statement enclose a custom statement, Yang Parser fails to parse correctly
 177 * Parent schema node input parameter in JsonParserStream
 178 * Remove module name prefix from top level element
 179
 180 .Reverted for Helium-SR1, but should be expected in Helium SR2
 181 * https://bugs.opendaylight.org/show_bug.cgi?id=2329[BUG-2329]
 182 * https://bugs.opendaylight.org/show_bug.cgi?id=2282[BUG-2282]
 183
 184 === Known Issues and Limitations
 185
 186 Other than as noted in project-specific release notes, there are two known limitations.
 187
 188 . The Karaf distribution of OpenDaylight requires internet access when run for the first time.
 189 . There are scales beyond which the controller has been unreliable when collecting flow statistics from OpenFlow switches. In tests, theses issues became apparent when managing 10s of thousands of OpenFlow switches, however this may vary depending on deployment and use cases. Flow programming has been unaffected in our tests.
 190
 191 ==== Full Bug List
 192
 193 All of the known issues for the OpenDaylight Helium release are listed https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&columnlist=product%2Ccomponent%2Cassigned_to%2Cbug_status%2Cresolution%2Cshort_desc%2Cchangeddate%2Ccf_target_milestone&f1=cf_target_milestone&list_id=15952&n1=1&o1=substring&query_based_on=&query_format=advanced&resolution=---&v1=Lithium[here].
 194
 195 === Project-specific Helium Release Notes
 196
 197 Project-specific release notes for the Helium release can be found on the OpenDaylight wiki. This table provides links to them by project.
 198
 199 [options="header",cols="1,4"]
 200 |==============================================
 201 | Project | Release Notes URL
 202 | AAA | https://wiki.opendaylight.org/view/AAA:Helium_Release_Notes
 203 | BGPCEP | https://wiki.opendaylight.org/view/BGP_LS_PCEP:Helium_Release_Notes
 204 | DLUX | https://wiki.opendaylight.org/view/OpenDaylight_dlux:Release_Notes_Helium
 205 | Group Based Policy | https://wiki.opendaylight.org/view/Group_Policy:Helium-Release-Notes
 206 | L2 Switch | https://wiki.opendaylight.org/view/L2_Switch:Helium:Release_Notes
 207 | LISP Flow Mapping | https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:_Helium_Release_Notes
 208 | OpenFlow Plugin | https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Helium_Release_Notes
 209 | OpenFlow Protocol Library | https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes
 210 | OVSDB | https://wiki.opendaylight.org/view/OVSDB_Integration:Helium_Release_Notes
 211 | PackCable PCMM | https://wiki.opendaylight.org/view/PacketCablePCMM:ReleaseNotes
 212 | Plugin2OC | https://wiki.opendaylight.org/view/Southbound_Plugin_to_the_OpenContrail_Platform:Helium_Release_Notes
 213 | SDNi | https://wiki.opendaylight.org/view/ODL-SDNi_App:Helium_Release_Notes
 214 | SNBI | https://wiki.opendaylight.org/view/SecureNetworkBootstrapping:HeliumReleaseNotes
 215 | SNMP4SDN | https://wiki.opendaylight.org/view/SNMP4SDN:Helium_Release_Note
 216 | SFC | https://wiki.opendaylight.org/view/Service_Function_Chaining:Helium_Release_Notes
 217 | TCPMD5 | https://wiki.opendaylight.org/view/TCPMD5:Helium_Release_Notes
 218 | TTP | https://wiki.opendaylight.org/view/Table_Type_Patterns:Helium_Release_Notes
 219 | VTN | https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):Helium_Release_Notes
 220 | Yang Tools | https://wiki.opendaylight.org/view/YANG_Tools:Helium:Release_Notes
 221 |==============================================
 222