1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2021-2023 Nordix Foundation
5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
15 .. =========================
16 .. * * * NEW DELHI * * *
17 .. =========================
25 +--------------------------------------+--------------------------------------------------------+
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images** | onap/cps-and-ncmp:3.4.2 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.4.2 New Delhi |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | Not yet released |
37 +--------------------------------------+--------------------------------------------------------+
54 +--------------------------------------+--------------------------------------------------------+
57 +--------------------------------------+--------------------------------------------------------+
58 | **Docker images** | onap/cps-and-ncmp:3.4.1 |
60 +--------------------------------------+--------------------------------------------------------+
61 | **Release designation** | 3.4.1 New Delhi |
63 +--------------------------------------+--------------------------------------------------------+
64 | **Release date** | 2023 December 20 |
66 +--------------------------------------+--------------------------------------------------------+
71 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
75 - CPS-Temporal is no longer supported and any related documentation has been removed.
76 - `CPS-1733 <https://jira.onap.org/browse/CPS-1733>`_ Upgrade YANG schema-set for CM handle without removing and adding it.
77 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
78 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
79 - `CPS-2005 <https://jira.onap.org/browse/CPS-2005>`_ Removing notification feature for cps updated events ( exclusively used by cps-temporal )
83 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
92 +--------------------------------------+--------------------------------------------------------+
95 +--------------------------------------+--------------------------------------------------------+
96 | **Docker images** | onap/cps-and-ncmp:3.4.0 |
98 +--------------------------------------+--------------------------------------------------------+
99 | **Release designation** | 3.4.0 New Delhi |
101 +--------------------------------------+--------------------------------------------------------+
102 | **Release date** | 2023 November 09 |
104 +--------------------------------------+--------------------------------------------------------+
109 - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
111 .. ========================
112 .. * * * MONTREAL * * *
113 .. ========================
121 +--------------------------------------+--------------------------------------------------------+
122 | **CPS Project** | |
124 +--------------------------------------+--------------------------------------------------------+
125 | **Docker images** | onap/cps-and-ncmp:3.3.9 |
127 +--------------------------------------+--------------------------------------------------------+
128 | **Release designation** | 3.3.9 Montreal |
130 +--------------------------------------+--------------------------------------------------------+
131 | **Release date** | 2023 November 06 |
133 +--------------------------------------+--------------------------------------------------------+
138 - `CPS-1923 <https://jira.onap.org/browse/CPS-1923>`_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port.
139 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
150 +--------------------------------------+--------------------------------------------------------+
151 | **CPS Project** | |
153 +--------------------------------------+--------------------------------------------------------+
154 | **Docker images** | onap/cps-and-ncmp:3.3.8 |
156 +--------------------------------------+--------------------------------------------------------+
157 | **Release designation** | 3.3.8 Montreal |
159 +--------------------------------------+--------------------------------------------------------+
160 | **Release date** | 2023 September 29 |
162 +--------------------------------------+--------------------------------------------------------+
170 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
178 +--------------------------------------+--------------------------------------------------------+
179 | **CPS Project** | |
181 +--------------------------------------+--------------------------------------------------------+
182 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
184 +--------------------------------------+--------------------------------------------------------+
185 | **Release designation** | 3.3.7 Montreal |
187 +--------------------------------------+--------------------------------------------------------+
188 | **Release date** | 2023 September 20 |
190 +--------------------------------------+--------------------------------------------------------+
195 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
199 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
203 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
211 +--------------------------------------+--------------------------------------------------------+
212 | **CPS Project** | |
214 +--------------------------------------+--------------------------------------------------------+
215 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
217 +--------------------------------------+--------------------------------------------------------+
218 | **Release designation** | 3.3.6 Montreal |
220 +--------------------------------------+--------------------------------------------------------+
221 | **Release date** | 2023 August 23 |
223 +--------------------------------------+--------------------------------------------------------+
228 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
229 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
233 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
234 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
243 +--------------------------------------+--------------------------------------------------------+
244 | **CPS Project** | |
246 +--------------------------------------+--------------------------------------------------------+
247 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
249 +--------------------------------------+--------------------------------------------------------+
250 | **Release designation** | 3.3.5 Montreal |
252 +--------------------------------------+--------------------------------------------------------+
253 | **Release date** | 2023 July 21 |
255 +--------------------------------------+--------------------------------------------------------+
263 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
271 +--------------------------------------+--------------------------------------------------------+
272 | **CPS Project** | |
274 +--------------------------------------+--------------------------------------------------------+
275 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
277 +--------------------------------------+--------------------------------------------------------+
278 | **Release designation** | 3.3.4 Montreal |
280 +--------------------------------------+--------------------------------------------------------+
281 | **Release date** | 2023 July 19 |
283 +--------------------------------------+--------------------------------------------------------+
291 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
299 +--------------------------------------+--------------------------------------------------------+
300 | **CPS Project** | |
302 +--------------------------------------+--------------------------------------------------------+
303 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
305 +--------------------------------------+--------------------------------------------------------+
306 | **Release designation** | 3.3.3 Montreal |
308 +--------------------------------------+--------------------------------------------------------+
309 | **Release date** | 2023 June 30 |
311 +--------------------------------------+--------------------------------------------------------+
319 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
320 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
321 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
329 +--------------------------------------+--------------------------------------------------------+
330 | **CPS Project** | |
332 +--------------------------------------+--------------------------------------------------------+
333 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
335 +--------------------------------------+--------------------------------------------------------+
336 | **Release designation** | 3.3.2 Montreal |
338 +--------------------------------------+--------------------------------------------------------+
339 | **Release date** | 2023 June 15 |
341 +--------------------------------------+--------------------------------------------------------+
346 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
350 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
351 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
352 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
353 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
354 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
362 +--------------------------------------+--------------------------------------------------------+
363 | **CPS Project** | |
365 +--------------------------------------+--------------------------------------------------------+
366 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
368 +--------------------------------------+--------------------------------------------------------+
369 | **Release designation** | 3.3.1 Montreal |
371 +--------------------------------------+--------------------------------------------------------+
372 | **Release date** | 2023 May 03 |
374 +--------------------------------------+--------------------------------------------------------+
383 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
384 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
385 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
386 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
387 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
395 +--------------------------------------+--------------------------------------------------------+
396 | **CPS Project** | |
398 +--------------------------------------+--------------------------------------------------------+
399 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
401 +--------------------------------------+--------------------------------------------------------+
402 | **Release designation** | 3.3.0 Montreal |
404 +--------------------------------------+--------------------------------------------------------+
405 | **Release date** | 2023 April 20 |
407 +--------------------------------------+--------------------------------------------------------+
416 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
417 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
419 .. ======================
420 .. * * * LONDON * * *
421 .. ======================
429 +--------------------------------------+--------------------------------------------------------+
430 | **CPS Project** | |
432 +--------------------------------------+--------------------------------------------------------+
433 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
435 +--------------------------------------+--------------------------------------------------------+
436 | **Release designation** | 3.2.6 London |
438 +--------------------------------------+--------------------------------------------------------+
439 | **Release date** | 2023 March 22 |
441 +--------------------------------------+--------------------------------------------------------+
446 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
447 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
451 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
459 +--------------------------------------+--------------------------------------------------------+
460 | **CPS Project** | |
462 +--------------------------------------+--------------------------------------------------------+
463 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
465 +--------------------------------------+--------------------------------------------------------+
466 | **Release designation** | 3.2.5 London |
468 +--------------------------------------+--------------------------------------------------------+
469 | **Release date** | 2023 March 10 |
471 +--------------------------------------+--------------------------------------------------------+
476 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
488 +--------------------------------------+--------------------------------------------------------+
489 | **CPS Project** | |
491 +--------------------------------------+--------------------------------------------------------+
492 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
494 +--------------------------------------+--------------------------------------------------------+
495 | **Release designation** | 3.2.4 London |
497 +--------------------------------------+--------------------------------------------------------+
498 | **Release date** | 2023 March 09 |
500 +--------------------------------------+--------------------------------------------------------+
505 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
506 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
518 +--------------------------------------+--------------------------------------------------------+
519 | **CPS Project** | |
521 +--------------------------------------+--------------------------------------------------------+
522 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
524 +--------------------------------------+--------------------------------------------------------+
525 | **Release designation** | 3.2.3 London |
527 +--------------------------------------+--------------------------------------------------------+
528 | **Release date** | 2023 March 07 |
530 +--------------------------------------+--------------------------------------------------------+
535 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
539 - `CPS-1401 <https://jira.onap.org/browse/CPS-1401>`_ Added V2 of Get Data Node API,support to retrieve all data nodes under an anchor
540 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
548 +--------------------------------------+--------------------------------------------------------+
549 | **CPS Project** | |
551 +--------------------------------------+--------------------------------------------------------+
552 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
554 +--------------------------------------+--------------------------------------------------------+
555 | **Release designation** | 3.2.2 London |
557 +--------------------------------------+--------------------------------------------------------+
558 | **Release date** | 2023 February 08 |
560 +--------------------------------------+--------------------------------------------------------+
565 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
577 +--------------------------------------+--------------------------------------------------------+
578 | **CPS Project** | |
580 +--------------------------------------+--------------------------------------------------------+
581 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
583 +--------------------------------------+--------------------------------------------------------+
584 | **Release designation** | 3.2.1 London |
586 +--------------------------------------+--------------------------------------------------------+
587 | **Release date** | 2023 January 27 |
589 +--------------------------------------+--------------------------------------------------------+
594 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
595 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
596 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
597 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
598 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
599 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
600 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
601 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
602 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
603 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
604 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
605 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
606 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
611 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
612 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
613 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
614 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
615 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
616 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
617 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
618 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
619 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
620 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
621 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
622 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
623 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
624 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
627 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
629 Known Limitations, Issues and Workarounds
630 -----------------------------------------
634 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
635 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.
637 CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
638 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
640 .. ====================
642 .. ====================
650 +--------------------------------------+--------------------------------------------------------+
651 | **CPS Project** | |
653 +--------------------------------------+--------------------------------------------------------+
654 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
656 +--------------------------------------+--------------------------------------------------------+
657 | **Release designation** | 3.1.4 Kohn |
659 +--------------------------------------+--------------------------------------------------------+
660 | **Release date** | 2022 October 5 |
662 +--------------------------------------+--------------------------------------------------------+
666 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
667 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
675 +--------------------------------------+--------------------------------------------------------+
676 | **CPS Project** | |
678 +--------------------------------------+--------------------------------------------------------+
679 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
681 +--------------------------------------+--------------------------------------------------------+
682 | **Release designation** | 3.1.3 Kohn |
684 +--------------------------------------+--------------------------------------------------------+
685 | **Release date** | 2022 September 29 |
687 +--------------------------------------+--------------------------------------------------------+
699 +--------------------------------------+--------------------------------------------------------+
700 | **CPS Project** | |
702 +--------------------------------------+--------------------------------------------------------+
703 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
705 +--------------------------------------+--------------------------------------------------------+
706 | **Release designation** | 3.1.2 Kohn |
708 +--------------------------------------+--------------------------------------------------------+
709 | **Release date** | 2022 September 28 |
711 +--------------------------------------+--------------------------------------------------------+
723 +--------------------------------------+--------------------------------------------------------+
724 | **CPS Project** | |
726 +--------------------------------------+--------------------------------------------------------+
727 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
729 +--------------------------------------+--------------------------------------------------------+
730 | **Release designation** | 3.1.1 Kohn |
732 +--------------------------------------+--------------------------------------------------------+
733 | **Release date** | 2022 September 28 |
735 +--------------------------------------+--------------------------------------------------------+
744 *Fixed Security Issues*
746 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
754 +--------------------------------------+--------------------------------------------------------+
755 | **CPS Project** | |
757 +--------------------------------------+--------------------------------------------------------+
758 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
760 +--------------------------------------+--------------------------------------------------------+
761 | **Release designation** | 3.1.0 Kohn |
763 +--------------------------------------+--------------------------------------------------------+
764 | **Release date** | 2022 September 14 |
766 +--------------------------------------+--------------------------------------------------------+
770 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
771 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
772 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
773 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
774 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
775 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
776 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
777 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
778 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
779 - `CPS-877 <https://jira.onap.org/browse/CPS-877>`_ CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY'
780 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
781 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
782 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
783 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
784 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
785 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
786 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
787 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
788 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
789 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
790 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
791 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
792 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
793 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
798 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
799 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
800 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
801 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
802 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMI Handles registered
803 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
804 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
805 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
806 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
807 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
808 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
809 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
810 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
811 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
813 Known Limitations, Issues and Workarounds
814 -----------------------------------------
818 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
819 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
821 *Known Vulnerabilities*
832 *Fixed Security Issues*
834 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
836 *Known Security Issues*
840 .. ========================
841 .. * * * JAKARTA * * *
842 .. ========================
850 +--------------------------------------+--------------------------------------------------------+
851 | **CPS Project** | |
853 +--------------------------------------+--------------------------------------------------------+
854 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
856 +--------------------------------------+--------------------------------------------------------+
857 | **Release designation** | 3.0.1 Jakarta |
859 +--------------------------------------+--------------------------------------------------------+
860 | **Release date** | 2022 April 28 |
862 +--------------------------------------+--------------------------------------------------------+
866 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
874 +--------------------------------------+--------------------------------------------------------+
875 | **CPS Project** | |
877 +--------------------------------------+--------------------------------------------------------+
878 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
880 +--------------------------------------+--------------------------------------------------------+
881 | **Release designation** | 3.0.0 Jakarta |
883 +--------------------------------------+--------------------------------------------------------+
884 | **Release date** | 2022 March 15 |
886 +--------------------------------------+--------------------------------------------------------+
890 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
891 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
892 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
893 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
894 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
895 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
896 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
897 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
898 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
899 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
900 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
905 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
906 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
907 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
908 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
909 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
910 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
911 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
912 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
913 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
914 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
916 Known Limitations, Issues and Workarounds
917 -----------------------------------------
921 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
922 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
923 of cm handle registration.
925 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
926 for more information.
928 *Known Vulnerabilities*
934 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
935 pass an empty string as the value if you do not want to include names for these values.
940 *Fixed Security Issues*
944 *Known Security Issues*
948 .. ========================
949 .. * * * ISTANBUL * * *
950 .. ========================
958 +--------------------------------------+--------------------------------------------------------+
959 | **CPS Project** | |
961 +--------------------------------------+--------------------------------------------------------+
962 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
964 +--------------------------------------+--------------------------------------------------------+
965 | **Release designation** | 2.0.4 Istanbul |
967 +--------------------------------------+--------------------------------------------------------+
968 | **Release date** | 2022 Feb 09 |
970 +--------------------------------------+--------------------------------------------------------+
975 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
976 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
984 +--------------------------------------+--------------------------------------------------------+
985 | **CPS Project** | |
987 +--------------------------------------+--------------------------------------------------------+
988 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
990 +--------------------------------------+--------------------------------------------------------+
991 | **Release designation** | 2.0.3 Istanbul |
993 +--------------------------------------+--------------------------------------------------------+
994 | **Release date** | 2022-07-01 |
996 +--------------------------------------+--------------------------------------------------------+
1001 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
1009 +--------------------------------------+--------------------------------------------------------+
1010 | **CPS Project** | |
1012 +--------------------------------------+--------------------------------------------------------+
1013 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
1015 +--------------------------------------+--------------------------------------------------------+
1016 | **Release designation** | 2.0.2 Istanbul |
1018 +--------------------------------------+--------------------------------------------------------+
1019 | **Release date** | 2021-16-12 |
1021 +--------------------------------------+--------------------------------------------------------+
1026 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
1034 +--------------------------------------+--------------------------------------------------------+
1035 | **CPS Project** | |
1037 +--------------------------------------+--------------------------------------------------------+
1038 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
1040 +--------------------------------------+--------------------------------------------------------+
1041 | **Release designation** | 2.0.1 Istanbul |
1043 +--------------------------------------+--------------------------------------------------------+
1044 | **Release date** | 2021-14-10 |
1046 +--------------------------------------+--------------------------------------------------------+
1051 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1052 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1053 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1054 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1056 Known Limitations, Issues and Workarounds
1057 -----------------------------------------
1059 *System Limitations*
1061 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1063 *Known Vulnerabilities*
1065 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1069 Add recursive method to save list node data to loop through all corresponding child nodes.
1074 *Fixed Security Issues*
1076 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1078 *Known Security Issues*
1088 This document provides the release notes for Istanbul release.
1093 +--------------------------------------+--------------------------------------------------------+
1094 | **CPS Project** | |
1096 +--------------------------------------+--------------------------------------------------------+
1097 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
1099 +--------------------------------------+--------------------------------------------------------+
1100 | **Release designation** | 2.0.0 Istanbul |
1102 +--------------------------------------+--------------------------------------------------------+
1103 | **Release date** | 2021-14-09 |
1105 +--------------------------------------+--------------------------------------------------------+
1109 * Register DMI-Plugins with NCMP for CM Handle registrations.
1110 * Update, Create and Remove CM Handles.
1111 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1112 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1117 Software Deliverables
1120 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1123 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1128 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1129 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1130 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1131 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1132 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1133 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1134 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1135 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1136 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1137 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1138 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1139 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1140 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1141 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1142 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1143 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1144 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1145 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1146 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1147 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1148 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1149 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1150 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1151 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1152 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1153 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1155 This document provides the release notes for Istanbul release.
1160 Following CPS components are available with default ONAP/CPS installation.
1163 * Platform components
1167 * Service components
1172 * Additional resources that CPS utilizes deployed using ONAP common charts
1177 Below service components (mS) are available to be deployed on-demand.
1181 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1183 Known Limitations, Issues and Workarounds
1184 -----------------------------------------
1186 *System Limitations*
1188 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1190 *Known Vulnerabilities*
1192 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1193 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1194 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1198 Add recursive method to save list node data to loop through all corresponding child nodes.
1203 *Fixed Security Issues*
1205 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1207 *Known Security Issues*
1209 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1213 * `Integration tests`
1215 .. ========================
1216 .. * * * HONOLULU * * *
1217 .. ========================
1225 +--------------------------------------+--------------------------------------------------------+
1226 | **CPS Project** | |
1228 +--------------------------------------+--------------------------------------------------------+
1229 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1231 +--------------------------------------+--------------------------------------------------------+
1232 | **Release designation** | 1.0.1 Honolulu |
1234 +--------------------------------------+--------------------------------------------------------+
1235 | **Release date** | 2021-04-09 |
1237 +--------------------------------------+--------------------------------------------------------+
1242 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1243 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1244 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1245 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1246 - `CPS-292 <https://jira.onap.org/browse/CPS-292>`_ Detailed information is missing to explain why data is not compliant with the specified YANG model
1247 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1248 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1249 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1254 *Fixed Security Issues*
1256 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1258 *Known Security Issues*
1260 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1269 This document provides the release notes for Honolulu release.
1274 Following CPS components are available with default ONAP/CPS installation.
1277 * Platform components
1281 * Service components
1285 * Additional resources that CPS utilizes deployed using ONAP common charts
1290 Below service components (mS) are available to be deployed on-demand.
1294 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1300 +--------------------------------------+--------------------------------------------------------+
1301 | **CPS Project** | |
1303 +--------------------------------------+--------------------------------------------------------+
1304 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1306 +--------------------------------------+--------------------------------------------------------+
1307 | **Release designation** | 1.0.0 Honolulu |
1309 +--------------------------------------+--------------------------------------------------------+
1310 | **Release date** | 2021-03-11 |
1312 +--------------------------------------+--------------------------------------------------------+
1317 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1318 CPS has been driven by the needs of the E2E Networking Slicing use case.
1319 It currently supports basic (rw) persistence and simple queries.
1320 It also provides MVP support for network data access using simulated data.
1322 .. _honolulu_deliverable:
1327 Software Deliverables
1330 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1333 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1336 Known Limitations, Issues and Workarounds
1337 -----------------------------------------
1339 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1340 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1341 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1342 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
1344 *System Limitations*
1348 *Known Vulnerabilities*
1354 Documented under corresponding jira if applicable.
1359 *Fixed Security Issues*
1361 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1362 - Upgrade org.onap.oparent to 3.2.0
1363 - Upgrade spring.boot to 2.3.8.RELEASE
1364 - Upgrade yangtools to 5.0.7
1366 *Known Security Issues*
1368 * Weak Cryptography using md5
1369 * Risk seen in Zip file expansion
1371 *Known Vulnerabilities in Used Modules*
1375 CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
1379 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1384 For more information on the latest ONAP release, please see:
1386 #. `ONAP Home Page`_
1387 #. `ONAP Wiki Page`_
1388 #. `ONAP Documentation`_
1389 #. `ONAP CPS Documentation`_
1390 #. `ONAP Release Downloads`_
1393 .. _`ONAP Home Page`: https://www.onap.org
1394 .. _`ONAP Wiki Page`: https://wiki.onap.org
1395 .. _`ONAP Documentation`: https://docs.onap.org
1396 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1397 .. _`ONAP Release Downloads`: https://git.onap.org
1401 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1402 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_