docs/release-notes/projects/openflowplugin.rst

   1 ======================
   2 OpenFlowPlugin Project
   3 ======================
   4
   5 Major Features
   6 ==============
   7
   8 odl-openflowjava-protocol
   9 -------------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=openflowjava/features-openflowjava-aggregator/odl-openflowjava-protocol/pom.xml
  12 * **Feature Description:** OpenFlow protocol implementation
  13 * **Top Level:** Yes
  14 * **User Facing:** No
  15 * **Experimental:** No
  16 * **CSIT Test:**
  17
  18   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
  19
  20 odl-openflowplugin-app-config-pusher
  21 ------------------------------------
  22
  23 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-config-pusher/pom.xml
  24 * **Feature Description:** Pushes node configuration changes to OpenFlow device
  25 * **Top Level:** Yes
  26 * **User Facing:** No
  27 * **Experimental:** No
  28 * **CSIT Test:**
  29
  30   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
  31
  32 odl-openflowplugin-app-forwardingrules-manager
  33 ----------------------------------------------
  34
  35 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-forwardingrules-manager/pom.xml
  36 * **Feature Description:** Sends changes in config datastore to OpenFlow device incrementally. forwardingrules-manager can be replaced with forwardingrules-sync and vice versa.
  37 * **Top Level:** Yes
  38 * **User Facing:** No
  39 * **Experimental:** No
  40 * **CSIT Test:**
  41
  42   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
  43
  44 odl-openflowplugin-app-forwardingrules-sync
  45 -------------------------------------------
  46
  47 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-forwardingrules-sync/pom.xml
  48 * **Feature Description:** Sends changes in config datastore to OpenFlow devices taking previous state in account and doing diffs between previous and new state. forwardingrules-sync can be replaced with forwardingrules-manager and vice versa.
  49 * **Top Level:** Yes
  50 * **User Facing:** No
  51 * **Experimental:** Yes
  52 * **CSIT Test:**
  53
  54   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/job/openflowplugin-csit-1node-flow-services-all-oxygen/
  55
  56 odl-openflowplugin-app-table-miss-enforcer
  57 ------------------------------------------
  58
  59 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-table-miss-enforcer/pom.xml
  60 * **Feature Description:** Sends table miss flows to OpenFlow device when it connects
  61 * **Top Level:** Yes
  62 * **User Facing:** No
  63 * **Experimental:** No
  64 * **CSIT Test:**
  65
  66   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
  67
  68 odl-openflowplugin-app-topology
  69 -------------------------------
  70
  71 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-app-topology/pom.xml
  72 * **Feature Description:** Discovers topology of connected OpenFlow devices
  73 * **Top Level:** Yes
  74 * **User Facing:** No
  75 * **Experimental:** No
  76 * **CSIT Test:**
  77
  78   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
  79
  80 odl-openflowplugin-nxm-extensions
  81 ---------------------------------
  82
  83 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=extension/features-extension-aggregator/odl-openflowplugin-nxm-extensions/pom.xml
  84 * **Feature Description:** Support for OpenFlow Nicira Extensions
  85 * **Top Level:** Yes
  86 * **User Facing:** Yes
  87 * **Experimental:** No
  88 * **CSIT Test:**
  89
  90   * https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-1node-openstack-pike-gate-stateful-snat-conntrack-oxygen/
  91
  92
  93 odl-openflowplugin-onf-extensions
  94 ---------------------------------
  95
  96 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=extension/features-extension-aggregator/odl-openflowplugin-onf-extensions/pom.xml
  97 * **Feature Description:** Support for Open Networking Foundation Extensions
  98 * **Top Level:** Yes
  99 * **User Facing:** Yes
 100 * **Experimental:** Yes
 101 * **CSIT Test:** No
 102
 103 odl-openflowplugin-flow-services
 104 --------------------------------
 105
 106 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-flow-services/pom.xml
 107 * **Feature Description:** Wrapper feature for standard applications
 108 * **Top Level:** Yes
 109 * **User Facing:** Yes
 110 * **Experimental:** No
 111 * **CSIT Test:**
 112
 113   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
 114
 115 odl-openflowplugin-flow-services-rest
 116 -------------------------------------
 117
 118 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-flow-services-rest/pom.xml
 119 * **Feature Description:** Wrapper + REST interface
 120 * **Top Level:** Yes
 121 * **User Facing:** Yes
 122 * **Experimental:** No
 123 * **CSIT Test:**
 124
 125   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
 126
 127 odl-openflowplugin-flow-services-ui
 128 -----------------------------------
 129
 130 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-flow-services-ui/pom.xml
 131 * **Feature Description:** Wrapper + REST interface + UI
 132 * **Top Level:** Yes
 133 * **User Facing:** Yes
 134 * **Experimental:** No
 135 * **CSIT Test:**
 136
 137   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
 138
 139 odl-openflowplugin-nsf-model
 140 ----------------------------
 141
 142 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-nsf-model/pom.xml
 143 * **Feature Description:** OpenFlowPlugin YANG models
 144 * **Top Level:** Yes
 145 * **User Facing:** No
 146 * **Experimental:** No
 147 * **CSIT Test:**
 148
 149   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
 150
 151 odl-openflowplugin-southbound
 152 -----------------------------
 153
 154 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=openflowplugin.git;a=blob;f=features-aggregator/odl-openflowplugin-southbound/pom.xml
 155 * **Feature Description:** Southbound API implementation
 156 * **Top Level:** Yes
 157 * **User Facing:** No
 158 * **Experimental:** No
 159 * **CSIT Test:**
 160
 161   * https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/
 162
 163 Documentation
 164 =============
 165
 166 * **User Guide(s):**
 167
 168   * :doc:`../../user-guide/openflow-plugin-project-user-guide`
 169
 170 * **Developer Guide(s):**
 171
 172   * :doc:`../../developer-guide/openflow-plugin-project-developer-guide`
 173
 174 Security Considerations
 175 =======================
 176
 177 * Do you have any external interfaces other than RESTCONF? Yes, OpenFlow devices
 178 * Other security issues?
 179
 180   * `Insecure OpenFlowPlugin <--> OpenFlow device connections <https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:_TLS_Support>`_
 181   * Topology spoofing: non authenticated LLDP packets to detect links between switches which makes it vulnerable to a number of attacks, one of which is topology spoofing  The problem is that all controllers we have tested set chassisSubtype value to the MAC address of the local port of the switch, which makes it easy for an adversary to spoof that switch since controllers use that MAC address as a unique identifier of the switch. By intercepting clear LLDP packets containing MAC addresses, a malicious switch can spoof other switches to falsify the controller’s topology graph.
 182   * DoS: an adversary switch could generate LLDP flood resulting in bringing down the openflow network
 183   * `DoS attack when the switch rejects to receive packets from the controller <https://wiki.opendaylight.org/view/Security_Advisories#.5BModerate.5D_CVE-2017-1000357_Denial_of_Service_attack_when_the_switch_rejects_to_receive_packets_from_the_controller>`_
 184
 185
 186 Quality Assurance
 187 =================
 188
 189 * `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.openflowplugin%3Aopenflowplugin-aggregator>`_ (73.8)
 190 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/openflowplugin-oxygen/>`_
 191
 192 Migration
 193 ---------
 194
 195 * Is it possible to migrate from the previous release? If so, how?
 196
 197   Yes, API's from Nitrogen release are supported in Oxygen release.
 198
 199 Compatibility
 200 -------------
 201
 202 * Is this release compatible with the previous release? Yes
 203
 204 Bugs Fixed
 205 ----------
 206
 207 * List of bugs fixed since the previous release
 208
 209   https://jira.opendaylight.org/browse/OPNFLWPLUG-974?jql=project%20%3D%20OPNFLWPLUG%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Resolved%2C%20Verified)%20AND%20fixVersion%20in%20(Oxygen%2C%20Nitrogen%2C%20Nitrogen-SR1)%20ORDER%20BY%20created%20DESC
 210
 211 Known Issues
 212 ------------
 213
 214 * List key known issues with workarounds: None
 215 * `Link to Open Bugs <https://jira.opendaylight.org/browse/OPNFLWPLUG-987?jql=project%20%3D%20OPNFLWPLUG%20AND%20issuetype%20%3D%20Bug%20AND%20status%20in%20(Open%2C%20%22In%20Progress%22%2C%20Confirmed)%20ORDER%20BY%20created%20DESC>`_
 216
 217 End-of-life
 218 ===========
 219
 220 * List of features/APIs which are EOLed, deprecated, and/or removed in this release: None
 221
 222 Standards
 223 =========
 224
 225 OpenFlow versions:
 226
 227 * `OpenFlow1.3.2 <https://www.openflow.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.3.2.pdf>`_
 228 * `OpenFlow1.0.0 <https://www.openflow.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-spec-v1.0.0.pdf>`_
 229
 230 Release Mechanics
 231 =================
 232
 233 * `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:Oxygen_Release_Plan>`_