Add TransportPCE release notes
[docs.git] / docs / release-notes / projects / transportpce.rst
1 =============
2 Transport PCE
3 =============
4
5 Overview
6 ========
7
8 TransportPCE describes an application running on top of the OpenDaylight controller.
9 Its primary function is to control an optical transport infrastructure using a non-proprietary South Bound Interface (SBI).
10
11 The controlled transport infrastructure includes a WDM layer and an OTN layer.
12 The WDM layer is built from ROADMs with colourless, directionless and possibly contention-less features.
13 The OTN layer is built from transponders, muxponders or switchponders which include OTN switching functionalities.
14
15 TransportPCE leverages OpenROADM Multi-Source-Agreement (MSA) which defines interoperability specifications,
16 consisting of both Optical interoperability and Yang data models.
17 The TransportPCE implementation includes:
18
19 * a Northbound API for higher level applications, implemented in the Service Handler bundle.
20   It relies on the Service Model defined in the MSA.
21 * The Renderer and the OLM (Optical Line Management) bundles to allow configuring OpenROADM devices
22   through a southbound Netconf/Yang interface (based on the MSA’s device models).
23   This release supports the OpenROADM devices version 1.2.1 version 2.2.1 .
24 * a Topology Management bundle also based on the MSA Network models defined.
25 * a Path Calculation Engine (PCE, here in a different meaning than the BGPCEP project since it is not based on (G)MPLS )
26
27 The internal RPCs between those modules are defined in the Transport Service Path models.
28
29 Behavior Changes
30 ================
31
32 This release introduces the following behavior changes:
33
34 * a first experimental support for OTN on top of the already existing OpenROADM WDM support.
35   This concerns for Magnesium SR0 portmapping, topology, renderer and PCE (Service Handler not yet ready)
36   Honeynode simulators were upgraded to support OTN as well as the migration to Java 11 for functional tests.
37 * OpenROADM service (Northbound API) upgraded to version 5.1.0
38 * Service Path API upgraded to new version 1.7
39 * GNPy server connection support.
40   This allows to offload PCE impairment aware  path calculation to a GNPy server,
41   or to validate a path precomputed by transportPCE, including the impacts of non linear effects .
42 * External database connector experimental support.
43   This connector allows to populate an external (MariaDB) Inventory Database, currently limited to OpenROADM version 1.2.1 devices.
44 * a limited support of TAPI version 2.1.2.
45   It is used to expose (through a TAPI compliant Northbound Interface) an abstracted WDM/OTN topology
46   that masks the OpenROADM topology complexity to higher layer controllers/orchestrator.
47   - TAPI:get-topology-details rpc to abstract nodes from OpenROADM openroadm-topology (WDM and OTN)
48
49 OTN XPONDERS in the abstracted T-API topology appear as one node in the DSR/ODU layer (with 1GE/ODU0, 10GE/ODU2e or 100GE/ODU4 Node Edge Points (NEP)), and one node in the photonic-Media layer with a single OMS/OTSI NEP. Both nodes are interconnected through a transitional link. Couples of 100GE Transponders are represented through a single node ( layer-protocol-name = ETH).
50
51 New and Modified Features
52 =========================
53
54 This releases provides the following new and modified features:
55
56 * odl-transportpce  the main feature that installs all the OpenROADM based core components of transportPCE for WDM control.
57   The OTN support provided in portmapping, topology, renderer and PCE bundles is **Experimental** .
58 * odl-transportpce-tapi a limited support of TAPI version 2.1.2 (through a TAPI compliant Northbound Interface)
59   to retrieve an abstracted WDM/OTN topology.
60 * odl-transportpce-inventory a new **Experimental** feature to connect an External MariaDB inventory database.
61   Its supports is currently limited to OpenROADM version 1.2.1 devices.
62
63 Deprecated Features
64 ===================
65
66 This releases removed the following features:
67
68 * features-transportpce deprecated by odl-transportpce. It was previously introduced for Karaf3/4 compatibility.
69 * odl-transportpce-ordmodels moved to several bundles integrated in odl-transportpce
70 * odl-transportpce-api now integrated in odl-transportpce
71 * odl-transportpce-stubmodels (previously used only in tests)
72
73 Resolved Issues
74 ===============
75
76 The following table lists the resolved issues fixed this release.
77
78 .. list-table::
79    :widths: 15 55
80    :header-rows: 1
81
82    * - **Key**
83      - **Summary**
84
85    * - TRNSPRTPCE-169
86      - Make the PCE more deterministic
87
88 Known Issues
89 ============
90
91 No known issues were identified in this release.
92