X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=d40cd499d811ded3b97872bbcbd029f59f34ecde;hb=f8e980af77800b819671310e0c55592b432285a9;hp=2fea4a21f1e361bd94cc94a5a34232b6cc8bf0e5;hpb=a0bbcfd8de94bb433e787b1a6ee400c988975850;p=cps.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 2fea4a21f..d40cd499d 100755 --- 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-2022 Nordix Foundation +.. Copyright (C) 2021-2023 Nordix Foundation .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _release_notes: @@ -12,10 +12,327 @@ CPS Release Notes :depth: 2 .. +.. ====================== +.. * * * LONDON * * * +.. ====================== + +Version: 3.2.2 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.2.2 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.2.2 London | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | Not been released yet | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + -None + +Version: 3.2.1 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.2.1 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.2.1 London | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2023 January 27 | +| | | ++--------------------------------------+--------------------------------------------------------+ +Features +-------- +3.2.1 + - `CPS-341 `_ Added support for multiple data tree instances under 1 anchor. + - `CPS-1002 `_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths + - `CPS-1182 `_ Upgrade Opendaylight + - `CPS-1185 `_ Get all dataspaces. + - `CPS-1186 `_ Get single dataspace. + - `CPS-1187 `_ Added API to get all schema sets for a given dataspace. + - `CPS-1236 `_ DMI audit support for NCMP: Filter on any properties of CM Handles + - `CPS-1257 `_ Added support for application/xml Content-Type (write only). + - `CPS-1381 `_ Query large outputs using limit/depth/pagination + - `CPS-1421 `_ Optimized query for large number of hits with descendants. + - `CPS-1422 `_ Fetch CM handles by collection of xpaths (CPS Core) + - `CPS-1424 `_ Updating CmHandleStates using batch operation + - `CPS-1439 `_ Use native query to delete data nodes + +Bug Fixes +--------- +3.2.1 + - `CPS-1171 `_ Optimized retrieval of data nodes with many descendants. + - `CPS-1288 `_ Hazelcast TTL for IMap is not working + - `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-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. + - `CPS-1442 `_ CPS PATCH operation does not merge existing data + - `CPS-1446 `_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery + - `CPS-1457 `_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths + - `CPS-1458 `_ CpsDataPersistenceService#getDataNodes does not handle root xpath + - `CPS-1460 `_ CPS Path Processing Performance Test duration is too low + +3.2.0 + - `CPS-1312 `_ CPS(/NCMP) does not have version control. + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16. +This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn. + +.. ==================== +.. * * * KOHN * * * +.. ==================== + +Version: 3.1.4 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.1.4 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.1.4 Kohn | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 October 5 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + - `CPS-1265 `_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity + - `CPS-1294 `_ Kafka communication fault caused cmHandle registration error + +Version: 3.1.3 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.1.3 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.1.3 Kohn | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 September 29 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + - None + +Version: 3.1.2 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.1.2 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.1.2 Kohn | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 September 28 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + - None + +Version: 3.1.1 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.1.1 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.1.1 Kohn | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 September 28 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + - None + +Security Notes +-------------- + +*Fixed Security Issues* + + - `CPS-1226 `_ Security bug in the logs + +Version: 3.1.0 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.1.0 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.1.0 Kohn | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 September 14 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Features +-------- + - `CPS-340 `_ Patch and update the root data node + - `CPS-575 `_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.) + - `CPS-731 `_ Query based on Public CM Properties + - `CPS-828 `_ Async: NCMP Rest impl. including Request ID generation + - `CPS-829 `_ Async: Internal message topic incl. basic producer & Consumer + - `CPS-830 `_ DMI-NCMP Asynchronously Publish Response Event to Client Topic + - `CPS-869 `_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072 + - `CPS-870 `_ Align CPS-Core output with SDN-C output (add module name) + - `CPS-875 `_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles + - `CPS-877 `_ CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY' + - `CPS-899 `_ Start and stop sessions on Java API + - `CPS-909 `_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state + - `CPS-917 `_ Structured Errors response for passthrough use-cases in NCMP + - `CPS-953 `_ Update maven deploy plugin version + - `CPS-977 `_ Query CM Handles using CpsPath + - `CPS-1000 `_ Create Data Synchronization watchdog + - `CPS-1016 `_ Merge 2 'query' end points in NCMP + - `CPS-1034 `_ Publish lifecycle events for ADVISED , READY and LOCKED state transition" + - `CPS-1064 `_ Support retrieval of YANG module sources for CM handle on the NCMP interface + - `CPS-1099 `_ Expose simplified 'external' lock reason enum state over REST interface + - `CPS-1101 `_ Introducing the DELETING and DELETED Cmhandle State + - `CPS-1102 `_ Register the Cmhandle Sends Advised State notification. + - `CPS-1133 `_ Enable/Disable Data Sync for Cm Handle + - `CPS-1136 `_ DMI Audit Support (get all CM Handles for a registered DMI) + + +Bug Fixes +--------- + - `CPS-896 `_ CM Handle Registration Process only partially completes when exception is thrown + - `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-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 + - `CPS-1126 `_ CmHandle creation performance degradation + - `CPS-1175 `_ Incorrect response when empty body executed for cmhandle id-searches + - `CPS-1179 `_ Node API - GET method returns invalid response when identifier contains '/' + - `CPS-1212 `_ Additional Properties for CM Handles not included when send to DMI Plugin + - `CPS-1217 `_ Searches endpoint gives back empty list however there are already available cmhandles + - `CPS-1218 `_ NCMP logs are flooded with SyncUtils logs + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition. +Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces'] + +*Known Vulnerabilities* + +None + +*Workarounds* + +None + +Security Notes +-------------- + +*Fixed Security Issues* + + - `CPS-963 `_ Liquibase has got serious vulnerability, upgrade required + +*Known Security Issues* + +None + .. ======================== .. * * * JAKARTA * * * .. ======================== +Version: 3.0.1 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.0.1 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.0.1 Jakarta | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 April 28 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + - `CPS-961 `_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version + Version: 3.0.0 ==============