X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=e79a188ef521cc9d0a8c880d9a3c61cde2ee9227;hb=8e6218198950381dff5b028ac6760238f91755f9;hp=013617a815cc5bcfcc08a54066dfde61040c867c;hpb=e8a7c4aac83b05ef3d19bf78174ee5f68e0c9c3e;p=cps.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst old mode 100755 new mode 100644 index 013617a81..e79a188ef --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright (C) 2021-2023 Nordix Foundation +.. Copyright (C) 2021-2024 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _release_notes: @@ -12,10 +12,347 @@ CPS Release Notes :depth: 2 .. +.. ========================= +.. * * * NEW DELHI * * * +.. ========================= + +Version: 3.4.7 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.7 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.7 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | Not yet released | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.7 + +Features +-------- + +Version: 3.4.6 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.6 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.6 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2024 February 29 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.6 + - `CPS-2126 `_ Passing HTTP Authorization Bearer Token to DMI Plugins. + + +Features +-------- + - `CPS-2133 `_ Revert Uplift of Spring Boot version from 3.2.2 to 3.1.2 + +Notes +----- +This release brings improvements to compatibility with Service Mesh and for that below measures are been taken. + +Basic authorization provided using Spring security is been removed from CPS-Core and NCMP and hence authorization is no longer enforced.(basic auth header will be ignored, but is still allowed). +NCMP will propagate a bearer token to DMI conditionally. +401 Unauthorized will not be returned. Best effort has been made to ensure backwards compatibility. + +Version: 3.4.5 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.5 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.5 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2024 February 27 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.5 + + +Features +-------- + - `CPS-2101 `_ Uplift Spring Boot version to 3.2.2 + + +Version: 3.4.4 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.4 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.4 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2024 February 23 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.4 + - `CPS-2027 `_ Upgrade Yang modules using module set tag functionalities fix + +Features +-------- + - `CPS-2057 `_ Leaf lists are sorted by default if Yang model does not specify order. + - `CPS-2087 `_ Performance improvement of CPS Path Queries. + + +Version: 3.4.3 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.3 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.3 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2024 February 07 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.3 + - `CPS-2000 `_ Fix for Schema object cache not being distributed. + - `CPS-2027 `_ Fixes for upgrade yang modules using module set tag. + - `CPS-2070 `_ Add retry interval for Kafka consumer. + +Features +-------- + - `CPS-1824 `_ CPS Delta between 2 anchors. + - `CPS-2072 `_ Add maven classifier to Spring Boot JAR. + - `CPS-1135 `_ Extend CPS Module API to allow retrieval single module definition. + +Notes +----- +The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a +*-springboot* classifier (`CPS-2072 `_). This means that the filename +of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*. + +Version: 3.4.2 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.2 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.2 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2024 January 11 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.2 + + +Features +-------- + - `CPS-1638 `_ Introduce trust level for CM handle. + - `CPS-1795 `_ Double performance of CPS write operations (via write batching) + - `CPS-2018 `_ Improve performance of CPS update operations. + - `CPS-2019 `_ Improve performance of saving CM handles. + +Notes +----- + - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019. + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching +(`CPS-1795 `_), a change to the database entity ID generation is required. +As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and +NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently. +Other operations (read, update, delete) are not impacted. + + +Version: 3.4.1 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.1 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.1 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2023 December 20 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.1 + - `CPS-1979 `_ Bug fix for Invalid topic name suffix. + +Features +-------- + - CPS-Temporal is no longer supported and any related documentation has been removed. + - `CPS-1733 `_ Upgrade YANG schema-set for CM handle without removing and adding it. + - `CPS-1980 `_ Exposing health and cluster metrics for hazelcast. + - `CPS-1994 `_ Use Apache Http Client for DMI REST requests. + - `CPS-2005 `_ Removing notification feature for cps updated events ( exclusively used by cps-temporal ) + +Known Issues +------------ + - `CPS-2000 `_ Schema object cache is not distributed. + + +Version: 3.4.0 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.4.0 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.4.0 New Delhi | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2023 November 09 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.4.0 + - `CPS-1956 `_ Bug fix for No yang resources stored during cmhandle discovery. + .. ======================== .. * * * MONTREAL * * * .. ======================== +Version: 3.3.9 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.3.9 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.3.9 Montreal | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2023 November 06 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.3.9 + - `CPS-1923 `_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port. + - `CPS-1933 `_ Setting up the class loader explicitly in hazelcast config. + +Features +-------- + +Version: 3.3.8 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.3.8 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.3.8 Montreal | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2023 September 29 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- +3.3.8 + +Features +-------- + - `CPS-1888 `_ Uplift Spring Boot to 3.1.2. + Version: 3.3.7 ============== @@ -32,16 +369,22 @@ Release Data | **Release designation** | 3.3.7 Montreal | | | | +--------------------------------------+--------------------------------------------------------+ -| **Release date** | Not yet released | +| **Release date** | 2023 September 20 | | | | +--------------------------------------+--------------------------------------------------------+ Bug Fixes --------- 3.3.7 + - `CPS-1866 `_ Fix ClassDefNotFoundError in opendaylight Yang parser Features -------- + - `CPS-1789 `_ CPS Upgrade to Springboot 3.0. + +Note +---- +Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7. Version: 3.3.6 ============== @@ -454,7 +797,7 @@ Bug Fixes - `CPS-1289 `_ Getting wrong error code for create node api - `CPS-1326 `_ Creation of DataNodeBuilder with module name prefix is very slow - `CPS-1344 `_ Top level container (prefix) is not always the first module - - `CPS-1350 `_ Add Basic Auth to CPS/NCMP OpenAPI Definitions. + - `CPS-1350 `_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions. - `CPS-1352 `_ Handle YangChoiceNode in right format. - `CPS-1409 `_ Fix Delete uses case with '/' in path. - `CPS-1433 `_ Fix to allow posting data with '/' key fields. @@ -640,7 +983,7 @@ Bug Fixes - `CPS-957 `_ NCMP: fix getResourceDataForPassthroughOperational endpoint - `CPS-1020 `_ DuplicatedYangResourceException error at parallel cmHandle registration - `CPS-1056 `_ Wrong error response format in case of Dmi plugin error - - `CPS-1067 `_ NCMP returns 500 error on searches endpoint when No DMi Handles registered + - `CPS-1067 `_ NCMP returns 500 error on searches endpoint when No DMI Handles registered - `CPS-1085 `_ Performance degradation on ncmp/v1/ch/searches endpoint - `CPS-1088 `_ Kafka consumer can not be turned off - `CPS-1097 `_ Unable to change state from LOCKED to ADVISED @@ -752,7 +1095,7 @@ Bug Fixes - `CPS-886 `_ Fragment handling decreasing performance for large number of cmHandles - `CPS-887 `_ Increase performance of cmHandle registration for large number of schema sets in DB - `CPS-892 `_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT - - `CPS-893 `_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API + - `CPS-893 `_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API Known Limitations, Issues and Workarounds ----------------------------------------- @@ -1008,7 +1351,6 @@ Following CPS components are available with default ONAP/CPS installation. * Service components - CPS-NCMP - - CPS-Temporal - DMI-Plugin * Additional resources that CPS utilizes deployed using ONAP common charts @@ -1207,7 +1549,7 @@ Security Notes *Known Security Issues* - * Weak Crytography using md5 + * Weak Cryptography using md5 * Risk seen in Zip file expansion *Known Vulnerabilities in Used Modules*