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

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