Merge "Documentation outline for DIDM"
[docs.git] / manuals / developer-guide / src / main / asciidoc / sfc / odl-sfc-ovs-dev.adoc
1 === SFC-OVS Plugin
2
3 ==== Overview
4 SFC-OVS provides integration of SFC with Open vSwitch (OVS) devices.
5 Integration is realized through mapping of SFC objects (like SF, SFF,
6 Classifier, etc.) to OVS objects (like Bridge, TerminationPoint=Port/Interface).
7 The mapping takes care of automatic instantiation (setup) of corresponding object
8 whenever its counterpart is created. For example, when a new SFF is created,
9 the SFC-OVS plugin will create a new OVS bridge and when a new OVS Bridge is
10 created, the SFC-OVS plugin will create a new SFF.
11
12 ==== SFC-OVS Architecture
13 SFC-OVS uses the OVSDB MD-SAL Southbound API for getting/writing information
14 from/to OVS devices. The core functionality consists of two types of mapping:
15
16 a. mapping from OVS to SFC
17 ** OVS Bridge is mapped to SFF
18 ** OVS TerminationPoints are mapped to SFF DataPlane locators
19
20 b. mapping from SFC to OVS
21 ** SFF is mapped to OVS Bridge
22 ** SFF DataPlane locators are mapped to OVS TerminationPoints
23
24 .SFC < -- > OVS mapping flow diagram
25 image::sfc/sfc-ovs-architecture.png[width=500]
26
27 ==== Key APIs and Interfaces
28 * SFF to OVS mapping API (methods to convert SFF object to OVS Bridge
29 and OVS TerminationPoints)
30 * OVS to SFF mapping API (methods to convert OVS Bridge and OVS TerminationPoints
31 to SFF object)