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

   1 User Network Interface Manager Plug-in (Unimgr)
   2 ===============================================
   3
   4 Overview
   5 --------
   6
   7 The User Network Interface Manager (Unimgr) is an experimental/proof of concept
   8 (PoC) project formed to initiate the development of data models and APIs
   9 facilitating the use by software applications and/or service orchestrators of
  10 OpenDaylight to configure and provision connectivity services, in particular
  11 Carrier Ethernet services as defined by Metro Ethernet Forum (MEF), in physical
  12 or virtual network elements.
  13
  14 MEF as defined the LSO Reference Architecture for the management and control of
  15 domains and entities that enable cooperative LSO capabilities across one or
  16 more service provider networks. The architecture also identifies the Management
  17 Interface Reference Points (LSO Reference Points), the logical points of
  18 interaction between specific functional management components. These LSO
  19 Reference Points are further defined by interface profiles and instantiated by
  20 APIs.
  21
  22 The LSO High Level Management Reference Architecture is shown below.  Note that
  23 this is a functional architecture that does not describe how the management
  24 components are implemented (e.g., single vs. multiple instances), but rather
  25 identifies management components that provide logical functionality as well as
  26 the points of interaction among them.
  27
  28 Unimgr provides support for both the Legato as well as the Presto interfaces.
  29 These interface, and the APIs associated with them, are defined by YANG models
  30 developed within MEF in collaboration with ONF and IETF. For the Boron release,
  31 these are as follows:
  32
  33 Legato YANG modules:
  34 https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=tree;f=legato-api/src/main/yang;hb=refs/heads/stable/boron
  35
  36 Presto YANG modules:
  37 https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=tree;f=presto-api/src/main/yang;hb=refs/heads/stable/boron
  38
  39 An application/user can interact with Unimgr at either the service
  40 orchestration layer (Legato) or the network resource provisioning layer
  41 (Presto).
  42
  43 Unimgr Components
  44 -----------------
  45
  46 Unimgr is comprised of the following OpenDaylight Karaf features:
  47
  48 +--------------------------------------+--------------------------------------+
  49 | odl-unimgr-api                       | OpenDaylight :: UniMgr :: api        |
  50 +--------------------------------------+--------------------------------------+
  51 | odl-unimgr                           | OpenDaylight :: UniMgr               |
  52 +--------------------------------------+--------------------------------------+
  53 | odl-unimgr-console                   | OpenDaylight :: UniMgr :: CLI        |
  54 +--------------------------------------+--------------------------------------+
  55 | odl-unimgr-rest                      | OpenDaylight :: UniMgr :: REST       |
  56 +--------------------------------------+--------------------------------------+
  57 | odl-unimgr-ui                        | OpenDaylight :: UniMgr :: UI         |
  58 +--------------------------------------+--------------------------------------+
  59
  60 Installing Unimgr
  61 -----------------
  62
  63 After launching OpenDaylight, install the feature for Unimgr.  From the karaf
  64 command prompt execute the following command:
  65
  66 ::
  67
  68     $ feature:install odl-unimgr-ui
  69
  70 Explore and exercise the Unimgr REST API
  71 ----------------------------------------
  72
  73 To see the Unimgr API, browse to this URL:
  74 http://localhost:8181/apidoc/explorer/index.html
  75
  76 Replace localhost with the IP address or hostname where OpenDaylight is
  77 running if you are not running OpenDaylight locally on your machine.
  78
  79 See also the Unimgr Developer Guide for a full listing of the API.