Code Review / docs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Merge "update Neutron Northbound rel.notes"
[docs.git] / docs / getting-started-guide / project-release-notes / netconf.rst
diff --git a/docs/getting-started-guide/project-release-notes/netconf.rst b/docs/getting-started-guide/project-release-notes/netconf.rst
index 0a624dce692656045f3afe353e2e579023fb26df..1332cb3dfdac565242c222c59c5f2a7711a68a76 100644 (file)
--- a/docs/getting-started-guide/project-release-notes/netconf.rst
+++ b/docs/getting-started-guide/project-release-notes/netconf.rst
@@ -1,6 +1,6 @@
-============
+=======
 NETCONF
-============
+=======
 
 Major Features
 ==============
@@ -11,8 +11,8 @@ User-facing features are used directly by end users.
 odl-netconf-topology
 --------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
-* **Feature Description:**  NETCONF southbound plugin, configuration through mdsal
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-topology/pom.xml;hb=refs/heads/stable/nitrogen
+* **Feature Description:**  NETCONF southbound plugin single-node, configuration through mdsal
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** No
@@ -21,8 +21,8 @@ odl-netconf-topology
 odl-netconf-clustered-topology
 ------------------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
-* **Feature Description:**  NETCONF southbound plugin, configuration through mdsal
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-clustered-topology/pom.xml;hb=refs/heads/stable/nitrogen
+* **Feature Description:**  NETCONF southbound plugin clustered, configuration through mdsal
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** Yes
@@ -31,26 +31,16 @@ odl-netconf-clustered-topology
 odl-netconf-console
 -------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-console/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:**  NETCONF southbound configuration with karaf cli
 * **Top Level:** Yes
 * **User Facing:** Yes
 * **Experimental:** Yes
 
-odl-netconf-connector-all
--------------------------
-
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
-* **Feature Description:** NETCONF southbound plugin, configuration with configub subsystem
-* **Top Level:** Yes
-* **User Facing:** Yes
-* **Experimental:** No
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
-
 odl-netconf-mdsal
 -----------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf/features-netconf/src/main/features/features.xml;h=29e9400108a8790ac7786fbfc6e2d3bbd1fa2ec0;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf/odl-netconf-mdsal/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:** NETCONF server for mdsal
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -60,7 +50,7 @@ odl-netconf-mdsal
 odl-restconf
 ------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;h=77c9687fba7862f018b8cea43830cc1b9688c8e5;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/odl-restconf/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:** Restconf
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -70,7 +60,7 @@ odl-restconf
 odl-mdsal-apidocs
 -----------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/features-restconf/src/main/features/features.xml;h=77c9687fba7862f018b8cea43830cc1b9688c8e5;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/odl-mdsal-apidocs/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:** MDSal - apidocs
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -79,7 +69,7 @@ odl-mdsal-apidocs
 odl-yanglib
 -----------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/yanglib/features-yanglib/src/main/features/features.xml;h=81ccb4954eb32394a9d4ef1986ad0e4bb67b9e1f;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/yanglib/odl-yanglib/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:** Yanglib server
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -88,7 +78,7 @@ odl-yanglib
 odl-netconf-callhome-ssh
 ------------------------
 
-* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
+* **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/netconf-connector/odl-netconf-callhome-ssh/pom.xml;hb=refs/heads/stable/nitrogen
 * **Feature Description:** Netconf call home
 * **Top Level:** Yes
 * **User Facing:** Yes
@@ -104,11 +94,11 @@ document is under review, provide a link to the change in Gerrit.
 
 * **User Guide(s):**
 
-  * `Netconf user guide <http://docs.opendaylight.org/en/latest/user-guide/netconf-user-guide.html>`_
+  * :ref:`netconf-user-guide`
 
 * **Developer Guide(s):**
 
-  * `Netconf developer guide <http://docs.opendaylight.org/en/latest/developer-guide/netconf-developer-guide.html>`_
+  * :ref:`netconf-dev-guide`
 
 Security Considerations
 =======================
@@ -138,12 +128,35 @@ Quality Assurance
 Migration
 ---------
 
-* Is is possible migrate from the previous release? If so, how?
+* Is it possible to migrate from the previous release? If so, how?
 
-  Yes, no specific steps needed apart from migrating netconf's topology configuration from DS.
+  Yes.
 
-Compatiblity
-------------
+  Several config subsystem yang modules were removed therefore if prior updates to
+  config subsystem modules were made via the controller-config loopback mountpoint
+  then the etc/opendaylight/current/controller.currentconfig.xml file must be manually
+  edited to remove elements corresponding to the removed config yang modules.
+  These include the elements from the following XML files under
+  etc/opendaylight/karaf:
+
+    * 10-rest-connector.xml
+    * 10-restconf-service.xml
+
+  The mechanism of spawning netconf connectors via the controller-config loopback
+  mountpoint was removed so any previously configured connectors must be migrated to the
+  config datastore and the elements removed from the controller.currentconfig.xml file.
+
+  The netconf yanglib config subsystem module was removed so any configuration change
+  that was made via the controller-config loopback mountpoint must be migrated to the
+  config datastore (see the Compatibility section) and must also be removed from the
+  controller.currentconfig.xml file.
+
+  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?
 
@@ -153,9 +166,23 @@ Compatiblity
 
   No
 
-* Any configuraiton changes?
+* Any configuration changes?
+
+  * The restconf northbound feature is now started via blueprint instead of the config
+    subsystem. The corresponding config yang file, opendaylight-rest-connector.yang,
+    and the 10-rest-connector.xml file installed under etc/opendaylight/karaf have been
+    removed. The restconf configuration attributes (specifically websocket-port) are
+    now specified via the etc/org.opendaylight.restconf.cfg file.
 
-  md-sal netconf northbound is started via blueprint instead of config subsystem.
+  * The JSONRestconfService API is no longer advertised via the config subsystem and
+    the corresponding config yang file, sal-restconf-service.yang, and the
+    10-restconf-service.xml file installed under etc/opendaylight/karaf have been
+    removed. The JSONRestconfService must now be obtained directly from the OSGi
+    service registry (preferably via blueprint).
+.
+  * The netconf yanglib feature is now now started via blueprint instead of the config
+    subsystem and is configured using the yanglib:yanglib-config container defined in
+    yanglib.yang via the config datastore.
 
 Bugs Fixed
 ----------
@@ -179,7 +206,9 @@ End-of-life
 * List of features/APIs which are EOLed, deprecated, and/or removed in this
   release
 
-  NETCONF southbound plugin, configuration with configub subsystem is deprecated
+  The mechanism of spawning netconf connectors via the config subsystem's
+  controller-config loopback mountpoint was deprecated in the previous release and
+  has been removed.
 
 Standards
 =========
OpenDaylight Documentation