Merge "Add hyperlinks to the issues. Made some formatting changes" into stable/magnesium
authorJamo Luhrsen <jluhrsen@gmail.com>
Wed, 3 Jun 2020 17:37:51 +0000 (17:37 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Wed, 3 Jun 2020 17:37:51 +0000 (17:37 +0000)
docs/release-notes/projects/controller.rst
docs/release-notes/projects/daexim.rst
docs/release-notes/projects/distribution.rst
docs/release-notes/projects/jsonrpc.rst
docs/release-notes/projects/netvirt.rst
docs/release-notes/projects/transportpce.rst

index b654846bc0a2e05f385bd09e7d5a1472b92561a1..334e3a958e0041c48df539e47d1c362054646847 100644 (file)
@@ -35,30 +35,30 @@ The following table lists the resolved issues fixed this release.
    * - **Key**
      - **Summary**
 
-   * - CONTROLLER-1626
+   * - `CONTROLLER-1626 <https://jira.opendaylight.org/browse/CONTROLLER-1626>`_
      - Add an option to allow CDS FE to start its generation counting from non-zero
-   * - CONTROLLER-1889
+   * - `CONTROLLER-1889 <https://jira.opendaylight.org/browse/CONTROLLER-1889>`_
      - Rework NormalizedNodePruner in terms of a forwarder
-   * - CONTROLLER-1908
+   * - `CONTROLLER-1908 <https://jira.opendaylight.org/browse/CONTROLLER-1908>`_
      - Deduplicate NodeIdentifierWithPredicate/LeafNode values from incoming streams
-   * - CONTROLLER-1909
+   * - `CONTROLLER-1909 <https://jira.opendaylight.org/browse/CONTROLLER-1909>`_
      - Deduplicate NodeIdentifierWithPredicate/LeafNode values when writing streams
-   * - CONTROLLER-1914
+   * - `CONTROLLER-1914 <https://jira.opendaylight.org/browse/CONTROLLER-1914>`_
      - Allow initial settle time to be tuned
-   * - CONTROLLER-1917
+   * - `CONTROLLER-1917 <https://jira.opendaylight.org/browse/CONTROLLER-1917>`_
      - Deprecate controller MD-SAL APIs for removal
-   * - CONTROLLER-1919
+   * - `CONTROLLER-1919 <https://jira.opendaylight.org/browse/CONTROLLER-1919>`_
      - Add Magnesium streaming format
-   * - CONTROLLER-1920
+   * - `CONTROLLER-1920 <https://jira.opendaylight.org/browse/CONTROLLER-1920>`_
      - CommitTransactionPayload results in humongous objects being allocated
-   * - CONTROLLER-1922
+   * - `CONTROLLER-1922 <https://jira.opendaylight.org/browse/CONTROLLER-1922>`_
      - Split out EntityOwnershipService implementation from distributed-datastore
-   * - CONTROLLER-1923
+   * - `CONTROLLER-1923 <https://jira.opendaylight.org/browse/CONTROLLER-1923>`_
      - Convert pre-Magnesium to Magnesium snapshots/journal entries
-   * - CONTROLLER-1924
+   * - `CONTROLLER-1924 <https://jira.opendaylight.org/browse/CONTROLLER-1924>`_
      - Migrate NormalizedNodeInputOutput to use yangtools and deprecate it
-   * - CONTROLLER-1928
+   * - `CONTROLLER-1928 <https://jira.opendaylight.org/browse/CONTROLLER-1928>`_
      - Regression detected in CSIT
-   * - CONTROLLER-1929
+   * - `CONTROLLER-1929 <https://jira.opendaylight.org/browse/CONTROLLER-1929>`_
      - Propagate TimeoutException if ActorSystem fails to terminate in time
 
index d3cd7b98cda42aa07d04f774c5e76679760bdc2d..b935a0bcb74429fb514ce66e8a16531d52679996 100644 (file)
@@ -9,20 +9,20 @@ Data Export/Import (Daexim) feature allows OpenDaylight administrators
 to export the current system state to the file system or to import the
 state from the file system.
 
-New and Modified Features
-=========================
+New Feature
+===========
 
-This releases provides the following new features:
+This release provides the following new features:
 
-* `DAEXIM-16 <https://jira.opendaylight.org/browse/DAEXIM-16>`_: Option to batch data during import operation
+* `DAEXIM-16 <https://jira.opendaylight.org/browse/DAEXIM-16>`_: Option to batch data during import operation.
 
 Deprecated Features
 ===================
 
 This release did not deprecate or remove any feature.
 
-Resolved Issues
-===============
+Resolved Issue
+==============
 
 The following table lists the resolved issues fixed this release.
 
@@ -33,11 +33,11 @@ The following table lists the resolved issues fixed this release.
    * - **Key**
      - **Summary**
 
-   * - DAEXIM-15
-     - Daexim import during boot fails if model file not provided
+   * - `DAEXIM-15 <https://jira.opendaylight.org/browse/DAEXIM-15>`_
+     - Daexim import during boot fails if model file not provided.
 
-Known Issues
-============
+Known Issue
+===========
 
 The following table lists the known issues that exist in this release.
 
@@ -48,6 +48,5 @@ The following table lists the known issues that exist in this release.
    * - **Key**
      - **Summary**
 
-   * - DAEXIM-14
-     - Add an option to trigger a CDS snapshot after import
-
+   * - `DAEXIM-14 <https://jira.opendaylight.org/browse/DAEXIM-14>`_
+     - Add an option to trigger a CDS snapshot after import.
index eed8abea008144b8746241034fcc233cf7101d8c..f48d7e0d1ad7418c2530af3b16eb3a7a2f7ceac5 100644 (file)
@@ -8,14 +8,21 @@ Overview
 The Distribution project is the placeholder for the ODL karaf
 distribution. The project currently generates 3 artifacts:
 
-* The **Managed distribution** (e.g. karaf-<version>.tar.gz): This includes
-  the Managed projects in OpenDaylight (See :ref:`managed-release`).
+.. list-table:: Distribution Artifacts
+   :widths: 20 50
+   :header-rows: 1
 
-* The **Common distribution** (e.g. opendaylight-<version>.tar.gz): This
-  includes Managed and Self-Managed projects (See :ref:`managed-release`).
+   * - **Artifact**
+     - **Description**
 
-* The **ONAP distribution** (e.g. onap-karaf-<version>.tar.gz): This is the
-  distribution used in the ONAP CCSDK project.
+   * - **Managed distribution** (e.g., karaf-<version>.tar.gz)
+     - This includes the managed projects in OpenDaylight
+       (refer to, :ref:`managed-release`).
+   * - **Common distribution** (e.g., opendaylight-<version>.tar.gz)
+     - This includes managed and self-managed projects
+       (refer to, :ref:`managed-release`).
+   * - **ONAP distribution** (e.g., onap-karaf-<version>.tar.gz)
+     - This is the distribution used in the ONAP CCSDK project.
 
 The distribution project is also the placeholder for the distribution
 scripts. Example of these scripts:
@@ -32,39 +39,39 @@ This release introduces the following behavior changes:
 New and Modified Features
 =========================
 
-This releases provides the following new and modified features:
+This release provides the following new and modified features:
 
-* New Detnet project features are available in the Common distribution.
-* JSON-RPC project features are available in the Managed distribution.
+* New Detnet project features are available in the common distribution.
+* JSON-RPC project features are available in the managed distribution.
 
 Deprecated Features
 ===================
 
-This releases removed the following features:
+This release removed the following features:
 
-* COE project features
-* SFC project features
+* COE (Container Orchestration Engine) project
+* SFC (Service Function Chaining) project
 
 Resolved Issues
 ===============
 
 The following table lists the resolved issues fixed this release.
 
-.. list-table::
+.. list-table:: Resolved Issues
    :widths: 15 55
    :header-rows: 1
 
    * - **Key**
      - **Summary**
 
-   * - INTDIST-107
+   * - `INTDIST-107 <https://jira.opendaylight.org/browse/INTDIST-107>`_
      - Add yang model check at distribution build
 
-   * - INTDIST-106
+   * - `INTDIST-106 <https://jira.opendaylight.org/browse/INTDIST-106>`_
      - Create ONAP distribution
 
 Known Issues
 ============
 
-No Known issues in this release.
+There are no known issues in this release.
 
index 90f928e0ce1271fee946828865f8a740e9c9cfe8..911d958c7a3a70a098479eafc70c1b3a005331e5 100644 (file)
@@ -6,9 +6,9 @@ Overview
 ========
 
 JSON-RPC 2.0 is a lightweight remote procedure call and notification
-specification maintained by http://www.jsonrpc.org/. OpenDaylight uses the
-YANG-modelled JSON-RPC 2.0 specification as described in the IETF DRAFT:
-https://tools.ietf.org/html/draft-yang-json-rpc-03
+specification maintained by `JSON RPC <http://www.jsonrpc.org/>`_. OpenDaylight uses the
+YANG-modelled JSON-RPC 2.0 specification as described in the `IETF DRAFT
+<https://tools.ietf.org/html/draft-yang-json-rpc-03>`_.
 
 Behavior Changes
 ================
@@ -25,13 +25,13 @@ New and Modified Features
    * - **Key**
      - **Summary**
 
-   * - JSONRPC-37
+   * - `JSONRPC-37 <https://jira.opendaylight.org/browse/JSONRPC-37>`_
      - Add support for both positional and named arguments in RPCs
 
 Deprecated Features
 ===================
 
-This releases does not deprecate any existing features.
+This release does not deprecate any existing features.
 
 Resolved Issues
 ===============
@@ -45,10 +45,10 @@ The following table lists the resolved issues fixed this release.
    * - **Key**
      - **Summary**
 
-   * - JSONRPC-36
-     - Incorrect deserialization of NULL value
+   * - `JSONRPC-36 <https://jira.opendaylight.org/browse/JSONRPC-36>`_
+     - Incorrect deserialization of NULL value.
 
 Known Issues
 ============
 
-No known issues were identified in this release.
\ No newline at end of file
+There are no known issues identified in this release.
index b9ec27d3cabb24c0077979c7f28697292ddcd41e..1cd6094dc97e9d8cfc1f54e95ba3348b1092b24f 100644 (file)
@@ -12,7 +12,7 @@ network protocols L2, L3, ACL, NAT, DHCP, IPv6 control, etc.
 Behavior Changes
 ================
 
-No behaviour change in this release.
+There are no behavior changes in this release.
 
 New and Modified Features
 =========================
@@ -38,8 +38,8 @@ Deprecated Features
 
 This release removed the following features:
 
-* COE project features
-* SFC project features
+* COE (Container Orchestration Engine) project features
+* SFC (Service Function Chaining) project features
 
 Resolved Issues
 ===============
@@ -53,44 +53,43 @@ The following table lists the resolved issues fixed this release.
    * - **Key**
      - **Summary**
 
-   * - NETVIRT-1651
+   * - `NETVIRT-1651 <https://jira.opendaylight.org/browse/NETVIRT-1651>`_
      - NetVirt patch test failing due to SFC distro check
 
-   * - NETVIRT-1662
+   * - `NETVIRT-1662 <https://jira.opendaylight.org/browse/NETVIRT-1662>`_
      - Unable to create SNAT table entry for floating IP
 
-   * - NETVIRT-1637
+   * - `NETVIRT-1637 <https://jira.opendaylight.org/browse/NETVIRT-1637>`_
      - L3VPN CSIT failure post MRI activity
 
-   * - NETVIRT-1510
+   * - `NETVIRT-1510 <https://jira.opendaylight.org/browse/NETVIRT-1510>`_
      - Get rid of 'synchronized (String.intern())'
 
-   * - NETVIRT-1641
+   * - `NETVIRT-1641 <https://jira.opendaylight.org/browse/NETVIRT-1641>`_
      - neutronvpn:networkMaps update failed when add the second subnet under network
 
-   * - NETVIRT-1406
+   * - `NETVIRT-1406 <https://jira.opendaylight.org/browse/NETVIRT-1406>`_
      - Few datastores and dump-groups not removed
 
-   * - NETVIRT-1470
+   * - `NETVIRT-1470 <https://jira.opendaylight.org/browse/NETVIRT-1470>`_
      - VMs did not get ipv6 address via SLAAC after VM evacuation
 
-   * - NETVIRT-1109
+   * - `NETVIRT-1109 <https://jira.opendaylight.org/browse/NETVIRT-1109>`_
      - VPN OperDS entry still not updated, if neutron port was deleted
 
-   * - NETVIRT-1667
+   * - `NETVIRT-1667 <https://jira.opendaylight.org/browse/NETVIRT-1667>`_
      - VNF route did not appear in fib/flows due to interface manager did not update the parentref
 
-   * - NETVIRT-1665
+   * - `NETVIRT-1665 <https://jira.opendaylight.org/browse/NETVIRT-1665>`_
      - Exception from NAT service on release the ID from IDManager
 
-   * - NETVIRT-1028
+   * - `NETVIRT-1028 <https://jira.opendaylight.org/browse/NETVIRT-1028>`_
      - Fix unrelated types for equals in HwvtepPhysicalSwitchListener
 
-   * - NETVIRT-1620
-     - Update qos for port failed
-
+   * - `NETVIRT-1620 <https://jira.opendaylight.org/browse/NETVIRT-1620>`_
+     - Update QOS for port failed
 
 Known Issues
 ============
 
-No Known issues in this release.
\ No newline at end of file
+There are no known issues in this release.
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.