docs/getting-started-guide/release_notes.rst

   1 Release Notes
   2 =============
   3
   4 Target Environment
   5 ------------------
   6
   7 For Execution
   8 ^^^^^^^^^^^^^
   9
  10 The OpenDaylight Karaf container, OSGi bundles, and Java class files
  11 are portable and should run on any Java 7- or Java 8-compliant JVM to
  12 run. Certain projects and certain features of some projects may have
  13 additional requirements. Those are noted in the project-specific
  14 release notes.
  15
  16 Projects and features which have known additional requirements are:
  17
  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 For Development
  30 ^^^^^^^^^^^^^^^
  31
  32 OpenDaylight is written primarily in Java project and primarily uses
  33 Maven as a build tool Consequently the two main requirements to develop
  34 projects within OpenDaylight are:
  35
  36 * A Java 8-compliant JDK
  37 * Maven 3.1.1 or later
  38
  39 Applications and tools built on top of OpenDaylight using it's REST
  40 APIs should have no special requirements beyond whatever is needed to
  41 run the application or tool and make the REST calls.
  42
  43 In some places, OpenDaylight makes use of the Xtend language. While
  44 Maven will download the appropriate tools to build this, additional
  45 plugins may be required for IDE support.
  46
  47 The projects with additional requirements for execution typically have
  48 similar or more extensive additional requirements for development. See
  49 the project-specific release notes for details.
  50
  51 Known Issues and Limitations
  52 ----------------------------
  53
  54 Other than as noted in project-specific release notes, we know of the
  55 following limitations:
  56
  57 * Migration from Helium, Lithium and Beryllium to Boron has not been
  58   extensively tested. The per-project release notes include migration and
  59   compatibility information when it is known.
  60 * There are scales beyond which the controller has been unreliable when
  61   collecting flow statistics from OpenFlow switches. In tests, these
  62   issues became apparent when managing thousands of OpenFlow
  63   switches, however this may vary depending on deployment and use cases.
  64
  65 .. _proj_rel_notes:
  66
  67 Project-specific Release Notes
  68 ------------------------------
  69
  70 For the release notes of individual projects, please see the following pages on the OpenDaylight Wiki.
  71
  72 TBD: add Boron release notes
  73
  74 * Authentication, Authorization and Accounting (AAA_)
  75 * ALTO_
  76 * BGPCEP_
  77 * Controller_
  78 * Control And Provisioning of Wireless Access Points (CAPWAP_)
  79 * Identification and Driver Management (DIDM_)
  80 * DLUX_
  81 * FaaS_
  82 * Group_Based_Policy_ (GPB)
  83 * Internet of Things Data Management (IoTDM_)
  84 * L2_Switch_
  85 * Link Aggregation Control Protocol (LACP_)
  86 * LISP_Flow_Mapping_
  87 * MDSAL_
  88 * NEMO_
  89 * NETCONF_
  90 * NetIDE_
  91 * NeXt_
  92 * Network Intent Composition (NIC_)
  93 * Neutron_Northbound_
  94 * OF-Config_
  95 * OpFlex_
  96 * OpenFlow_Plugin_
  97 * OpenFlow_Protocol_Library_
  98 * OVSDB_Netvirt_
  99 * Packet_Cable_ / PCMM
 100 * SDN_Interface_Application_
 101 * Secure Network Bootstrapping Infrastructure (SNBI_)
 102 * SNMP4SDN_
 103 * SNMP_Plugin_
 104 * Secure tag eXchange Protocol (SXP_)
 105 * Service Function Chaining (SFC_)
 106 * TCPMD5_
 107 * Time Series Data Repository (TSDR_)
 108 * Table Type Patterns (TTP_)
 109 * Topology_Processing_Framework_
 110 * Unified Secure Channel (USC_)
 111 * VPN_Service_
 112 * Virtual Tenant Network (VTN_)
 113 * YANG_Tools_
 114
 115 Projects without Release Notes
 116 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 117
 118 The following projects participated in Boron, but intentionally do not have release notes.
 119
 120 * **Documentation Project** produced this and the other downloadable documentation
 121 * **Integration Group** hosted the OpenDaylight-wide tests and main release distribution
 122 * **Release Engineering - autorelease** was used to build the Boron release artifacts and including the main release download.
 123
 124 .. _AAA: https://wiki.opendaylight.org/view/AAA:Beryllium_Release_Notes
 125 .. _ALTO: https://wiki.opendaylight.org/view/ALTO:Beryllium:Release_Notes
 126 .. _BGPCEP: https://wiki.opendaylight.org/view/BGP_LS_PCEP:Beryllium_Release_Notes
 127 .. _CAPWAP: https://wiki.opendaylight.org/view/CAPWAP:Beryllium:Release_Notes
 128 .. _Controller: https://wiki.opendaylight.org/view/OpenDaylight_Controller:Beryllium:Release_Notes
 129 .. _DIDM: https://wiki.opendaylight.org/view/DIDM:_Beryllium_Release_Notes
 130 .. _DLUX: https://wiki.opendaylight.org/view/OpenDaylight_DLUX:Beryllium:Release_Notes
 131 .. _FaaS: https://wiki.opendaylight.org/view/FaaS:Beryllium_Release_Notes
 132 .. _Group_Based_Policy: https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Beryllium:Beryllium_Release_Notes
 133 .. _IoTDM: https://wiki.opendaylight.org/view/Iotdm:Beryllium_Release_Notes
 134 .. _L2_Switch: https://wiki.opendaylight.org/view/L2_Switch:Beryllium:Release_Notes
 135 .. _LACP: https://wiki.opendaylight.org/view/LACP:Beryllium:Release_Notes
 136 .. _LISP_Flow_Mapping: https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Beryllium_Release_Notes
 137 .. _MDSAL: https://wiki.opendaylight.org/view/MD-SAL:Beryllium:Release_Notes
 138 .. _NEMO: https://wiki.opendaylight.org/view/NEMO:Beryllium:Release_Notes
 139 .. _NETCONF: https://wiki.opendaylight.org/view/OpenDaylight_NETCONF:Beryllium_Release_Notes
 140 .. _NetIDE: https://wiki.opendaylight.org/view/NetIDE:Release_Notes
 141 .. _NeXt: https://wiki.opendaylight.org/view/NeXt:Beryllium_Release_Notes
 142 .. _NIC: https://wiki.opendaylight.org/view/Network_Intent_Composition:Release_Notes
 143 .. _Neutron_Northbound: https://wiki.opendaylight.org/view/NeutronNorthbound:Beryllium:Release_Notes
 144 .. _OF-Config: https://wiki.opendaylight.org/view/OF-CONFIG:Beryllium:Release_Notes
 145 .. _OpFlex: https://wiki.opendaylight.org/view/OpFlex:Beryllium_Release_Notes
 146 .. _OpenFlow_Plugin: https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Beryllium_Release_Notes
 147 .. _OpenFlow_Protocol_Library: https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes:Beryllium_Release_Notes
 148 .. _OVSDB_Netvirt: https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Beryllium_Release_Notes
 149 .. _Packet_Cable: https://wiki.opendaylight.org/view/PacketCablePCMM:BerylliumReleaseNotes
 150 .. _SDN_Interface_Application: https://wiki.opendaylight.org/view/ODL-SDNi:Beryllium_Release_Notes
 151 .. _SNBI: https://wiki.opendaylight.org/view/SNBI_Berrylium_Release_Notes
 152 .. _SNMP4SDN: https://wiki.opendaylight.org/view/SNMP4SDN:Beryllium_Release_Note
 153 .. _SNMP_Plugin: https://wiki.opendaylight.org/view/SNMP_Plugin:SNMP_Plugin:Beryllium_Release_Notes
 154 .. _SXP: https://wiki.opendaylight.org/view/SXP:Beryllium:Release_Notes
 155 .. _SFC: https://wiki.opendaylight.org/view/Service_Function_Chaining:Beryllium_Release_Notes
 156 .. _TCPMD5: https://wiki.opendaylight.org/view/TCPMD5:Beryllium_Release_Notes
 157 .. _TSDR: https://wiki.opendaylight.org/view/TSDR:Beryllium:Release_Notes
 158 .. _TTP: https://wiki.opendaylight.org/view/Table_Type_Patterns/Beryllium/Release_Notes
 159 .. _Topology_Processing_Framework: https://wiki.opendaylight.org/view/Topology_Processing_Framework:BERYLLIUM_Release_Notes
 160 .. _USC: https://wiki.opendaylight.org/view/USC:Beryllium:Release_Notes
 161 .. _VPN_Service: https://wiki.opendaylight.org/view/Vpnservice:Beryllium_Release_Notes
 162 .. _VTN: https://wiki.opendaylight.org/view/VTN:Beryllium:Release_Notes
 163 .. _YANG_Tools: https://wiki.opendaylight.org/view/YANG_Tools:Beryllium:Release_Notes