Merge "update l2switch release notes for Nitrogen"
[docs.git] / docs / getting-started-guide / project-release-notes / controller.rst
index bfafd110fa0a0392a0d0e1b7e7c83a73962a0088..d3b7bf9e7b6381352dffe4a1d37c30f16abb3de6 100644 (file)
@@ -8,13 +8,24 @@ Major Features
 odl-mdsal-broker
 ----------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blob;f=features/mdsal/features-mdsal/src/main/features/features.xml
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blob;f=features/mdsal/odl-mdsal-broker/pom.xml
 * **Feature Description:**  Core MD-SAL implementations.
 * **Top Level:** Yes
 * **User Facing:** No
 * **Experimental:** No
 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/controller/job/controller-csit-verify-3node-clustering/
 
+Documentation
+=============
+
+* **User Guide(s):**
+
+  * :ref:`User Guide <controller-user-guide>`
+
+* **Developer Guide(s):**
+
+  * :ref:`controller-dev-guide`
+
 Security Considerations
 =======================
 
@@ -37,10 +48,24 @@ Migration
 
 * Is is possible migrate from the previous release? If so, how?
 
-  * There are no issues with migration from Boron to Carbon.
+  Yes, no specific steps needed unless prior updates to config subsystem modules
+  were made via the controller-config yang-ext mount in which case the
+  etc/opendaylight/current/controller.currentconfig.xml file must be manually
+  edited to remove the following elements corresponding to config yang modules
+  that were removed:
 
-Compatiblity
-------------
+    * Remove the <data-broker> element from the <module> element with
+      <name> binding-broker-impl
+    * Remove the <module> element with <name> inmemory-binding-data-broker
+    * Remove the <service> element with <name> binding-data-broker
+    * Remove <capability>urn:opendaylight:params:xml:ns:yang:controller:threadpool?module=threadpool&amp;revision=2013-04-09</capability> from <required-capabilities>
+
+  Since the config subsystem is deprecated, it is recommended to migrate any custom
+  configuration additions and/or changes contained in controller.currentconfig.xml
+  and remove the file.
+
+Compatibility
+-------------
 
 * Is this release compatible with the previous release?
 
@@ -52,8 +77,7 @@ Compatiblity
 
 * Any configuration changes?
 
-  * Preview for Distributed Datastore Tell-Based protocol. This is enabled using etc/org.opendaylight.controller.cluster.datastore.cfg's
-    use-tell-based-protocol knob and should eliminate most sources of AskTimeouts.
+  * No
 
 Bugs Fixed
 ----------
@@ -77,26 +101,23 @@ End-of-life
 * List of features/APIs which are EOLed, deprecated, and/or removed in this
   release
 
-  * The XSQL component packaged in odl-mdsal-xsql has been deprecated and will be removed in
-    the next release.
-
-  * The following API elements are deprecated, pending future removal:
-
-    * org.opendaylight.controller.md.sal.binding.api.ClusteredDataChangeListener
-    * org.opendaylight.controller.md.sal.binding.api.DataChangeListener
-    * org.opendaylight.controller.sal.binding.api.AbstractBindingAwareConsumer
-    * org.opendaylight.controller.sal.binding.api.AbstractBindingAwareProvider
-    * org.opendaylight.controller.sal.binding.api.data.DataBrokerService
-    * org.opendaylight.controller.sal.binding.api.data.DataChangeListener
-    * org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction
-    * org.opendaylight.controller.sal.binding.api.data.DataProviderService
-    * org.opendaylight.controller.sal.binding.api.data.SynchronizedTransaction
-    * org.opendaylight.controller.sal.binding.api.NotificationListener
-    * org.opendaylight.controller.sal.binding.api.NotificationProviderService
-    * org.opendaylight.controller.sal.binding.api.NotificationService
-    * org.opendaylight.controller.sal.common.util.RpcErrors.java
-    * org.opendaylight.controller.sal.common.util.Rpcs.java
-    * org.opendaylight.controller.sal.core.api.model.SchemaService
+  * The XSQL component packaged in odl-mdsal-xsql has been removed.
+
+  * The DataProviderService and DataBrokerService APIs and the corresponding
+    implementations that were previously deprecated after the Hydrogen release
+    have been removed.
+
+  * The following config subsystem yang modules have been removed:
+
+    * threadpool
+    * threadpool-impl-fixed
+    * threadpool-impl-flexible
+    * threadpool-impl-scheduled
+    * threadpool-impl
+
+  * The config subsystem is officially deprecated in this release with removal
+    planned in 2 releases (Flourine). All projects still using the config subsystem
+    must be converted to use Blueprint.
 
 Standards
 =========