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 prior OpenDaylight releases to Carbon 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 .. toctree::
  72    :maxdepth: 1
  73
  74    project-release-notes/aaa
  75    project-release-notes/alto
  76    project-release-notes/bgp-ls-pcep
  77    project-release-notes/bier
  78    project-release-notes/cardinal
  79    project-release-notes/controller
  80    project-release-notes/didm
  81    project-release-notes/distribution
  82    project-release-notes/dluxapps
  83    project-release-notes/docs
  84    project-release-notes/eman
  85    project-release-notes/faas-release-notes
  86    project-release-notes/federation
  87    project-release-notes/gbp-release-notes
  88    project-release-notes/genius
  89    project-release-notes/infrautils
  90    project-release-notes/iotdm
  91    project-release-notes/l2switch
  92    project-release-notes/lacp
  93    project-release-notes/lispflowmapping
  94    project-release-notes/mdsal
  95    project-release-notes/netconf
  96    project-release-notes/netide
  97    project-release-notes/netvirt
  98    project-release-notes/neutron-northbound
  99    project-release-notes/nic
 100    project-release-notes/ocpplugin-release-notes
 101    project-release-notes/odl-sdni-release-notes
 102    project-release-notes/odlparent
 103    project-release-notes/of-config-release-notes
 104    project-release-notes/openflowjava
 105    project-release-notes/openflowplugin
 106    project-release-notes/opflex
 107    project-release-notes/ovsdb
 108    project-release-notes/sfc
 109    project-release-notes/snmp
 110    project-release-notes/snmp4sdn
 111    project-release-notes/sxp
 112    project-release-notes/topology-processing-framework
 113    project-release-notes/tsdr
 114    project-release-notes/ttp
 115    project-release-notes/unimgr
 116    project-release-notes/usc
 117    project-release-notes/vbd
 118    project-release-notes/vtn
 119    project-release-notes/yangtools
 120
 121 .. Still missing:
 122 .. * PacketCable: https://git.opendaylight.org/gerrit/57218
 123 .. * DLUX
 124 .. * NeXt