manuals/user-guide/src/main/asciidoc/sfc/odl-sfc-sb-rest-user.adoc

   1 === SFC Southbound REST Plugin
   2
   3 ==== Overview
   4 The Southbound REST Plugin is used to send configuration from DataStore down to
   5 network devices supporting a REST API (i.e. they have a configured REST URI).
   6 It supports POST/PUT/DELETE operations, which are triggered accordingly by
   7 changes in the SFC data stores.
   8
   9 .In its current state it listens to changes in these SFC data stores:
  10 * Access Control List (ACL)
  11 * Service Classifier Function (SCF)
  12 * Service Function (SF)
  13 * Service Function Group (SFG)
  14 * Service Function Schedule Type (SFST)
  15 * Service Function Forwader (SFF)
  16 * Rendered Service Path (RSP)
  17
  18 ==== Southbound REST Plugin Architecture
  19 From the user perspective, the REST plugin is another SFC Southbound plugin
  20 used to communicate with network devices.
  21
  22 .Soutbound REST Plugin integration into ODL
  23 image::sfc/sb-rest-architecture-user.png[width=250]
  24
  25 ==== Configuring Southbound REST Plugin
  26 .Configuration steps:
  27 . Run ODL distribution (run karaf)
  28 . In karaf console execute: +feature:install odl-sfc-sb-rest+
  29 . Configure REST URIs for SF/SFF through SFC User Interface or RESTCONF
  30 (required configuration steps can be found in the tutorial stated bellow)
  31
  32 ==== Tutorial
  33 Comprehensive tutorial on how to use the Southbound REST Plugin and how to
  34 control network devices with it can be found on:
  35 https://wiki.opendaylight.org/view/Service_Function_Chaining:Main#SFC_101