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 alarm/fault and performance
  21 monitoring, but this function might be externalized to improve the scalability.
  22 A Graphical User Interface could be developed in a later step, but is not
  23 considered as a priority since automated control does not imply user
  24 interactions at the transport 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
  45 -  **odl-transportpce-api**
  46
  47    -  This feature contains all Transportpce project specific models defined in "Service-path".
  48       These models complement OpenROADM models describing South and Northbound APIs, and define the
  49       data structure used to interconnect the generic blocks/functions described on the previous
  50       diagram.
  51
  52 -  **odl-transportpce-ordmodels**
  53
  54    -  This feature contains all OpenROADM models : Common, Device, Network and Service models.
  55
  56 -  **odl-transportpce-stubmodels**
  57
  58    -  This feature provides function to be able to stub some of TransportPCE modules, pce and
  59       renderer (Stubpce and Stubrenderer).
  60       Stubs are used for development purposes and required for some of the functionnal tests.
  61
  62
  63 How To Start
  64 ------------
  65
  66 Preparing for Installation
  67 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  68
  69 1. Devices must support the standard OpenROADM Models more precisely versions
  70    1.2.1 and 2.1.
  71
  72 2. Devices must support configuration through NETCONF protocol/API.
  73
  74
  75
  76 Installation Feature
  77 ~~~~~~~~~~~~~~~~~~~~
  78
  79 Run OpenDaylight and install TransportPCE Service *odl-transportpce* as below::
  80
  81    feature:install odl-transportpce
  82
  83 For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.