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/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
  15 * **Feature Description:**  NETCONF southbound plugin, 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/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
  25 * **Feature Description:**  NETCONF southbound plugin, 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/features-netconf-connector/src/main/features/features.xml;h=a3d60f24cad204862c6b392b391048a0147e3933;hb=refs/heads/stable/carbon
  35 * **Feature Description:**  NETCONF southbound configuration with karaf cli
  36 * **Top Level:** Yes
  37 * **User Facing:** Yes
  38 * **Experimental:** Yes
  39
  40 odl-netconf-connector-all
  41 -------------------------
  42
  43 * **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
  44 * **Feature Description:** NETCONF southbound plugin, configuration with configub subsystem
  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-netconf-mdsal
  51 -----------------
  52
  53 * **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
  54 * **Feature Description:** NETCONF server for mdsal
  55 * **Top Level:** Yes
  56 * **User Facing:** Yes
  57 * **Experimental:** No
  58 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-userfeatures-only-carbon/
  59
  60 odl-restconf
  61 ------------
  62
  63 * **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
  64 * **Feature Description:** Restconf
  65 * **Top Level:** Yes
  66 * **User Facing:** Yes
  67 * **Experimental:** No
  68 * **CSIT Test:**  Tested by any suit that uses Restconf
  69
  70 odl-mdsal-apidocs
  71 -----------------
  72
  73 * **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
  74 * **Feature Description:** MDSal - apidocs
  75 * **Top Level:** Yes
  76 * **User Facing:** Yes
  77 * **Experimental:** No
  78
  79 odl-yanglib
  80 -----------
  81
  82 * **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
  83 * **Feature Description:** Yanglib server
  84 * **Top Level:** Yes
  85 * **User Facing:** Yes
  86 * **Experimental:** No
  87
  88 odl-netconf-callhome-ssh
  89 ------------------------
  90
  91 * **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
  92 * **Feature Description:** Netconf call home
  93 * **Top Level:** Yes
  94 * **User Facing:** Yes
  95 * **Experimental:** No
  96 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/netconf/job/netconf-csit-1node-callhome-only-carbon/
  97
  98
  99 Documentation
 100 =============
 101
 102 Please provide the URL to each document at docs.opendaylight.org. If the
 103 document is under review, provide a link to the change in Gerrit.
 104
 105 * **User Guide(s):**
 106
 107   * `Netconf user guide <http://docs.opendaylight.org/en/latest/user-guide/netconf-user-guide.html>`_
 108
 109 * **Developer Guide(s):**
 110
 111   * `Netconf developer guide <http://docs.opendaylight.org/en/latest/developer-guide/netconf-developer-guide.html>`_
 112
 113 Security Considerations
 114 =======================
 115
 116 * Do you have any external interfaces other than RESTCONF?
 117
 118   Yes, we have md-sal and css netconf servers. Also server for netconf call-home.
 119
 120   * If so, how are they secure?
 121
 122     NETCONF over SSH
 123
 124   * What port numbers do they use?
 125
 126     Please see https://wiki.opendaylight.org/view/Ports. Netconf call-home uses TCP 6666
 127
 128 * Other security issues?
 129
 130   None that we are aware of
 131
 132 Quality Assurance
 133 =================
 134
 135 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=54548>`_ Test coverage percent: 63.3%
 136 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/netconf/>`_
 137
 138 Migration
 139 ---------
 140
 141 * Is is possible migrate from the previous release? If so, how?
 142
 143   Yes, no specific steps needed apart from migrating netconf's topology configuration from DS.
 144
 145 Compatiblity
 146 ------------
 147
 148 * Is this release compatible with the previous release?
 149
 150   Yes
 151
 152 * Any API changes?
 153
 154   No
 155
 156 * Any configuraiton changes?
 157
 158   md-sal netconf northbound is started via blueprint instead of config subsystem.
 159
 160 Bugs Fixed
 161 ----------
 162
 163 * List of bugs fixed since the previous release
 164
 165   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
 166
 167 Known Issues
 168 ------------
 169
 170 * List key known issues with workarounds
 171
 172   None
 173
 174 * `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=--->`_
 175
 176 End-of-life
 177 ===========
 178
 179 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 180   release
 181
 182   NETCONF southbound plugin, configuration with configub subsystem is deprecated
 183
 184 Standards
 185 =========
 186
 187 * `RFC 6241 <https://tools.ietf.org/html/rfc6241>`_ - Network Configuration Protocol (NETCONF)
 188 * `RFC 6470 <https://tools.ietf.org/html/rfc6470>`_ - Base Notifications partly supported, netconf-config-change unsupported
 189 * `draft-ietf-yang-library-06 <https://tools.ietf.org/html/draft-ietf-netconf-yang-library-06>`_
 190 * `draft-bierman-netconf-restconf-04 <https://tools.ietf.org/html/draft-bierman-netconf-restconf-04>`_
 191 * `RFC 8040 <https://tools.ietf.org/html/rfc8040>`_ - RESTCONF protocol
 192
 193
 194 Release Mechanics
 195 =================
 196
 197 * `Link to release plan <https://wiki.opendaylight.org/view/NETCONF:Carbon:Release_Plan>`_
 198 * Describe any major shifts in release schedule from the release plan
 199
 200   No shifts