docs/release-notes/projects/sfc.rst

   1 =========================
   2 Service Function Chaining
   3 =========================
   4
   5 Major Features
   6 ==============
   7
   8 odl-sfc-netconf
   9 ---------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  12 * **Feature Description:**  Provides functionality to communicate with netconf capable Service Functions.
  13 * **Top Level:** Yes
  14 * **User Facing:** Yes
  15 * **Experimental:** Yes
  16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  17
  18
  19 odl-sfc-scf-openflow
  20 --------------------
  21
  22 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  23 * **Feature Description:**  SFC stand-alone openflow classifier.
  24 * **Top Level:** Yes
  25 * **User Facing:** Yes
  26 * **Experimental:** No
  27 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  28
  29
  30 odl-sfc-scf-vpp
  31 --------------------
  32
  33 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  34 * **Feature Description:**  SFC stand-alone vpp classifier.
  35 * **Top Level:** Yes
  36 * **User Facing:** Yes
  37 * **Experimental:** No
  38 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  39
  40
  41 odl-sfc-openflow-renderer
  42 -------------------------
  43
  44 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  45 * **Feature Description:**  Renderer functionality for OpenFlow capable switches.
  46 * **Top Level:** Yes
  47 * **User Facing:** Yes
  48 * **Experimental:** No
  49 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  50
  51
  52 odl-sfclisp
  53 -----------
  54
  55 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  56 * **Feature Description:**  Programs LISP capable switches.
  57 * **Top Level:** Yes
  58 * **User Facing:** Yes
  59 * **Experimental:** Yes
  60 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  61
  62
  63 odl-sfc-sb-rest
  64 ---------------
  65
  66 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  67 * **Feature Description:**  Implements a South Bound Rest interface to send configuration to REST-capable switches.
  68 * **Top Level:** Yes
  69 * **User Facing:** Yes
  70 * **Experimental:** Yes
  71 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  72
  73
  74 odl-sfc-ui
  75 ----------
  76
  77 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  78 * **Feature Description:**  This feature is the SFC User Interface.
  79 * **Top Level:** Yes
  80 * **User Facing:** Yes
  81 * **Experimental:** Yes
  82 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  83
  84
  85 odl-sfc-vnfm-tacker
  86 -------------------
  87
  88 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
  89 * **Feature Description:**  Tacker VNF Manager interface.
  90 * **Top Level:** Yes
  91 * **User Facing:** Yes
  92 * **Experimental:** Yes
  93 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
  94
  95
  96 odl-sfc-ios-xe-renderer
  97 -----------------------
  98
  99 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 100 * **Feature Description:**  Renderer functionality for IO XE switches that use netconf.
 101 * **Top Level:** Yes
 102 * **User Facing:** Yes
 103 * **Experimental:** Yes
 104 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 105
 106
 107 odl-sfc-vpp-renderer
 108 --------------------
 109
 110 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 111 * **Feature Description:**  Renderer functionality for fd.io VPP (Vector Packet Processor) switches that use netconf.
 112 * **Top Level:** Yes
 113 * **User Facing:** Yes
 114 * **Experimental:** Yes
 115 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 116
 117
 118 odl-sfc-pot
 119 -----------
 120
 121 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 122 * **Feature Description:**  This feature implements a Proof of Transit for the Service Functions.
 123 * **Top Level:** Yes
 124 * **User Facing:** Yes
 125 * **Experimental:** Yes
 126 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 127
 128
 129 odl-sfc-statistics
 130 ------------------
 131
 132 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 133 * **Feature Description:**  This feature implements SFC statistics gathering.
 134 * **Top Level:** Yes
 135 * **User Facing:** Yes
 136 * **Experimental:** Yes
 137 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 138
 139
 140 These features are consumed by the User facing features above
 141 =============================================================
 142
 143
 144 odl-sfc-genius
 145 --------------
 146
 147 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 148 * **Feature Description:**  This feature implements the Genius utilities created by SFC project.
 149 * **Top Level:** Yes
 150 * **User Facing:** No
 151 * **Experimental:** No
 152 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 153
 154
 155 odl-sfc-model
 156 -------------
 157
 158 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 159 * **Feature Description:**  This feature defines and implements the SFC data model as specified here https://datatracker.ietf.org/doc/rfc7665/
 160 * **Top Level:** Yes
 161 * **User Facing:** No
 162 * **Experimental:** No
 163 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 164
 165
 166 odl-sfc-pot-netconf-renderer
 167 ----------------------------
 168
 169 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 170 * **Feature Description:**  This feature implements the Netconf rendering for the Proof of Transit for the Service Functions.
 171 * **Top Level:** Yes
 172 * **User Facing:** No
 173 * **Experimental:** No
 174 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 175
 176
 177 odl-sfc-provider
 178 ----------------
 179
 180 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 181 * **Feature Description:**  This feature provides an easy-to-use interface to the sfc-model.
 182 * **Top Level:** Yes
 183 * **User Facing:** No
 184 * **Experimental:** No
 185 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 186
 187
 188 odl-sfc-provider-rest
 189 ---------------------
 190
 191 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 192 * **Feature Description:**  This feature provides no functionality, and just installs the necessary features for SFC restconf.
 193 * **Top Level:** Yes
 194 * **User Facing:** No
 195 * **Experimental:** No
 196 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 197
 198
 199 odl-sfc-ovs
 200 -----------
 201
 202 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 203 * **Feature Description:**  This feature provides functionality for SFC to communicate with OVSDB for SFF configuration.
 204 * **Top Level:** Yes
 205 * **User Facing:** No
 206 * **Experimental:** No
 207 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 208
 209
 210 odl-sfc-test-consumer
 211 ---------------------
 212
 213 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 214 * **Feature Description:**  This feature is used for testing only.
 215 * **Top Level:** Yes
 216 * **User Facing:** No
 217 * **Experimental:** Yes
 218 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 219
 220
 221 Documentation
 222 =============
 223
 224 * **User Guide(s):**
 225
 226   * :ref:`sfc-user-guide`
 227
 228 * **Developer Guide(s):**
 229
 230   * :ref:`sfc-dev-guide`
 231
 232
 233 Security Considerations
 234 =======================
 235
 236 None.
 237
 238
 239 Quality Assurance
 240 =================
 241
 242 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/sfc/>`_
 243 * All modules have been unit tested. Integration tests have been performed for
 244   all major features. System tests have been performed on most major features.
 245
 246 Migration
 247 ---------
 248
 249 Nothing special is needed to migrate from the previous release.
 250
 251 Compatibility
 252 -------------
 253
 254 This release of SFC is completely compatible with the previous release.
 255 The create and delete Rendered Service Path (RSP) RPCs were deprecated
 256 in this release, but are still available. These RPCs will be removed in
 257 the next release. Instead of using the RSP RPCs, RSP creation is now
 258 triggered by Service Function Path (SFP) creation. SFP creation will
 259 trigger RSP creation in the configuration data store, which will in
 260 turn trigger RSP creation in the operational data store. Previously,
 261 RSPs were only stored in the operational data store, which would be
 262 lost if OpenDaylight restarts. Now it is possible to maintain RSPs
 263 when OpenDaylight is restarted.
 264
 265 Bugs Fixed
 266 ----------
 267
 268 List of bugs fixed since the previous release
 269
 270 * `SFC-213 <https://jira.opendaylight.org/browse/SFC-213>`_ SFC statistics dont always work
 271 * `SFC-214 <https://jira.opendaylight.org/browse/SFC-214>`_ Fix sb-rest wiring
 272 * `SFC-216 <https://jira.opendaylight.org/browse/SFC-216>`_ Fix exception message check for bad macs
 273 * `SFC-218 <https://jira.opendaylight.org/browse/SFC-218>`_ Fix sfc-scf-vpp wiring
 274
 275
 276 Known Issues
 277 ------------
 278
 279 SFC needs changes in OVS to include the Network Service Headers (NSH) Chaining
 280 encapsulation feature. This patch has been ongoing for quite a while, but has
 281 finally been officially merged in OVS 2.8. OpenDaylight will be updated to
 282 use this new version of OVS in the Fluorine release. Until then, SFC will
 283 use a branched version of OVS based on 2.6.1, called the "Yi Yang Patch",
 284 `located here <https://github.com/yyang13/ovs_nsh_patches>`_.
 285 Previous versions of this OVS patch only supported VXLAN-GPE + NSH
 286 encapsulation, but this version supports both ETH + NSH and
 287 VXLAN-GPE + ETH + NSH.
 288
 289 * `Link to Open Bugs <https://jira.opendaylight.org/browse/SFC>`_
 290
 291
 292 End-of-life
 293 ===========
 294
 295 * None
 296
 297
 298 Standards
 299 =========
 300
 301 * List of standards implemented and to what extent
 302
 303 * `IETF SFC RFC <https://datatracker.ietf.org/doc/rfc7665>`_
 304 * `IETF NSH <https://tools.ietf.org/html/draft-ietf-sfc-nsh-07>`_ Only NSH Metadata type 1 is implemented.
 305 * `OpenFlow v1.3 <http://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-switch-v1.3.4.pdf>`_
 306
 307
 308 Release Mechanics
 309 =================
 310
 311 * `ODL SFC Oxygen release plan <https://wiki.opendaylight.org/view/Service_Function_Chaining:Oxygen_Release_Plan>`_
 312 * No major shifts in the release schedule from the release plan