docs/release-notes/projects/mdsal.rst

   1 ======
   2 MD-SAL
   3 ======
   4
   5 Major Features
   6 ==============
   7
   8 Oxygen release of MD-SAL has focused on incremental improvements in existing
   9 functionality. Major newsworthy items are:
  10 * Improved length constraint checks in generated code
  11 * Reworked Cluster Singleton service
  12 * DOMSchemaService has received fixes which were delivered only to controller
  13 * Binding V2 implementation has gotten faster, smaller and more feature-complete
  14 * DOMReadWriteTransaction has been introduced to allow migration from controller
  15 * Binding data tree changes adaptation has been corrected
  16 * Potential livelock in DOMForwardedWriteTransaction has been fixed
  17 * Runtime code footprint of Binding V1 has been reduced
  18
  19 odl-mdsal-binding
  20 -----------------
  21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/odl-mdsal-binding/pom.xml;hb=refs/heads/stable/oxygen
  22 * **Feature Description:** MDSAL Binding layer, representing mapping of YANG
  23   modeled data to respective Java Objects
  24 * **Top Level:** Yes
  25 * **User Facing:** No
  26 * **Experimental:** No
  27 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-oxygen/
  28
  29 odl-mdsal-binding2
  30 ------------------
  31 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/odl-mdsal-binding2/pom.xml;hb=refs/heads/stable/oxygen
  32 * **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG
  33   modeled data to respective Java Objects
  34 * **Top Level:** Yes
  35 * **User Facing:** No
  36 * **Experimental:** Yes
  37
  38 odl-mdsal-dom
  39 -------------
  40 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/odl-mdsal-dom/pom.xml;hb=refs/heads/stable/oxygen
  41 * **Feature Description:** MDSAL DOM layer
  42 * **Top Level:** Yes
  43 * **User Facing:** No
  44 * **Experimental:** No
  45
  46 Documentation
  47 =============
  48
  49 * **Developer Guide(s):**
  50
  51   * :ref:`MDSAL Developer guide <mdsal_dev_guide>`
  52
  53   * `MDSAL Binding v2 guide <https://github.com/opendaylight/mdsal/blob/stable/nitrogen/docs/src/main/asciidoc/developer/analysis/binding-v2.adoc>`_
  54
  55 Security Considerations
  56 =======================
  57
  58 * MDSAL libraries are designed to be embedded and not to be a stand-alone
  59   application so security concerns need to be addressed by the application
  60   using this library.
  61
  62 Quality Assurance
  63 =================
  64
  65 * `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.mdsal%3Amdsal-agreggator>`_
  66   (63.2% line, 53% branch, 60.4% overall coverage)
  67 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-oxygen/>`_
  68
  69 Migration
  70 ---------
  71
  72 * no additional steps needed for migration
  73
  74 Compatibility
  75 -------------
  76
  77 * Release is compatible with the previous one
  78 * No configuration changes
  79
  80 Bugs Fixed
  81 ----------
  82
  83 * `Link of fixed bugs <https://jira.opendaylight.org/issues/?jql=project%20%3D%20MDSAL%20and%20resolution%20%3D%20Done%20and%20fixVersion%20%3D%20%22Oxygen%22%20>`_
  84
  85 Known Issues
  86 ------------
  87
  88 * None
  89
  90 End-of-life
  91 ===========
  92
  93 * Users are advised that any API element marked as @deprecated may be removed
  94   in the next release. Users are advised to follow JavaDoc pointers and migrate
  95   to replacement APIs.
  96
  97 Standards
  98 =========
  99
 100 * relies on processing according to
 101   `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and
 102   `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
 103
 104 Release Mechanics
 105 =================
 106
 107 * `Link to release plan <https://wiki.opendaylight.org/view/MD-SAL:Oxygen:Release_Plan>`_