manuals/getting-started-guide/src/main/asciidoc/release-notes.adoc

   1 == OpenDaylight Release Notes
   2
   3 === Target Environment
   4
   5 ==== For Execution
   6
   7 The OpenDaylight Karaf container, OSGi bundles, and Java class files
   8 are portable and should run on any Java 7- or Java 8-compliant JVM to
   9 run. Certain projects and certain features of some projects may have
  10 additional requirements. Those are noted in the project-specific
  11 release notes.
  12
  13 Projects and features which have known additional requirements are:
  14 * TCP-MD5 requires 64-bit Linux
  15 * TSDR has extended requirements for external databases
  16 * Persistence has extended requirements for external databases
  17 * SFC requires addition features for certain configurations
  18 * SXP depends on TCP-MD5 on thus requires 64-bit Linux
  19 * SNBI has requirements for Linux and Docker
  20 * OpFlex requires Linux
  21 * DLUX requires a modern web browser to view the UI
  22 * AAA when using federation has additional requirements for external tools
  23 * VTN has components which require Linux
  24
  25 NOTE: If you are using the Oracle JDK, version 1.7.0_45 or later is required.
  26
  27 ==== For Development
  28
  29 OpenDaylight is written primarily in Java project and primarily uses
  30 Maven as a build tool Consequently the two main requirements to develop
  31 projects within OpenDaylight are:
  32
  33 * A Java 7- or Java 8-compliant JDK
  34 * Maven 3.1.1 or later
  35
  36 Applications and tools built on top of OpenDaylight using it's REST
  37 APIs should have no special requirements beyond whatever is needed to
  38 run the application or tool and make the REST calls.
  39
  40 In some places, OpenDaylight makes use of the Xtend language. While
  41 Maven will download the appropriate tools to build this, additional
  42 plugins may be required for IDE support.
  43
  44 The projects with additional requirements for execution typically have
  45 similar or more extensive additional requirements for development. See
  46 the project-specific release notes for details.
  47
  48 === Known Issues and Limitations
  49
  50 Other than as noted in project-specific release notes, we know of the
  51 following limitations:
  52
  53 . Migration from Helium to Lithium has not been extensively tested. The
  54 per-project release notes include migration and compatibility
  55 information when it is known. Broader support is anticipated in a later
  56 Lithium service release.
  57 . There are scales beyond which the controller has been unreliable when
  58 collecting flow statistics from OpenFlow switches. In tests, these
  59 issues became apparent when managing thousands of OpenFlow
  60 switches, however this may vary depending on deployment and use cases.
  61
  62 === Project-specific Release Notes
  63
  64 For the release notes of individual projects, please see the following pages on the OpenDaylight Wiki.
  65
  66 * https://wiki.opendaylight.org/view/AAA:Lithium_Release_Notes[Authentication, Authorization and Accounting (AAA)]
  67 * https://wiki.opendaylight.org/view/ALTO:Lithium:Release_Notes[ALTO]
  68 * https://wiki.opendaylight.org/view/BGP_LS_PCEP:Lithium_Release_Notes[BGP PCEP]
  69 * https://wiki.opendaylight.org/view/OpenDaylight_Controller:Lithium:Release_Notes[Controller]
  70 * https://wiki.opendaylight.org/view/CAPWAP:Lithium:Release_Notes[Control And Provisioning of Wireless Access Points (CAPWAP)]
  71 * https://wiki.opendaylight.org/view/DIDM:_Lithium_Release_Notes[Device Identification and Driver Management (DIDM)]
  72 * https://wiki.opendaylight.org/view/OpenDaylight_dlux:Lithium_Release_Notes[DLUX]
  73 * https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Lithium/Release_Notes[Group Based Policy (GPB)]
  74 * https://wiki.opendaylight.org/view/Iotdm:Lithium_Release_Notes[Internet of Things Data Management (IoTDM)]
  75 * https://wiki.opendaylight.org/view/L2_Switch:Lithium:Release_Notes[L2 Switch]
  76 * https://wiki.opendaylight.org/view/LACP:Lithium:Release_Notes[Link Aggregation Control Protocol (LACP)]
  77 * https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Lithium_Release_Notes[LISP Flow Mapping]
  78 * https://wiki.opendaylight.org/view/Network_Intent_Composition:Lithium_Release_Notes[Network Intent Composition]
  79 * https://wiki.opendaylight.org/view/NeutronNorthbound:LithiumReleaseNotes[Neutron Northbound]
  80 * https://wiki.opendaylight.org/view/ODL_Root_Parent:Lithium_Release_Notes[ODL Root Parent]
  81 * https://wiki.opendaylight.org/view/OpFlex:Lithium_Release_Notes[OpFlex]
  82 * https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Lithium_Release_Notes[OpenFlow Plugin]
  83 * https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes:Lithium_Release_Notes[OpenFlow Protocol Library]
  84 * https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Lithium_Release_Notes[OVSDB Integration]
  85 * https://wiki.opendaylight.org/view/PacketCablePCMM:LithiumReleaseNotes[Packet Cable/PCMM]
  86 * https://wiki.opendaylight.org/view/Persistence:Lithium_Release_Notes[Persistence]
  87 * https://wiki.opendaylight.org/view/Reservation:Lithium_Release_Notes[Reservation]
  88 * https://wiki.opendaylight.org/view/ODL-SDNi:Lithium_Release_Notes[SDN Interface Application]
  89 * https://wiki.opendaylight.org/view/SNBI_Lithium_Release_Notes[Secure Network Bootstrapping Infrastructure (SNBI)]
  90 * https://wiki.opendaylight.org/view/SNMP4SDN:Lithium_Release_Note[SNMP4SDN]
  91 * https://wiki.opendaylight.org/view/SNMP_Plugin:Lithium_Release_Notes[SNMP Plugin]
  92 * https://wiki.opendaylight.org/view/SXP:Lithium:Release_Notes[Secure tag eXchange Protocol (SXP)]
  93 * https://wiki.opendaylight.org/view/Service_Function_Chaining:Lithium_Release_Notes[Service Function Chaining (SFC)]
  94 * https://wiki.opendaylight.org/view/TCPMD5:Lithium_Release_Notes[TCP-MD5]
  95 * https://wiki.opendaylight.org/view/TSDR:Lithium:Release_Notes[Time Series Data Repository (TSDR)]
  96 * https://wiki.opendaylight.org/view/Table_Type_Patterns/Lithium/Release_Notes[Table Type Patterns (TTP)]
  97 * https://wiki.opendaylight.org/view/Topology_Processing_Framework:Lithium_Release_Notes[Topology Processing Framework]
  98 * https://wiki.opendaylight.org/view/USC:Lithium:Release_Notes[Universal Secure Channel (USC)]
  99 * https://wiki.opendaylight.org/view/Vpnservice:Lithium_Release_Notes[VPN Service]
 100 * https://wiki.opendaylight.org/view/OpenDaylight_Virtual_Tenant_Network_(VTN):Lithium_Release_Notes[Virtual Tenant Network (VTN)]
 101 * https://wiki.opendaylight.org/view/YANG_Tools:Lithium:Release_Notes[YANG Tools]
 102
 103 ==== Projects without Release Notes
 104
 105 The following projects participated in Lithium, but intentionally do not have release notes.
 106
 107 * *Documentation Project* produced this and the other downloadable documentation
 108 * *Integration Group* hosted the OpenDaylight-wide tests and main release distribution
 109 ** *Controller Core Functionality Tutorials* provided a single test suite (dsbenchmark) that was used as part of integration testing
 110 * *Release Engineering - autorelease* was used to build the Lithium release artifacts and including the main release download.