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

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