Add MD-SAL release notes
[docs.git] / docs / release-notes / projects / mdsal.rst
1 ===============================================
2 Model-Driven Service Abstraction Layer (MD-SAL)
3 ===============================================
4
5 Overview
6 ========
7
8 MD-SAL provides infrastructure for binding YANG models to Java object model and infrastructure
9 for providing YANG-defined interaction patterns:
10 * Reactive datastore update
11 * RPC and Action invocation
12 * Notification sourcing and delivery
13
14 Behavior/Feature Changes
15 ========================
16 Java Binding generator core has been rewritten from scratch. This has been coming for a long time
17 and was finally forced by YANG Tools performance requirements. The implementation now performs
18 a better-informed analysis of the required mapping, eliminating a large class of issues and allows
19 us to solve some long-standing failures with strange models encountered in the wild.
20
21 Java Bindings generated by this release break compatibility by not generating legacy bridge methods
22 generated by previous releases shipping in Aluminium and Magnesium.
23
24 New Features
25 ============
26 Netty Replication feature has been promoted to full production status. It is now available as
27 ``odl-mdsal-replicate-netty``.
28
29 Deprecated Features
30 ===================
31 The ability to perform atomic operations on multiple datastores is terminally deprecated and will
32 be removed in the next major release.
33
34 Removed Features
35 ===================
36 Internal APIs and implementations pertaining to ``DOMDataTreeShard``, ``DataTreeProducer`` and
37 ``DataTreeConsumer`` have been removed. Functionality offered by these is not currently covered
38 by any construct, but we expect to deliver replacements in near future.
39
40 Resolved Issues
41 ===============
42 The following table lists the issues resolved in this release.
43
44 .. jira_fixed_issues::
45    :project: MDSAL
46    :versions: 8.0.0-8.0.5
47
48 Known Issues
49 ============
50 The following table lists the known issues that exist in this release.
51
52 .. jira_known_issues::
53    :project: MDSAL
54    :versions: 8.0.0-8.0.5