docs/user-guide.rst

   1 .. _transportpce-user-guide:
   2
   3 TransportPCE User Guide
   4 =======================
   5
   6 Overview
   7 --------
   8
   9 TransportPCE describes an application running on top of the OpenDaylight
  10 controller. Its primary function is to control an optical transport
  11 infrastructure using a non-proprietary South Bound Interface (SBI). It may be
  12 interconnected with Controllers of different layers (L2, L3 Controller…),
  13 a higher layer Controller and/or an Orchestrator through non-proprietary
  14 Application Programing Interfaces (APIs). Control includes the capability to
  15 configure the optical equipment, and to provision services according to a
  16 request coming from a higher layer controller and/or an orchestrator.
  17 This capability may rely on the controller only or it may be delegated to
  18 distributed (standardized) protocols.
  19
  20 It provides basic alarm/fault and performance monitoring,
  21 but this function might be externalized to improve the scalability.
  22 A Graphical User Interface has been developped separately and is not proposed
  23 here since automated control does not imply user interactions at the transport
  24 controller level.
  25
  26 TransportPCE modular architecture is described on the next diagram. Each main
  27 function such as Topology management, Path Calculation Engine (PCE), Service
  28 handler, Renderer responsible for the path configuration through optical
  29 equipment and Optical Line Management (OLM) is associated with a generic block
  30 relying on open models, each of them communicating through published APIs.
  31
  32 .. figure:: ./images/tpce_architecture.jpg
  33    :alt: TransportPCE architecture
  34
  35    TransportPCE architecture
  36
  37 TransportPCE User-Facing Features
  38 ---------------------------------
  39 -  **odl-transportpce**
  40
  41    -  This feature contains all other features/bundles of TransportPCE project.
  42       If you install it, it provides all functions that the TransportPCE project
  43       can support.
  44       It exposes all Transportpce project specific models defined in "Service-path".
  45       These models complement OpenROADM models describing South and Northbound APIs, and define the
  46       data structure used to interconnect the generic blocks/functions described on the previous
  47       diagram.
  48
  49 -  **feature odl-transportpce-tapi**
  50
  51    -  This feature provides transportPCE a limited support of TAPI version 2.1.2 Northbound interface.
  52
  53 -  **feature odl-transportpce-inventory**
  54
  55    -  This feature provides transportPCE an external connector to a MariaDB inventory currently limited to openROADM 1.2.1 devices.
  56
  57 How To Start
  58 ------------
  59
  60 Preparing for Installation
  61 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  62
  63 1. Devices must support the standard OpenROADM Models more precisely versions
  64    1.2.1 and 2.1. Limited support is provided for 2.2 and 2.2.1 devices.
  65    If WDM is supported on them, the OTN support is considererd experimental at that date.
  66
  67 2. Devices must support configuration through NETCONF protocol/API.
  68
  69
  70
  71 Installation Feature
  72 ~~~~~~~~~~~~~~~~~~~~
  73
  74 Run OpenDaylight and install TransportPCE Service *odl-transportpce* as below::
  75
  76    feature:install odl-transportpce
  77
  78 if you need TAPI limited support, then run::
  79
  80    feature:install odl-transportpce-tapi
  81
  82 if you need the inventory external connector support limited to 1.2.1 OpenROADM devices, then run::
  83
  84    feature:install odl-transportpce-inventory
  85
  86 For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.