X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=d3c21761a50b5d1528abb844f8556a6f943f289c;hb=ef0ddfc3e80ad3c2d7fdd884f83c739bf3a80734;hp=ff8a988679b153c7cff917d1861be6a9d7439404;hpb=03459a08895ecc7e481fc5ec34779556268992f1;p=cps.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index ff8a98867..d3c21761a 100755 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,33 +5,224 @@ .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING .. _release_notes: - - -================= CPS Release Notes -================= +################# .. contents:: :depth: 2 .. +.. ==================== +.. * * * KOHN * * * +.. ==================== + +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** | (yet to release) | +| | | ++--------------------------------------+--------------------------------------------------------+ + +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.0-SNAPSHOT -======================= +Version: 3.0.1 +============== -This section lists the main changes & fixes merged into master (snapshot) version of CPS-NCMP. This information is here to assist developers that want experiment/test using our latest code bases directly. Stability of this is not guaranteed. +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 +============== + +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 @@ -43,15 +234,22 @@ Bug Fixes - `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* -None +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. + +The Absolute path to list with integer key will not work. Please refer `CPS-961 `_ +for more information. *Known Vulnerabilities* @@ -59,7 +257,8 @@ None *Workarounds* -None +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 --------------