docs/release-notes/projects/odlparent.rst

   1 ==========
   2 ODL Parent
   3 ==========
   4
   5 Major Features
   6 ==============
   7
   8 There are no user-visible features.
   9
  10 Documentation
  11 =============
  12
  13 * **Developer Guide(s):**
  14
  15   * :ref:`odl-parent-developer-guide`
  16
  17 Security Considerations
  18 =======================
  19
  20 * Do you have any external interfaces other than RESTCONF?
  21
  22   No.
  23
  24 * Other security issues?
  25
  26   No.
  27
  28 Quality Assurance
  29 =================
  30
  31 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=23179>`_ (6.4% coverage)
  32 * There are no CSIT jobs, ODL Parent has a system test waiver
  33 * ODL Parent is tested by all builds, and manually tested by running the basic
  34   Karaf container and verifying the scripts we modify (``client`` in
  35   particular).
  36 * We verify the following:
  37
  38   * ``start`` starts the Karaf container.
  39     (in a working state, capable of installing features)
  40   * ``client`` can connect to a running Karaf container.
  41   * ``stop`` stops a running Karaf container.
  42
  43 Migration
  44 ---------
  45
  46 * Is it possible to migrate from the previous release? If so, how?
  47
  48   Yes. Projects may encounter issues upgrading to Karaf 4.1, which is used in
  49   this release; however there aren’t generic upgrade instructions.
  50
  51 Compatibility
  52 -------------
  53
  54 * Is this release compatible with the previous release?
  55
  56   No.
  57
  58 * Any API changes?
  59
  60   The ``odl-triemap-0.2`` feature wrapping
  61   ``com.github.romix:java-concurrent-hash-trie-map`` was rendered obsolete by
  62   YANG Tools' implementation and has been removed.
  63
  64   The following third-party dependencies have been removed from dependency
  65   management:
  66
  67     * Chameleon MBeans
  68     * Eclipse Link
  69     * Equinox HTTP service bridge
  70     * ``equinoxSDK381`` artifacts
  71     * Coda Hale Metrics, which are mostly unused and should eventually be wrapped
  72       by InfraUtils
  73     * ``com.google.code.findbugs:jsr305`` (which *must not* be used; this is
  74       enforced — ``annotations`` should be used instead)
  75     * Felix File Install and Web Console
  76     * Gemini Web
  77     * Orbit
  78     * ``org.mockito:mockito-all`` (which *must not* be used; this is enforced —
  79       ``mockito-core`` should be used instead)
  80     * Spring Framework
  81     * ``txw2``
  82     * Xerces
  83     * ``xml-apis``
  84
  85 * Any configuration changes?
  86
  87   No. ODL Parent has no user-visible configuration.
  88
  89 Bugs Fixed
  90 ----------
  91
  92 * `66: Consolidate web services to bind to a single port <https://jira.opendaylight.org/browse/ODLPARENT-66>`_
  93 * `86: Milestone: Upgrade karaf to 4.1.2 or later <https://jira.opendaylight.org/browse/ODLPARENT-86>`_
  94 * `121: Upgrade maven-javadoc-plugin to 3.0.0 <https://jira.opendaylight.org/browse/ODLPARENT-121>`_
  95 * `132: odlparent 2.0.5 depends on servlet-api/3.0.1, whereas Karaf 4 depends on /3.1.0 <https://jira.opendaylight.org/browse/ODLPARENT-132>`_
  96 * `133: Our base distribution doesn’t include webconsole <https://jira.opendaylight.org/browse/ODLPARENT-133>`_
  97 * `135: Karaf feature:installation “deadlock” <https://jira.opendaylight.org/browse/ODLPARENT-135>`_
  98
  99 Known Issues
 100 ------------
 101
 102 * `Link to Open Bugs <https://jira.opendaylight.org/browse/ODLPARENT>`_
 103
 104 End-of-life
 105 ===========
 106
 107 * N/A.
 108
 109 Standards
 110 =========
 111
 112 * N/A.
 113
 114 Release Mechanics
 115 =================
 116
 117 * `Link to release plan <https://wiki.opendaylight.org/view/ODL_Parent:Oxygen_Release_Plan>`_