docs/user-guide/uni-manager-plug-in-project.rst

   1 UNI Manager Plug In Project
   2 ===========================
   3
   4 Overview
   5 --------
   6
   7 The version of the UNI Manager (UNIMgr) plug-in included in OpenDaylight
   8 Beryllium release is experimental, serving as a proof-of-concept (PoC)
   9 for using features of OpenDaylight to provision networked elements with
  10 attributes satisfying Metro Ethernet Forum (MEF) requirements for
  11 delivery of Carrier Ethernet service. This initial version of UNIMgr
  12 does not enable the full set of MEF-defined functionality for Carrier
  13 Ethernet service. UNI Manager adheres to a minimum set of functionality
  14 defined by MEF 7.2 and 10.2 specifications.
  15
  16 UNIMgr receives a request from applications to create an Ethernet
  17 Private Line (EPL) private Ethernet connection between two endpoints on
  18 the network. The request must include the IP addresses of the endpoints
  19 and a class of service identifier.
  20
  21 UNI Manager plug-in translates the request for EPL service into (a)
  22 configuring two instances of Open vSwitch (OVS), each instance running
  23 in one of the UNI endpoints, with two ports and a bridge between the
  24 ports, and (b) creating a GRE tunnel to provide a private connection
  25 between the endpoints. This initial version of UNIMgr uses only OVSDB on
  26 its southbound interface to send configuration commands.
  27
  28 UNIMgr also accepts a bits per second datarate parameter, which is
  29 translated to an OVSDB command to limit the rate at which the OVS
  30 instances will forward data traffic.
  31
  32 The YANG module used to create the UNIMgr plug-in models MEF-defined UNI
  33 and Ethernet Virtual Connection (EVC) attributes but does not include
  34 the full set of UNI and EVC attributes. And of the attributes modeled in
  35 the YANG module only a subset of them are implemented in the UNIMgr
  36 listener code translating the Operational data tree to OVSDB commands.
  37 The YANG module used to develop the PoC UNIMgr plug-in is
  38 cl-unimgr-mef.yang. A copy of this module is available in the
  39 odl-unimgr-api bundle of the UNIMgr project.
  40
  41 Limitations of the PoC version of UNI Manager in OpenDaylight Beryllium
  42 include those listed below: \* Uses only OVSDB southbound interface of
  43 OpenDaylight \* Only uses UNI ID, IP Address, and speed UNI attributes
  44 \* Only uses a subset of EVC per UNI attributes \* Does not use MEF
  45 Class of Service or Bandwidth Profile attributes \* Configures only Open
  46 vSwitch network elements
  47
  48 Opportunities for evolution of the UNI Manager plug in include using
  49 complete MEF Service Layer and MEF Resource Layer YANG models and
  50 supporting other OpenDaylight southbound protocols like NetConf and
  51 OpenFlow.
  52
  53 UNI Manager Components
  54 ----------------------
  55
  56 UNI Manager is comprised of the following OpenDaylight Karaf features:
  57
  58 +--------------------------------------+--------------------------------------+
  59 | odl-unimgr-api                       | OpenDaylight :: UniMgr :: api        |
  60 +--------------------------------------+--------------------------------------+
  61 | odl-unimgr                           | OpenDaylight :: UniMgr               |
  62 +--------------------------------------+--------------------------------------+
  63 | odl-unimgr-console                   | OpenDaylight :: UniMgr :: CLI        |
  64 +--------------------------------------+--------------------------------------+
  65 | odl-unimgr-rest                      | OpenDaylight :: UniMgr :: REST       |
  66 +--------------------------------------+--------------------------------------+
  67 | odl-unimgr-ui                        | OpenDaylight :: UniMgr :: UI         |
  68 +--------------------------------------+--------------------------------------+
  69
  70 Installing UNI Manager Plug-in
  71 ------------------------------
  72
  73 After launching OpenDaylight install the feature for the UNI Manager
  74 plug-in. From the karaf command prompt execute the following command to
  75 install the UNI Manager plug-in:
  76
  77 ::
  78
  79     $ feature:install odl-manager-ui
  80
  81 Explore and exercise the UNI Manager REST API
  82 ---------------------------------------------
  83
  84 To see the UNI Manager APIs, browse to this URL:
  85 http://localhost:8181/apidoc/explorer/index.html
  86
  87 Replace localhost with the IP address or hostname where OpenDaylight is
  88 running if you are not running OpenDaylight locally on your machine.
  89
  90 See also the UNI Manager Developer’s Guide for a full list and
  91 description of UNI Manager POSTMAN calls.
  92