d3fe0fbdc69de485224b550027dc480e2ed3d946
[docs.git] / docs / getting-started-guide / project-release-notes / mdsal.rst
1 ============
2 MD-SAL
3 ============
4
5 Major Features
6 ==============
7
8 odl-mdsal-binding
9 -----------------
10
11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;hb=refs/heads/stable/carbon
12 * **Feature Description:** MDSAL Binding layer, representing mapping of YANG modeled data to respective Java Objects
13 * **Top Level:** Yes
14 * **User Facing:** No
15 * **Experimental:** No
16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-carbon/
17
18 odl-mdsal-binding2
19 ------------------
20 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=mdsal.git;a=blob;f=common/features/features-mdsal/src/main/features/features.xml;hb=refs/heads/stable/carbon
21 * **Feature Description:** MDSAL Binding v2 layer, representing mapping of YANG modeled data to respective Java Objects
22 * **Top Level:** Yes
23 * **User Facing:** No
24 * **Experimental:** Yes
25
26 Documentation
27 =============
28
29 * **Developer Guide(s):**
30
31   * :ref:`MDSAL Developer guide <mdsal_dev_guide>`
32
33   * `MDSAL Binding v2 guide <https://github.com/opendaylight/mdsal/blob/stable/carbon/docs/src/main/asciidoc/developer/analysis/binding-v2.adoc>`_
34
35 Security Considerations
36 =======================
37
38 * MDSAL libraries are designed to be embedded and not to be a stand-alone application so security concerns need to be addressed by the application using this library.
39
40 Quality Assurance
41 =================
42
43 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=55311>`_ (70.6% line coverage)
44 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/mdsal/job/mdsal-csit-1node-periodic-bindingv1-only-carbon/>`_
45
46 Migration
47 ---------
48
49 * no additional steps needed for migration
50
51 Compatibility
52 -------------
53
54 * Release is compatible with the previous one
55 * No configuration changes
56
57 Bugs Fixed
58 ----------
59
60 * `Link of fixed bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&j_top=AND_G&list_id=78839&o1=substring&product=mdsal&query_format=advanced&resolution=FIXED&resolution=INVALID&resolution=WONTFIX&resolution=DUPLICATE&resolution=WORKSFORME&v1=Carbon>`_
61
62 Known Issues
63 ------------
64
65 * List key known issues with workarounds
66 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&chfield=target_milestone&chfieldto=Now&component=General&f1=cf_target_milestone&f2=cf_target_milestone&f3=cf_target_milestone&f4=cf_target_milestone&f5=cf_target_milestone&j_top=AND_G&list_id=78842&o1=substring&product=mdsal&query_format=advanced&resolution=---&v1=Carbon>`_
67
68 End-of-life
69 ===========
70
71 * List of features/APIs which are EOLed, deprecated, and/or removed in this
72   release
73
74   none
75
76 Standards
77 =========
78
79 * relies on processing according to `RFC 6020 <https://tools.ietf.org/html/rfc6020>`_ and `RFC 7950 <https://tools.ietf.org/html/rfc7950>`_.
80
81 Release Mechanics
82 =================
83
84 * `Link to release plan <https://wiki.opendaylight.org/view/MD-SAL:Carbon:Release_Plan>`_