1 =========================
2 Service Function Chaining
3 =========================
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.
14 * **User Facing:** Yes
15 * **Experimental:** Yes
16 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
25 * **User Facing:** Yes
26 * **Experimental:** No
27 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
36 * **User Facing:** Yes
37 * **Experimental:** No
38 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
41 odl-sfc-openflow-renderer
42 -------------------------
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.
47 * **User Facing:** Yes
48 * **Experimental:** No
49 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
58 * **User Facing:** Yes
59 * **Experimental:** Yes
60 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
69 * **User Facing:** Yes
70 * **Experimental:** Yes
71 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
80 * **User Facing:** Yes
81 * **Experimental:** Yes
82 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
91 * **User Facing:** Yes
92 * **Experimental:** Yes
93 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
96 odl-sfc-ios-xe-renderer
97 -----------------------
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.
102 * **User Facing:** Yes
103 * **Experimental:** Yes
104 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
113 * **User Facing:** Yes
114 * **Experimental:** Yes
115 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
124 * **User Facing:** Yes
125 * **Experimental:** Yes
126 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
135 * **User Facing:** Yes
136 * **Experimental:** Yes
137 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
140 These features are consumed by the User facing features above
141 =============================================================
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.
150 * **User Facing:** No
151 * **Experimental:** No
152 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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/
161 * **User Facing:** No
162 * **Experimental:** No
163 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
166 odl-sfc-pot-netconf-renderer
167 ----------------------------
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.
172 * **User Facing:** No
173 * **Experimental:** No
174 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
183 * **User Facing:** No
184 * **Experimental:** No
185 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
188 odl-sfc-provider-rest
189 ---------------------
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.
194 * **User Facing:** No
195 * **Experimental:** No
196 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
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.
205 * **User Facing:** No
206 * **Experimental:** No
207 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
210 odl-sfc-test-consumer
211 ---------------------
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.
216 * **User Facing:** No
217 * **Experimental:** Yes
218 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sfc/job/sfc-csit-3node-clustering-all-carbon
226 * :ref:`sfc-user-guide`
228 * **Developer Guide(s):**
230 * :ref:`sfc-dev-guide`
233 Security Considerations
234 =======================
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.
249 Nothing special is needed to migrate from the previous release.
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.
268 List of bugs fixed since the previous release
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
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.
289 * `Link to Open Bugs <https://jira.opendaylight.org/browse/SFC>`_
301 * List of standards implemented and to what extent
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>`_
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