Add MD-SAL release notes 30/97630/1
authorRobert Varga <robert.varga@pantheon.tech>
Sat, 25 Sep 2021 11:51:39 +0000 (13:51 +0200)
committerRobert Varga <robert.varga@pantheon.tech>
Sat, 25 Sep 2021 11:51:39 +0000 (13:51 +0200)
There was quite a bit of churn in md-sal, sum up the most visible
changes.

Change-Id: Ic0be8cb9d637e7b567e2f4b8c45f829ec5928144
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
docs/release-notes/projects/mdsal.rst [new file with mode: 0644]

diff --git a/docs/release-notes/projects/mdsal.rst b/docs/release-notes/projects/mdsal.rst
new file mode 100644 (file)
index 0000000..44474f0
--- /dev/null
@@ -0,0 +1,54 @@
+===============================================
+Model-Driven Service Abstraction Layer (MD-SAL)
+===============================================
+
+Overview
+========
+
+MD-SAL provides infrastructure for binding YANG models to Java object model and infrastructure
+for providing YANG-defined interaction patterns:
+* Reactive datastore update
+* RPC and Action invocation
+* Notification sourcing and delivery
+
+Behavior/Feature Changes
+========================
+Java Binding generator core has been rewritten from scratch. This has been coming for a long time
+and was finally forced by YANG Tools performance requirements. The implementation now performs
+a better-informed analysis of the required mapping, eliminating a large class of issues and allows
+us to solve some long-standing failures with strange models encountered in the wild.
+
+Java Bindings generated by this release break compatibility by not generating legacy bridge methods
+generated by previous releases shipping in Aluminium and Magnesium.
+
+New Features
+============
+Netty Replication feature has been promoted to full production status. It is now available as
+``odl-mdsal-replicate-netty``.
+
+Deprecated Features
+===================
+The ability to perform atomic operations on multiple datastores is terminally deprecated and will
+be removed in the next major release.
+
+Removed Features
+===================
+Internal APIs and implementations pertaining to ``DOMDataTreeShard``, ``DataTreeProducer`` and
+``DataTreeConsumer`` have been removed. Functionality offered by these is not currently covered
+by any construct, but we expect to deliver replacements in near future.
+
+Resolved Issues
+===============
+The following table lists the issues resolved in this release.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 8.0.0-8.0.5
+
+Known Issues
+============
+The following table lists the known issues that exist in this release.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 8.0.0-8.0.5