Release Notes
#############
-Target Environment
-==================
+Execution
+---------
-For Execution
--------------
+OpenDaylight includes `Karaf <https://karaf.apache.org>`_ containers, `OSGi <https://www.osgi.org>`_
+(Open Service Gateway Initiative) bundles, and Java class files, which are portable and can run on
+any Java 11-compliant JVM (Java virtual machine). Any add-on project or feature of a
+specific project may have additional requirements.
-The OpenDaylight Karaf container, OSGi bundles, and Java class files
-are portable and should run on any Java 8-compliant JVM. Certain projects and
-certain features of some projects may have additional requirements.
-Those are noted in the project-specific release notes.
+Development
+-----------
-Projects and features which have known additional requirements are:
+OpenDaylight is written in Java and utilizes Maven as a build tool. Therefore,
+the only requirements needed to develop projects within OpenDaylight include:
-* TSDR has extended requirements for external databases
-* SFC requires addition features for certain configurations
-* SXP depends on TCP-MD5 on thus requires 64-bit Linux
-* OpFlex requires Linux
-* DLUX requires a modern web browser to view the UI
-* AAA when using federation has additional requirements for external tools
-* VTN has components which require Linux
+* `Java JDK 11 <https://www.oracle.com/java/technologies/javase/products-doc-jdk11certconfig.html>`_
+* `Apache Maven <https://maven.apache.org>`_ 3.5.2 or later
-For Development
----------------
+If an application or tool is built on top of OpenDaylight’s REST APIs, it does not
+have any special requirement beyond what is necessary to run the application or tool
+to make REST calls.
-OpenDaylight is written primarily in Java project and primarily uses
-Maven as a build tool Consequently the two main requirements to develop
-projects within OpenDaylight are:
+In some instances, OpenDaylight uses the `Xtend <https://www.eclipse.org/xtend/>`_ language.
+Even though Maven downloads all appropriate tools to build applications; additional plugins
+may be required to support IDE.
-* A Java 8-compliant JDK
-* Maven 3.1.1 or later
+Projects with additional requirements for execution typically have similar or
+additional requirements for development. See the platforms release notes for details.
-Applications and tools built on top of OpenDaylight using its REST
-APIs should have no special requirements beyond whatever is needed to
-run the application or tool and make the REST calls.
+Platform Release Notes
+======================
-In some places, OpenDaylight makes use of the Xtend language. While
-Maven will download the appropriate tools to build this, additional
-plugins may be required for IDE support.
+.. toctree::
+ :glob:
+ :maxdepth: 1
-The projects with additional requirements for execution typically have
-similar or more extensive additional requirements for development. See
-the project-specific release notes for details.
+ upgrade-process
-Known Issues and Limitations
-============================
+Project Release Notes
+=====================
-Other than as noted in project-specific release notes, we know of the
-following limitations:
+.. toctree::
+ :glob:
+ :maxdepth: 1
-* Migration from prior OpenDaylight releases to |release| has not been
- extensively tested. The per-project release notes include migration and
- compatibility information when it is known.
-* There are scales beyond which the controller has been unreliable when
- collecting flow statistics from OpenFlow switches. In tests, these
- issues became apparent when managing thousands of OpenFlow
- switches; however, this limitation may vary depending on deployment and use
- cases.
+ projects/*
-Project-specific Release Notes
-==============================
+Service Release Notes
+=====================
.. toctree::
:glob:
:maxdepth: 1
- projects/*
-
-.. Service Release Notes
-.. =====================
-..
-.. .. toctree::
-.. :glob:
-.. :maxdepth: 2
-..
-.. release-notes-*
+ release-notes-*