X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=c2e2a5fdcd860388d03ba61b3add77b506efc17b;hb=a1129b696f3197fc7d8a3b63bcd84b5b2dd8874e;hp=8d8bbe33350022a799251596eb3d7ff43ec9f5c1;hpb=a4d48e1de86829240e6ddd13c6cb37dea3df8cfc;p=cps.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 8d8bbe333..c2e2a5fdc 100755 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,24 +1,369 @@ .. 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 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _release_notes: - - -================= CPS Release Notes -================= +################# .. contents:: :depth: 2 .. +.. ======================== +.. * * * JAKARTA * * * +.. ======================== + +Version: 3.0.0 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:3.0.0 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 3.0.0 Jakarta | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 March 15 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Features +-------- + - `CPS-559 `_ Define response objects (schemas) in cps-ncmp + - `CPS-636 `_ Update operation for datastore pass through running + - `CPS-638 `_ Delete operation for datastore pass through running + - `CPS-677 `_ Support 'public' Cm Handle Properties + - `CPS-741 `_ Re sync after removing cm handles + - `CPS-777 `_ Ensure all DMI operations use POST method + - `CPS-780 `_ Add examples for parameters, request and response in openapi yaml for cps-core + - `CPS-789 `_ CPS Data Updated Event Schema V2 to support delete operation + - `CPS-791 `_ CPS-Core sends delete notification event + - `CPS-817 `_ Create Endpoint For Get Cm Handles (incl. public properties) By Name + - `CPS-837 `_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update + +Bug Fixes +--------- + + - `CPS-762 `_ Query cm handles for module names returns incorrect cm handle identifiers + - `CPS-788 `_ Yang Resource formatting is incorrect + - `CPS-783 `_ Remove cm handle does not completely remove all cm handle information + - `CPS-841 `_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM + - `CPS-856 `_ Retry mechanism not working for concurrent CmHandle registration + - `CPS-867 `_ Database port made configurable through env variable DB_PORT + - `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 + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of +`CPS-837 `_ null is now used to indicate if a property should be removed as part +of cm handle registration. + +*Known Vulnerabilities* + +None + +*Workarounds* + +Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or +pass an empty string as the value if you do not want to include names for these values. + +Security Notes +-------------- + +*Fixed Security Issues* + +None + +*Known Security Issues* + +None + +.. ======================== +.. * * * ISTANBUL * * * +.. ======================== + +Version: 2.0.4 +============== +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:2.0.4 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 2.0.4 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022 Feb 09 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + + - `CPS-879 `_ Fix docker compose for csit test. + - `CPS-873 `_ Fix intermittent circular dependency error when the application starts. + +Version: 2.0.3 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:2.0.3 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 2.0.3 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2022-07-01 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + + - `CPS-841 `_ Update log4j version to 2.17.1 due to security vulnerability + +Version: 2.0.2 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:2.0.2 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 2.0.2 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2021-16-12 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + + - `CPS-820 `_ Update log4j version due to security vulnerability + +Version: 2.0.1 +============== + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:2.0.1 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 2.0.1 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2021-14-10 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Bug Fixes +--------- + + - `CPS-594 `_ SQL ConstraintViolationException when updating the list node element using PATCH List node API + - `CPS-653 `_ cmHandleProperties not supported by dmi in fetch modules + - `CPS-673 `_ Improvement and cleanup for CPS Core charts + - `CPS-691 `_ NCMP no master index label on index documentation page + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3. + +*Known Vulnerabilities* + + - `CPS-725 `_ fix sample docker compose of cps/ncmp and onap dmi plugin + +*Workarounds* + +Add recursive method to save list node data to loop through all corresponding child nodes. + +Security Notes +-------------- + +*Fixed Security Issues* + + - `CPS-581 `_ Remove security vulnerabilities + +*Known Security Issues* + +None + +Version: 2.0.0 +============== + +Abstract +-------- + +This document provides the release notes for Istanbul release. + +Release Data +------------ + ++--------------------------------------+--------------------------------------------------------+ +| **CPS Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** | onap/cps-and-ncmp:2.0.0 | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 2.0.0 Istanbul | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2021-14-09 | +| | | ++--------------------------------------+--------------------------------------------------------+ + +Features +-------- +* Register DMI-Plugins with NCMP for CM Handle registrations. +* Update, Create and Remove CM Handles. +* Add support for retrieving and writing CM Handle data through NCMP datastores. +* Automatic retrieval and caching of model information for CM Handles within NCMP. + +Deliverables +------------ + +Software Deliverables + +.. csv-table:: + :header: "Repository", "SubModules", "Version & Docker Image (if applicable)" + :widths: auto + + "cps", "", "onap/cps-and-ncmp-proxy:2.0.0" + +Bug Fixes +--------- + + - `CPS-310 `_ Data schema migration from Honolulu to Istanbul is failing + - `CPS-316 `_ Xpath cannot be created for augmentation data node + - `CPS-336 `_ Ends-with functionality in cpsPath does not conform with standard xPath behavior + - `CPS-345 `_ Leaf String value comparison matches mix of single and double quotes + - `CPS-357 `_ cps-review-verification-maven-master Jenkins job is failing when running csit test + - `CPS-367 `_ Get descendent does not support xpaths that end in list values + - `CPS-377 `_ Init ran model validation is failing error details are not provided + - `CPS-422 `_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types + - `CPS-450 `_ Datanode query using full path to node causes NPE + - `CPS-451 `_ cps-ran-schema-model@2021-01-28.yang missing root container + - `CPS-464 `_ Request to update node leaves (patch) responds with Internal Server Error + - `CPS-465 `_ Request to update node leaves (patch) responds with json parsing failure + - `CPS-466 `_ Concurrent requests to create schema sets for the same yang model are not supported + - `CPS-479 `_ Get Nodes API does not always return the object from the root + - `CPS-500 `_ Special Character Limitations of cpsPath Queries + - `CPS-501 `_ Put DataNode API has missing transaction and error handling for concurrency issues + - `CPS-524 `_ Issue with CPSData API to add an item to an existing list node + - `CPS-560 `_ Response from cps query using text() contains escape characters + - `CPS-566 `_ Can't access grandparent node through ancestor axis + - `CPS-573 `_ /v1/ch/PNFDemo1/modules returning 401 unauthorised. + - `CPS-587 `_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties + - `CPS-591 `_ CPS-Core Leaf stored as integer is being returned from DB as float + - `CPS-601 `_ CPS swagger-ui does not show NCMP endpoints + - `CPS-616 `_ NCMP base path does not conform to agreed API URL + - `CPS-630 `_ Incorrect information sent when same anchor is updated faster than notification service processes + - `CPS-635 `_ Module Resource call does not include body + +This document provides the release notes for Istanbul release. + +Summary +------- + +Following CPS components are available with default ONAP/CPS installation. + + + * Platform components + + - CPS (Helm charts) + + * Service components + + - CPS-NCMP + - CPS-Temporal + - DMI-Plugin + + * Additional resources that CPS utilizes deployed using ONAP common charts + + - Postgres Database + + +Below service components (mS) are available to be deployed on-demand. + - CPS-TBDMT + + +Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. + +Known Limitations, Issues and Workarounds +----------------------------------------- + +*System Limitations* + +Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3. + +*Known Vulnerabilities* + + - `CPS-594 `_ SQL ConstraintViolationException when updating the list node element using PATCH List node API + - `CPS-653 `_ cmHandleProperties not supported by dmi in fetch modules + - `CPS-673 `_ Improvement and cleanup for CPS Core charts + +*Workarounds* + +Add recursive method to save list node data to loop through all corresponding child nodes. + +Security Notes +-------------- + +*Fixed Security Issues* + + - `CPS-249 `_ Exception stack trace is exposed + +*Known Security Issues* + + - `CPS-581 `_ Remove security vulnerabilities + +Test Results +------------ + * `Integration tests` -.. ========================= -.. * * * HONOULULU * * * -.. ========================= +.. ======================== +.. * * * HONOLULU * * * +.. ======================== Version: 1.0.1 ============== @@ -43,6 +388,7 @@ Release Data Bug Fixes --------- + - `CPS-706 `_ Get moduleschema/yangresouce endpoint not working - `CPS-276 `_ Improve error reporting for invalid cpsPath on Queries - `CPS-288 `_ Move security configuration to the application module - `CPS-290 `_ Internal Server Error when creating the same data node twice