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