Add hyperlink to the issue. Made some grammar/formatting corrections 18/90018/1
authorDavid Baugher <dbaugher@luminanetworks.com>
Wed, 27 May 2020 22:33:13 +0000 (15:33 -0700)
committerDavid Baugher <dbaugher@luminanetworks.com>
Wed, 27 May 2020 22:33:13 +0000 (15:33 -0700)
Signed-off-by: David Baugher <dbaugher@luminanetworks.com>
Change-Id: Ie33be7278b03cf2fd74f39ec8cf56e406243cc2d

docs/release-notes/projects/transportpce.rst

index e76474970e4bd7b2390c2d84b505f4150d27881c..f241ec6f422946a3f315d8b136caec0a470356ad 100644 (file)
@@ -5,24 +5,37 @@ Transport PCE
 Overview
 ========
 
-TransportPCE describes an application running on top of the OpenDaylight controller.
-Its primary function is to control an optical transport infrastructure using a non-proprietary South Bound Interface (SBI).
+Transport PCE is an application running on top of the OpenDaylight controller. Its primary function
+is to control an optical transport infrastructure using a non-proprietary South Bound Interface (SBI).
 
-The controlled transport infrastructure includes a WDM layer and an OTN layer.
-The WDM layer is built from ROADMs with colourless, directionless and possibly contention-less features.
-The OTN layer is built from transponders, muxponders or switchponders which include OTN switching functionalities.
+The controlled transport infrastructure includes a WDM (Wave Division Multiplexing) layer and an OTN
+(optical transport network) layer. The WDM layer is built from ROADMs (reconfigurable optical add-drop multiplexer)
+with colorless, directionless and contention-less features. The OTN layer is built from transponders,
+muxponders or switchponders which include OTN switching functionalities.
+
+Transport PCE leverages OpenROADM Multi-Source-Agreement (MSA), which defines interoperability specifications,
+consisting of both optical interoperability and YANG data models.
 
-TransportPCE leverages OpenROADM Multi-Source-Agreement (MSA) which defines interoperability specifications,
-consisting of both Optical interoperability and Yang data models.
 The TransportPCE implementation includes:
 
-* a Northbound API for higher level applications, implemented in the Service Handler bundle.
-  It relies on the Service Model defined in the MSA.
-* The Renderer and the OLM (Optical Line Management) bundles to allow configuring OpenROADM devices
-  through a southbound Netconf/Yang interface (based on the MSA’s device models).
-  This release supports the OpenROADM devices version 1.2.1 version 2.2.1 .
-* a Topology Management bundle also based on the MSA Network models defined.
-* a Path Calculation Engine (PCE, here in a different meaning than the BGPCEP project since it is not based on (G)MPLS )
+.. list-table:: Transport PCE implementation
+   :widths: 20 50
+   :header-rows: 1
+
+   * - **Feature**
+     - **Description**
+
+   * - **Northbound API**
+     - These APIs are for higher level applications, implemented in the Service Handler bundle.
+       It relies on the service model defined in the MSA.
+   * - **Renderer and OLM**
+     - The renderer and OLM (Optical Line Management) bundles allow configuring OpenROADM devices
+       through a southbound NETCONF/YANG interface (based on the MSA device models).
+       This release supports the OpenROADM devices version 1.2.1 version 2.2.1.
+   * - **Topology Management**
+     - This bundle is based on the defined MSA network model.
+   * - **Path Calculation Engine (PCE)**
+     - PCE here has a different meaning than the BGPCEP project since it is not based on (G)MPLS.
 
 The internal RPCs between those modules are defined in the Transport Service Path models.
 
@@ -31,62 +44,72 @@ Behavior Changes
 
 This release introduces the following behavior changes:
 
-* a first experimental support for OTN on top of the already existing OpenROADM WDM support.
+* First experimental support for OTN on top of the already existing OpenROADM WDM support.
   This concerns for Magnesium SR0 portmapping, topology, renderer and PCE (Service Handler not yet ready)
   Honeynode simulators were upgraded to support OTN as well as the migration to Java 11 for functional tests.
 * OpenROADM service (Northbound API) upgraded to version 5.1.0
