docs/release-notes/projects/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/oxygen
  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-all-oxygen/
  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/oxygen
  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-all-oxygen/
  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/oxygen
  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/oxygen
  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-all-oxygen/
  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/oxygen
  54 * **Feature Description:** Restconf
  55 * **Top Level:** Yes
  56 * **User Facing:** Yes
  57 * **Experimental:** No
  58 * **CSIT Test:**  Tested by any suite 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/oxygen
  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/oxygen
  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/oxygen
  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-all-oxygen/
  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 port 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/dashboard?id=org.opendaylight.netconf%3Anetconf-parent>`_ Test coverage percent: 60.7%
 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. No additional steps required.
 134
 135 Compatibility
 136 -------------
 137
 138 * Is this release compatible with the previous release?
 139
 140   Yes
 141
 142 * Any API changes?
 143
 144   No
 145
 146 * Any configuration changes?
 147
 148   No
 149
 150 Bugs Fixed
 151 ----------
 152
 153 * List of bugs fixed since the previous release
 154
 155   https://jira.opendaylight.org/browse/NETCONF-479?jql=project%20%3D%20NETCONF%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20in%20(Oxygen%2C%20Nitrogen-SR1)%20ORDER%20BY%20created%20DESC
 156
 157 Known Issues
 158 ------------
 159
 160 * List key known issues with workarounds
 161
 162   None
 163
 164 * `Link to Open Bugs <https://jira.opendaylight.org/browse/NETCONF-528?jql=project%20%3D%20NETCONF%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Confirmed)%20ORDER%20BY%20created%20DESC>`_
 165
 166 End-of-life
 167 ===========
 168
 169 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 170   release
 171
 172   None of the features/APIs are EOLed, deprecated or removed.
 173
 174 Standards
 175 =========
 176
 177 * `RFC 6241 <https://tools.ietf.org/html/rfc6241>`_ - Network Configuration Protocol (NETCONF)
 178 * `RFC 6470 <https://tools.ietf.org/html/rfc6470>`_ - Base Notifications partly supported, netconf-config-change unsupported
 179 * `draft-ietf-yang-library-06 <https://tools.ietf.org/html/draft-ietf-netconf-yang-library-06>`_
 180 * `draft-bierman-netconf-restconf-04 <https://tools.ietf.org/html/draft-bierman-netconf-restconf-04>`_
 181 * `RFC 8040 <https://tools.ietf.org/html/rfc8040>`_ - RESTCONF protocol
 182
 183
 184 Release Mechanics
 185 =================
 186
 187 * `Link to release plan <https://wiki.opendaylight.org/view/Simultaneous_Release:Oxygen_Release_Plan>`_
 188 * Describe any major shifts in release schedule from the release plan
 189
 190   No shifts