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 Documentation
 211 =============
 212
 213 * **User Guide(s):**
 214
 215   * :ref:`sfc-user-guide`
 216
 217 * **Developer Guide(s):**
 218
 219   * :ref:`sfc-dev-guide`
 220
 221
 222 Security Considerations
 223 =======================
 224
 225 None.
 226
 227
 228 Quality Assurance
 229 =================
 230
 231 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=19574>`_ (57.1%)
 232 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/sfc/>`_
 233 * All modules have been unit tested. Integration tests have been performed for
 234   all major features. System tests have been performed on most major features.
 235
 236 Migration
 237 ---------
 238
 239 * Is it possible to migrate from the previous release? If so, how?
 240
 241 No changes were made to the SFC data model in this release, so
 242 no migration from the previous release is needed.
 243
 244 Compatibility
 245 -------------
 246
 247 This release of SFC is completely compatible with the previous release.
 248
 249 Bugs Fixed
 250 ----------
 251
 252 List of bugs fixed since the previous release
 253
 254 * `3712 <https://bugs.opendaylight.org/show_bug.cgi?id=3712>`_ Setting an SF on an SFP hop with an SF type different than the corresponding SFC hop should fail
 255 * `7554 <https://bugs.opendaylight.org/show_bug.cgi?id=7554>`_ Update GUI after deprecating nsh-aware in SF and other changes in model
 256 * `7555 <https://bugs.opendaylight.org/show_bug.cgi?id=7555>`_ SfcRenderingException for logicalSFF when SFs share a compute node
 257 * `7629 <https://bugs.opendaylight.org/show_bug.cgi?id=7629>`_ Karaf 4 migration: provide Karaf 4 sfc features
 258
 259
 260 Known Issues
 261 ------------
 262
 263 SFC needs changes in OVS to include the Network Service Headers (NSH) Chaining
 264 encapsulation feature. This patch has been ongoing for quite a while, but has
 265 finally been officially merged in OVS 2.8. ODL will be updated to use this new
 266 version of OVS in the Oxygen release. Until then, SFC will use a branched
 267 version of OVS based on 2.6.1, called the "Yi Yang Patch",
 268 `located here <https://github.com/yyang13/ovs_nsh_patches>`_.
 269 Previous versions of this OVS patch only supported VXLAN-GPE + NSH
 270 encapsulation, but this version supports both ETH + NSH and VXLAN-GPE + ETH + NSH.
 271
 272 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=__open__&list_id=78823&order=Importance&product=sfc&query_format=specific>`_
 273
 274
 275 End-of-life
 276 ===========
 277
 278 * None
 279
 280
 281 Standards
 282 =========
 283
 284 * List of standards implemented and to what extent
 285
 286 * `IETF SFC RFC <https://datatracker.ietf.org/doc/rfc7665>`_
 287 * `IETF NSH <https://tools.ietf.org/html/draft-ietf-sfc-nsh-07>`_ Only NSH Metadata type 1 is implemented.
 288 * `OpenFlow v1.3 <http://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/openflow-switch-v1.3.4.pdf>`_
 289
 290
 291 Release Mechanics
 292 =================
 293
 294 * `ODL SFC Carbon release plan <https://wiki.opendaylight.org/view/Service_Function_Chaining:Nitrogen_Release_Plan>`_
 295 * No major shifts in the release schedule from the release plan