-* Service Path API upgraded to new version 1.7
+* Service Path API upgraded to the latest version 1.7
 * GNPy server connection support.
   This allows to offload PCE impairment aware  path calculation to a GNPy server,
-  or to validate a path precomputed by transportPCE, including the impacts of non linear effects .
+  or to validate a path precomputed by transportPCE, including the impacts of non-linear effects.
 * External database connector experimental support.
   This connector allows to populate an external (MariaDB) Inventory Database, currently limited to OpenROADM version 1.2.1 devices.
-* a limited support of TAPI version 2.1.2.
+* Limited support of TAPI version 2.1.2.
   It is used to expose (through a TAPI compliant Northbound Interface) an abstracted WDM/OTN topology
   that masks the OpenROADM topology complexity to higher layer controllers/orchestrator.
-  - TAPI:get-topology-details rpc to abstract nodes from OpenROADM openroadm-topology (WDM and OTN)
+  - TAPI:get-topology-details RPC to abstract nodes from OpenROADM openroadm-topology (WDM and OTN)
 
-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).
+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).
 
 New and Modified Features
 =========================
 
-This releases provides the following new and modified features:
+This release provides the following new and modified features:
+
 
-* odl-transportpce  the main feature that installs all the OpenROADM based core components of transportPCE for WDM control.
-  The OTN support provided in portmapping, topology, renderer and PCE bundles is **Experimental** .
-* odl-transportpce-tapi a limited support of TAPI version 2.1.2 (through a TAPI compliant Northbound Interface)
-  to retrieve an abstracted WDM/OTN topology.
-* odl-transportpce-inventory a new **Experimental** feature to connect an External MariaDB inventory database.
-  Its supports is currently limited to OpenROADM version 1.2.1 devices.
+.. list-table:: New and Modified Features
+   :widths: 20 50
+   :header-rows: 1
+
+   * - **Feature**
+     - **Description**
+
+   * - **odl-transportpce**
+     - The main feature that installs all the OpenROADM-based core components of transportPCE for WDM control.
+       The OTN support provided in portmapping, topology, renderer and PCE bundles is **Experimental**.
+   * - **odl-transportpce-tapi**
+     - This is a limited support of TAPI version 2.1.2 (through a TAPI compliant Northbound Interface)
+       to retrieve an abstracted WDM/OTN topology.
+   * - **odl-transportpce-inventory**
+     - This is a new **Experimental** feature to connect an External MariaDB inventory database.
+       Support is currently limited to OpenROADM version 1.2.1 devices.
 
 Deprecated Features
 ===================
 
-This releases removed the following features:
+This release removed the following features:
 
 * features-transportpce deprecated by odl-transportpce. It was previously introduced for Karaf3/4 compatibility.
-* odl-transportpce-ordmodels moved to several bundles integrated in odl-transportpce
-* odl-transportpce-api now integrated in odl-transportpce
-* odl-transportpce-stubmodels (previously used only in tests)
+* odl-transportpce-ordmodels moved to several bundles integrated in odl-transportpce.
+* odl-transportpce-api now integrated in odl-transportpce.
+* odl-transportpce-stubmodels (previously used only in tests).
 
 Resolved Issues
 ===============
 
 The following table lists the resolved issues fixed this release.
 
-.. list-table::
-   :widths: 15 55
+.. list-table:: Resolved Issues
+   :widths: 20 50
    :header-rows: 1
 
    * - **Key**
      - **Summary**
 
-   * - TRNSPRTPCE-169
+   * - `TRNSPRTPCE-169 <https://jira.opendaylight.org/browse/TRNSPRTPCE-169>`_
      - Make the PCE more deterministic
 
 Known Issues
 ============
 
-No known issues were identified in this release.
-
+There are no known issues identified in this release.