docs/getting-started-guide/release_notes.rst

   1 *************
   2 Release Notes
   3 *************
   4
   5 Target Environment
   6 ==================
   7
   8 For Execution
   9 -------------
  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
  19 * TCP-MD5 requires 64-bit Linux
  20 * TSDR has extended requirements for external databases
  21 * Persistence has extended requirements for external databases
  22 * SFC requires addition features for certain configurations
  23 * SXP depends on TCP-MD5 on thus requires 64-bit Linux
  24 * SNBI has requirements for Linux and Docker
  25 * OpFlex requires Linux
  26 * DLUX requires a modern web browser to view the UI
  27 * AAA when using federation has additional requirements for external tools
  28 * VTN has components which require Linux
  29
  30 For Development
  31 ---------------
  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 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
  55 Other than as noted in project-specific release notes, we know of the
  56 following limitations:
  57
  58 * Migration from Helium, Lithium and Beryllium to Boron has not been
  59   extensively tested. The per-project release notes include migration and
  60   compatibility information when it is known.
  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 .. _proj_rel_notes:
  67
  68 Project-specific Release Notes
  69 ==============================
  70
  71 For the release notes of individual projects, please see the following pages on the OpenDaylight Wiki.
  72
  73 TBD: add Boron release notes
  74
  75 * Authentication, Authorization and Accounting (AAA_)
  76 * ALTO_
  77 * BGPCEP_
  78 * Controller_
  79 * Control And Provisioning of Wireless Access Points (CAPWAP_)
  80 * Identification and Driver Management (DIDM_)
  81 * DLUX_
  82 * FaaS_
  83 * Group_Based_Policy_ (GPB)
  84 * Internet of Things Data Management (IoTDM_)
  85 * L2_Switch_
  86 * Link Aggregation Control Protocol (LACP_)
  87 * LISP_Flow_Mapping_
  88 * MDSAL_
  89 * NEMO_
  90 * NETCONF_
  91 * NetIDE_
  92 * NeXt_
  93 * Network Intent Composition (NIC_)
  94 * Neutron_Northbound_
  95 * OF-Config_
  96 * OpFlex_
  97 * OpenFlow_Plugin_
  98 * OpenFlow_Protocol_Library_
  99 * OVSDB_Netvirt_
 100 * Packet_Cable_ / PCMM
 101 * SDN_Interface_Application_
 102 * Secure Network Bootstrapping Infrastructure (SNBI_)
 103 * SNMP4SDN_
 104 * SNMP_Plugin_
 105 * Secure tag eXchange Protocol (SXP_)
 106 * Service Function Chaining (SFC_)
 107 * TCPMD5_
 108 * Time Series Data Repository (TSDR_)
 109 * Table Type Patterns (TTP_)
 110 * Topology_Processing_Framework_
 111 * Unified Secure Channel (USC_)
 112 * VPN_Service_
 113 * Virtual Tenant Network (VTN_)
 114 * YANG_Tools_
 115
 116 Projects without Release Notes
 117 ------------------------------
 118
 119 The following projects participated in Boron, but intentionally do not have release notes.
 120
 121 * **Documentation Project** produced this and the other downloadable documentation
 122 * **Integration Group** hosted the OpenDaylight-wide tests and main release distribution
 123 * **Release Engineering - autorelease** was used to build the Boron release artifacts and including the main release download.
 124
 125 .. _AAA: https://wiki.opendaylight.org/view/AAA:Beryllium_Release_Notes
 126 .. _ALTO: https://wiki.opendaylight.org/view/ALTO:Beryllium:Release_Notes
 127 .. _BGPCEP: https://wiki.opendaylight.org/view/BGP_LS_PCEP:Beryllium_Release_Notes
 128 .. _CAPWAP: https://wiki.opendaylight.org/view/CAPWAP:Beryllium:Release_Notes
 129 .. _Controller: https://wiki.opendaylight.org/view/OpenDaylight_Controller:Beryllium:Release_Notes
 130 .. _DIDM: https://wiki.opendaylight.org/view/DIDM:_Beryllium_Release_Notes
 131 .. _DLUX: https://wiki.opendaylight.org/view/OpenDaylight_DLUX:Beryllium:Release_Notes
 132 .. _FaaS: https://wiki.opendaylight.org/view/FaaS:Beryllium_Release_Notes
 133 .. _Group_Based_Policy: https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Beryllium:Beryllium_Release_Notes
 134 .. _IoTDM: https://wiki.opendaylight.org/view/Iotdm:Beryllium_Release_Notes
 135 .. _L2_Switch: https://wiki.opendaylight.org/view/L2_Switch:Beryllium:Release_Notes
 136 .. _LACP: https://wiki.opendaylight.org/view/LACP:Beryllium:Release_Notes
 137 .. _LISP_Flow_Mapping: https://wiki.opendaylight.org/view/OpenDaylight_Lisp_Flow_Mapping:Beryllium_Release_Notes
 138 .. _MDSAL: https://wiki.opendaylight.org/view/MD-SAL:Beryllium:Release_Notes
 139 .. _NEMO: https://wiki.opendaylight.org/view/NEMO:Beryllium:Release_Notes
 140 .. _NETCONF: https://wiki.opendaylight.org/view/OpenDaylight_NETCONF:Beryllium_Release_Notes
 141 .. _NetIDE: https://wiki.opendaylight.org/view/NetIDE:Release_Notes
 142 .. _NeXt: https://wiki.opendaylight.org/view/NeXt:Beryllium_Release_Notes
 143 .. _NIC: https://wiki.opendaylight.org/view/Network_Intent_Composition:Release_Notes
 144 .. _Neutron_Northbound: https://wiki.opendaylight.org/view/NeutronNorthbound:Beryllium:Release_Notes
 145 .. _OF-Config: https://wiki.opendaylight.org/view/OF-CONFIG:Beryllium:Release_Notes
 146 .. _OpFlex: https://wiki.opendaylight.org/view/OpFlex:Beryllium_Release_Notes
 147 .. _OpenFlow_Plugin: https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Beryllium_Release_Notes
 148 .. _OpenFlow_Protocol_Library: https://wiki.opendaylight.org/view/Openflow_Protocol_Library:Release_Notes:Beryllium_Release_Notes
 149 .. _OVSDB_Netvirt: https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Beryllium_Release_Notes
 150 .. _Packet_Cable: https://wiki.opendaylight.org/view/PacketCablePCMM:BerylliumReleaseNotes
 151 .. _SDN_Interface_Application: https://wiki.opendaylight.org/view/ODL-SDNi:Beryllium_Release_Notes
 152 .. _SNBI: https://wiki.opendaylight.org/view/SNBI_Berrylium_Release_Notes
 153 .. _SNMP4SDN: https://wiki.opendaylight.org/view/SNMP4SDN:Beryllium_Release_Note
 154 .. _SNMP_Plugin: https://wiki.opendaylight.org/view/SNMP_Plugin:SNMP_Plugin:Beryllium_Release_Notes
 155 .. _SXP: https://wiki.opendaylight.org/view/SXP:Beryllium:Release_Notes
 156 .. _SFC: https://wiki.opendaylight.org/view/Service_Function_Chaining:Beryllium_Release_Notes
 157 .. _TCPMD5: https://wiki.opendaylight.org/view/TCPMD5:Beryllium_Release_Notes
 158 .. _TSDR: https://wiki.opendaylight.org/view/TSDR:Beryllium:Release_Notes
 159 .. _TTP: https://wiki.opendaylight.org/view/Table_Type_Patterns/Beryllium/Release_Notes
 160 .. _Topology_Processing_Framework: https://wiki.opendaylight.org/view/Topology_Processing_Framework:BERYLLIUM_Release_Notes
 161 .. _USC: https://wiki.opendaylight.org/view/USC:Beryllium:Release_Notes
 162 .. _VPN_Service: https://wiki.opendaylight.org/view/Vpnservice:Beryllium_Release_Notes
 163 .. _VTN: https://wiki.opendaylight.org/view/VTN:Beryllium:Release_Notes
 164 .. _YANG_Tools: https://wiki.opendaylight.org/view/YANG_Tools:Beryllium:Release_Notes