docs/getting-started-guide/project-release-notes/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 These features are consumed by the User facing features above
 130 =============================================================
 131
 132
 133 odl-sfc-genius
 134 --------------
 135
 136 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sfc.git;a=blob;f=features/src/main/features/features.xml
 137 * **Feature Description:**  This feature implements the Genius utilities created by SFC project.
 138 * **Top Level:** Yes
 139 * **User Facing:** No
 140 * **Experimental:** No
 141 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 142
 143
 144 odl-sfc-model
 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 defines and implements the SFC data model as specified here https://datatracker.ietf.org/doc/rfc7665/
 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-pot-netconf-renderer
 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 implements the Netconf rendering for the Proof of Transit for the Service Functions.
 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-provider
 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 provides an easy-to-use interface to the sfc-model.
 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-rest
 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 no functionality, and just installs the necessary features for SFC restconf.
 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-ovs
 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 functionality for SFC to communicate with OVSDB for SFF configuration.
 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-test-consumer
 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 is used for testing only.
 204 * **Top Level:** Yes
 205 * **User Facing:** No
 206 * **Experimental:** Yes
 207 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
 208
 209
 210 Features removed in this release
 211 ================================
 212
 213 * odl-sfc-bootstrap - used to load an initial configuration that is no longer needed
 214 * odl-sfcofl2 - was deprecated since it was renamed to odl-sfc-openflow-renderer
 215
 216
 217 Documentation
 218 =============
 219
 220 * **User Guide(s):**
 221
 222   * :ref:`sfc-user-guide`
 223
 224 * **Developer Guide(s):**
 225
 226   * :ref:`sfc-dev-guide`
 227
 228
 229 Security Considerations
 230 =======================
 231
 232 None.
 233
 234
 235 Quality Assurance
 236 =================
 237
 238 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=19574>`_ (55.9%)
 239 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/sfc/>`_
 240 * All modules have been unit tested. Integration tests have been performed for
 241   all major features. System tests have been performed on most major features.
 242
 243 Migration
 244 ---------
 245
 246 The impacts on the SFC data models in this release are minimal.
 247 Several fields that were marked as deprecated in Beryllium and
 248 Boron have been removed in Carbon, as follows. No automatic data
 249 migration is supported.
 250
 251 **Service Chain Symmetry**
 252
 253 Previously a Service Chain could be marked symmetric by using
 254 either the symmetric flag in the Service Function Chain (SFC),
 255 the Service Function Path (SFP), or the Rendered Service Path (RSP).
 256 This approach can be confusing if the SFC, SFP, or RSP have different
 257 values for the symmetric flag. The symmetric flag has been removed
 258 from the SFC and RSP and can now only be set in the SFP. Additionally,
 259 if the symmetric flag is not present in the SFP, if any of the Service
 260 Functions is of a Service Funtion Type (SFT) that has the bidirectional
 261 flag set true, then the Service Chain will be symmetric. The SFP
 262 symmetric flag overides the SFT bidirectional flag. To say that
 263 a Service Chain is symmetric means that 2 RSPs will be created
 264 internally, one uplink and another downlink.
 265
 266
 267 **Deprecated Service Function fields**
 268
 269 The Service Function ``nsh-aware`` and ``requires-classification`` fields
 270 have been moved to the Service Function Type.
 271
 272 Compatibility
 273 -------------
 274
 275 Other than the API changes mentioned in the previous section, this
 276 release is compatible with the previous release.
 277
 278 Bugs Fixed
 279 ----------
 280
 281 List of bugs fixed since the previous release
 282
 283 * https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-09&chfieldto=2017-05-25&list_id=78767&product=sfc&query_format=advanced&resolution=FIXED
 284
 285
 286 Known Issues
 287 ------------
 288
 289 SFC needs changes in OVS to include the Network Service Headers (NSH) Chaining
 290 encapsulation feature. This patch has been ongoing for quite a while (2 years+),
 291 and still has not been officially merged. Until NSH is officially merged in
 292 OVS, SFC will use a branched version of OVS based on 2.6.1, called the
 293 "Yi Yang Patch", `located here <https://github.com/yyang13/ovs_nsh_patches>`_.
 294 Previous versions of this OVS patch only supported VXLAN-GPE + NSH
 295 encapsulation, but this version supports both ETH + NSH and VXLAN-GPE + ETH + NSH.
 296
 297 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78823&order=Importance&product=sfc&query_format=specific>`_
 298
 299 The following bug was found during Carbon RC testing, which was
 300 originally marked as a blocker. Upon further investigation, the
 301 MDSAL team decided its not a blocker and decided to postpone
 302 fixing it until Carbon SR1.
 303
 304 * https://bugs.opendaylight.org/show_bug.cgi?id=8501
 305
 306
 307 End-of-life
 308 ===========
 309
 310 List of features/APIs which are EOLed, deprecated, and/or removed in this release
 311
 312 * In the Beryllium release, the Service Function nsh-aware and request-classification
 313   API fields were deprecated, and were subsequently removed in Carbon.
 314
 315   * Use the corresponding fields in the Service Function Type instead.
 316
 317 * In the Boron release, the symmetrice API field was deprecated in the Service
 318   Function Chain and Rendered Service Path data models, and were subsequently
 319   removed in Carbon.
 320
 321   * Use the Service Function Path (SFP) symmetric field instead of the SFC or
 322     RSP symmetric field.
 323   * Or, if the SFP symmetric field is not present and any of the Service
 324     Functions has a Service Function type that sets bidirection true, then
 325     the resulting Rendered Service Path will be symmetric.
 326
 327 Standards
 328 =========
 329
 330 * List of standards implemented and to what extent
 331
 332 * `IETF SFC RFC <https://datatracker.ietf.org/doc/rfc7665>`_
 333 * `IETF NSH <https://tools.ietf.org/html/draft-ietf-sfc-nsh-07>`_ Only NSH Metadata type 1 is implemented.
 334 * `OpenFlow v1.3 <http://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-switch-v1.3.4.pdf>`_
 335
 336
 337 Release Mechanics
 338 =================
 339
 340 * `ODL SFC Carbon release plan <https://wiki.opendaylight.org/view/Service_Function_Chaining:Carbon_Release_Plan>`_
 341 * No major shifts in the release schedule from the release plan