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

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