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 8-compliant JVM. Certain projects and
  13 certain features of some projects may have additional requirements.
  14 Those are noted in the project-specific release notes.
  15
  16 Projects and features which have known additional requirements are:
  17
  18 * TSDR has extended requirements for external databases
  19 * SFC requires addition features for certain configurations
  20 * SXP depends on TCP-MD5 on thus requires 64-bit Linux
  21 * OpFlex requires Linux
  22 * DLUX requires a modern web browser to view the UI
  23 * AAA when using federation has additional requirements for external tools
  24 * VTN has components which require Linux
  25
  26 For Development
  27 ---------------
  28
  29 OpenDaylight is written primarily in Java project and primarily uses
  30 Maven as a build tool Consequently the two main requirements to develop
  31 projects within OpenDaylight are:
  32
  33 * A Java 8-compliant JDK
  34 * Maven 3.1.1 or later
  35
  36 Applications and tools built on top of OpenDaylight using its REST
  37 APIs should have no special requirements beyond whatever is needed to
  38 run the application or tool and make the REST calls.
  39
  40 In some places, OpenDaylight makes use of the Xtend language. While
  41 Maven will download the appropriate tools to build this, additional
  42 plugins may be required for IDE support.
  43
  44 The projects with additional requirements for execution typically have
  45 similar or more extensive additional requirements for development. See
  46 the project-specific release notes for details.
  47
  48 Known Issues and Limitations
  49 ============================
  50
  51 Other than as noted in project-specific release notes, we know of the
  52 following limitations:
  53
  54 * Migration from prior OpenDaylight releases to |release| has not been
  55   extensively tested. The per-project release notes include migration and
  56   compatibility information when it is known.
  57 * There are scales beyond which the controller has been unreliable when
  58   collecting flow statistics from OpenFlow switches. In tests, these
  59   issues became apparent when managing thousands of OpenFlow
  60   switches; however, this limitation may vary depending on deployment and use
  61   cases.
  62
  63 Project-specific Release Notes
  64 ==============================
  65
  66 .. toctree::
  67    :glob:
  68    :maxdepth: 1
  69
  70     projects/*
  71
  72 .. Service Release Notes
  73 .. =====================
  74 ..
  75 .. .. toctree::
  76 ..   :glob:
  77 ..   :maxdepth: 2
  78 ..
  79 ..   release-notes-*