Unimgr docs update for Carbon

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

diff --git a/docs/user-guide/uni-manager-plug-in-project.rst b/docs/user-guide/uni-manager-plug-in-project.rst
index 4f879ab99840598109ba5d177142d3b742562d94..40a96f53c76f356f8d2eca0dfcdd8a906f921598 100644 (file)
--- a/docs/user-guide/uni-manager-plug-in-project.rst
+++ b/docs/user-guide/uni-manager-plug-in-project.rst
@@ -1,47 +1,51 @@
-User Network Interface Manager Plug-in (Unimgr)
-===============================================
+User Network Interface Manager Plug-in (Unimgr) User Guide
+==========================================================
 
 Overview
 --------
 
-The User Network Interface Manager (Unimgr) is an experimental/proof of concept
-(PoC) project formed to initiate the development of data models and APIs
-facilitating the use by software applications and/or service orchestrators of
-OpenDaylight to configure and provision connectivity services, in particular
-Carrier Ethernet services as defined by Metro Ethernet Forum (MEF), in physical
-or virtual network elements.
-
-MEF as defined the LSO Reference Architecture for the management and control of
-domains and entities that enable cooperative LSO capabilities across one or
-more service provider networks. The architecture also identifies the Management
-Interface Reference Points (LSO Reference Points), the logical points of
-interaction between specific functional management components. These LSO
+The User Network Interface (UNI) Manager project within OpenDaylight provides
+data models and APIs that enable software applications and service
+orchestrators to configure and provision connectivity services; in particular,
+Carrier Ethernet services as defined by MEF Forum, in physical and virtual
+network elements.
+
+MEF has defined the Lifecycle Service Orchestration (LSO) Reference
+Architecture for the management and control of domains and entities that enable
+cooperative network services across one or more service provider networks. The
+architecture also identifies LSO Reference Points, which are the logical points
+of interaction between specific functional management components. These LSO
 Reference Points are further defined by interface profiles and instantiated by
 APIs.
 
-The LSO High Level Management Reference Architecture is shown below.  Note that
-this is a functional architecture that does not describe how the management
-components are implemented (e.g., single vs. multiple instances), but rather
-identifies management components that provide logical functionality as well as
-the points of interaction among them.
+The LSO Reference Architecture is shown below. Note that this is a functional
+architecture that does not describe how the management components are
+implemented (e.g., single vs. multiple instances), but rather identifies
+management components that provide logical functionality as well as the points
+of interaction among them.
+
+.. figure:: ./images/unimgr-lso-arch.png
+   :alt: MEF LSO Reference Architecture
+
+   MEF LSO Reference Architecture
 
 Unimgr provides support for both the Legato as well as the Presto interfaces.
-These interface, and the APIs associated with them, are defined by YANG models
-developed within MEF in collaboration with ONF and IETF. For the Boron release,
+These interfaces, and the APIs associated with them, are defined by YANG models
+developed within MEF in collaboration with ONF and IETF. For the Carbon release,
 these are as follows:
 
 Legato YANG modules:
-https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=tree;f=legato-api/src/main/yang;hb=refs/heads/stable/boron
+https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=tree;f=legato-api/src/main/yang;hb=refs/heads/stable/carbon
 
 Presto YANG modules:
-https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=tree;f=presto-api/src/main/yang;hb=refs/heads/stable/boron
+https://git.opendaylight.org/gerrit/gitweb?p=unimgr.git;a=tree;f=presto-api/src/main/yang;hb=refs/heads/stable/carbon
 
 An application/user can interact with Unimgr at either the service
 orchestration layer (Legato) or the network resource provisioning layer
 (Presto).
 
-Unimgr Components
------------------
+Unimgr Architecture
+-------------------
 
 Unimgr is comprised of the following OpenDaylight Karaf features:
 
@@ -57,8 +61,8 @@ Unimgr is comprised of the following OpenDaylight Karaf features:
 | odl-unimgr-ui                        | OpenDaylight :: UniMgr :: UI         |
 +--------------------------------------+--------------------------------------+
 
-Installing Unimgr
------------------
+Configuring Unimgr
+------------------
 
 After launching OpenDaylight, install the feature for Unimgr.  From the karaf
 command prompt execute the following command: