docs/getting-started-guide/project-release-notes/netconf.rst

   1 =======
   2 NETCONF
   3 =======
   4
   5 Major Features
   6 ==============
   7
   8 For each top-level feature, identify the name, url, description, etc.
   9 User-facing features are used directly by end users.
  10
  11 odl-netconf-topology
  12 --------------------
  13
  14 * **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
  15 * **Feature Description:**  NETCONF southbound plugin single-node, configuration through mdsal
  16 * **Top Level:** Yes
  17 * **User Facing:** Yes
  18 * **Experimental:** No
  19 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
  20
  21 odl-netconf-clustered-topology
  22 ------------------------------
  23
  24 * **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
  25 * **Feature Description:**  NETCONF southbound plugin clustered, configuration through mdsal
  26 * **Top Level:** Yes
  27 * **User Facing:** Yes
  28 * **Experimental:** Yes
  29 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-3node-clustering-only-carbon/
  30
  31 odl-netconf-console
  32 -------------------
  33
  34 * **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
  35 * **Feature Description:**  NETCONF southbound configuration with karaf cli
  36 * **Top Level:** Yes
  37 * **User Facing:** Yes
  38 * **Experimental:** Yes
  39
  40 odl-netconf-mdsal
  41 -----------------
  42
  43 * **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
  44 * **Feature Description:** NETCONF server for mdsal
  45 * **Top Level:** Yes
  46 * **User Facing:** Yes
  47 * **Experimental:** No
  48 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
  49
  50 odl-restconf
  51 ------------
  52
  53 * **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
  54 * **Feature Description:** Restconf
  55 * **Top Level:** Yes
  56 * **User Facing:** Yes
  57 * **Experimental:** No
  58 * **CSIT Test:**  Tested by any suit that uses Restconf
  59
  60 odl-mdsal-apidocs
  61 -----------------
  62
  63 * **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
  64 * **Feature Description:** MDSal - apidocs
  65 * **Top Level:** Yes
  66 * **User Facing:** Yes
  67 * **Experimental:** No
  68
  69 odl-yanglib
  70 -----------
  71
  72 * **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
  73 * **Feature Description:** Yanglib server
  74 * **Top Level:** Yes
  75 * **User Facing:** Yes
  76 * **Experimental:** No
  77
  78 odl-netconf-callhome-ssh
  79 ------------------------
  80
  81 * **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
  82 * **Feature Description:** Netconf call home
  83 * **Top Level:** Yes
  84 * **User Facing:** Yes
  85 * **Experimental:** No
  86 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-callhome-only-carbon/
  87
  88
  89 Documentation
  90 =============
  91
  92 Please provide the URL to each document at docs.opendaylight.org. If the
  93 document is under review, provide a link to the change in Gerrit.
  94
  95 * **User Guide(s):**
  96
  97   * :ref:`netconf-user-guide`
  98
  99 * **Developer Guide(s):**
 100
 101   * :ref:`netconf-dev-guide`
 102
 103 Security Considerations
 104 =======================
 105
 106 * Do you have any external interfaces other than RESTCONF?
 107
 108   Yes, we have md-sal and css netconf servers. Also server for netconf call-home.
 109
 110   * If so, how are they secure?
 111
 112     NETCONF over SSH
 113
 114   * What port numbers do they use?
 115
 116     Please see https://wiki.opendaylight.org/view/Ports. Netconf call-home uses TCP 6666
 117
 118 * Other security issues?
 119
 120   None that we are aware of
 121
 122 Quality Assurance
 123 =================
 124
 125 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=54548>`_ Test coverage percent: 63.3%
 126 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netconf/>`_
 127
 128 Migration
 129 ---------
 130
 131 * Is it possible to migrate from the previous release? If so, how?
 132
 133   Yes.
 134
 135   Several config subsystem yang modules were removed therefore if prior updates to
 136   config subsystem modules were made via the controller-config loopback mountpoint
 137   then the etc/opendaylight/current/controller.currentconfig.xml file must be manually
 138   edited to remove elements corresponding to the removed config yang modules.
 139   These include the elements from the following XML files under
 140   etc/opendaylight/karaf:
 141
 142     * 10-rest-connector.xml
 143     * 10-restconf-service.xml
 144
 145   The mechanism of spawning netconf connectors via the controller-config loopback
 146   mountpoint was removed so any previously configured connectors must be migrated to the
 147   config datastore and the elements removed from the controller.currentconfig.xml file.
 148
 149   The netconf yanglib config subsystem module was removed so any configuration change
 150   that was made via the controller-config loopback mountpoint must be migrated to the
 151   config datastore (see the Compatibility section) and must also be removed from the
 152   controller.currentconfig.xml file.
 153
 154   Since the config subsystem is deprecated, it is recommended to migrate any custom
 155   configuration additions and/or changes contained in controller.currentconfig.xml
 156   and remove the file.
 157
 158 Compatibility
 159 -------------
 160
 161 * Is this release compatible with the previous release?
 162
 163   Yes
 164
 165 * Any API changes?
 166
 167   No
 168
 169 * Any configuration changes?
 170
 171   * The restconf northbound feature is now started via blueprint instead of the config
 172     subsystem. The corresponding config yang file, opendaylight-rest-connector.yang,
 173     and the 10-rest-connector.xml file installed under etc/opendaylight/karaf have been
 174     removed. The restconf configuration attributes (specifically websocket-port) are
 175     now specified via the etc/org.opendaylight.restconf.cfg file.
 176
 177   * The JSONRestconfService API is no longer advertised via the config subsystem and
 178     the corresponding config yang file, sal-restconf-service.yang, and the
 179     10-restconf-service.xml file installed under etc/opendaylight/karaf have been
 180     removed. The JSONRestconfService must now be obtained directly from the OSGi
 181     service registry (preferably via blueprint).
 182 .
 183   * The netconf yanglib feature is now now started via blueprint instead of the config
 184     subsystem and is configured using the yanglib:yanglib-config container defined in
 185     yanglib.yang via the config datastore.
 186
 187 Bugs Fixed
 188 ----------
 189
 190 * List of bugs fixed since the previous release
 191
 192   https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&chfield=resolution&chfieldfrom=2016-09-08&chfieldto=Now&chfieldvalue=FIXED&list_id=78801&product=netconf&query_format=advanced&resolution=FIXED
 193
 194 Known Issues
 195 ------------
 196
 197 * List key known issues with workarounds
 198
 199   None
 200
 201 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=CONFIRMED&list_id=78793&product=netconf&query_format=advanced&resolution=--->`_
 202
 203 End-of-life
 204 ===========
 205
 206 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 207   release
 208
 209   The mechanism of spawning netconf connectors via the config subsystem's
 210   controller-config loopback mountpoint was deprecated in the previous release and
 211   has been removed.
 212
 213 Standards
 214 =========
 215
 216 * `RFC 6241 <https://tools.ietf.org/html/rfc6241>`_ - Network Configuration Protocol (NETCONF)
 217 * `RFC 6470 <https://tools.ietf.org/html/rfc6470>`_ - Base Notifications partly supported, netconf-config-change unsupported
 218 * `draft-ietf-yang-library-06 <https://tools.ietf.org/html/draft-ietf-netconf-yang-library-06>`_
 219 * `draft-bierman-netconf-restconf-04 <https://tools.ietf.org/html/draft-bierman-netconf-restconf-04>`_
 220 * `RFC 8040 <https://tools.ietf.org/html/rfc8040>`_ - RESTCONF protocol
 221
 222
 223 Release Mechanics
 224 =================
 225
 226 * `Link to release plan <https://wiki.opendaylight.org/view/NETCONF:Carbon:Release_Plan>`_
 227 * Describe any major shifts in release schedule from the release plan
 228
 229   No shifts