docs/release-notes/index.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 prior OpenDaylight releases to Nitrogen 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 Project-specific Release Notes
  67 ==============================
  68
  69 .. toctree::
  70    :glob:
  71    :maxdepth: 1
  72
  73    projects/*
  74
  75 Service Release Notes
  76 =====================
  77
  78 .. toctree::
  79    :glob:
  80    :maxdepth: 2
  81
  82    release-notes-*