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.1 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.4.1 New Delhi |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | Not yet released |
37 +--------------------------------------+--------------------------------------------------------+
41 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
45 - CPS-Temporal is no longer supported and any related documentation has been removed.
46 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
47 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
48 - `CPS-2005 <https://jira.onap.org/browse/CPS-2005>`_ Removing notification feature for cps updated events ( exclusively used by cps-temporal )
57 +--------------------------------------+--------------------------------------------------------+
60 +--------------------------------------+--------------------------------------------------------+
61 | **Docker images** | onap/cps-and-ncmp:3.4.0 |
63 +--------------------------------------+--------------------------------------------------------+
64 | **Release designation** | 3.4.0 New Delhi |
66 +--------------------------------------+--------------------------------------------------------+
67 | **Release date** | 2023 November 09 |
69 +--------------------------------------+--------------------------------------------------------+
74 - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
76 .. ========================
77 .. * * * MONTREAL * * *
78 .. ========================
86 +--------------------------------------+--------------------------------------------------------+
89 +--------------------------------------+--------------------------------------------------------+
90 | **Docker images** | onap/cps-and-ncmp:3.3.9 |
92 +--------------------------------------+--------------------------------------------------------+
93 | **Release designation** | 3.3.9 Montreal |
95 +--------------------------------------+--------------------------------------------------------+
96 | **Release date** | 2023 November 06 |
98 +--------------------------------------+--------------------------------------------------------+
103 - `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.
104 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
115 +--------------------------------------+--------------------------------------------------------+
116 | **CPS Project** | |
118 +--------------------------------------+--------------------------------------------------------+
119 | **Docker images** | onap/cps-and-ncmp:3.3.8 |
121 +--------------------------------------+--------------------------------------------------------+
122 | **Release designation** | 3.3.8 Montreal |
124 +--------------------------------------+--------------------------------------------------------+
125 | **Release date** | 2023 September 29 |
127 +--------------------------------------+--------------------------------------------------------+
135 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
143 +--------------------------------------+--------------------------------------------------------+
144 | **CPS Project** | |
146 +--------------------------------------+--------------------------------------------------------+
147 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
149 +--------------------------------------+--------------------------------------------------------+
150 | **Release designation** | 3.3.7 Montreal |
152 +--------------------------------------+--------------------------------------------------------+
153 | **Release date** | 2023 September 20 |
155 +--------------------------------------+--------------------------------------------------------+
160 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
164 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
168 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
176 +--------------------------------------+--------------------------------------------------------+
177 | **CPS Project** | |
179 +--------------------------------------+--------------------------------------------------------+
180 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
182 +--------------------------------------+--------------------------------------------------------+
183 | **Release designation** | 3.3.6 Montreal |
185 +--------------------------------------+--------------------------------------------------------+
186 | **Release date** | 2023 August 23 |
188 +--------------------------------------+--------------------------------------------------------+
193 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
194 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
198 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
199 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
208 +--------------------------------------+--------------------------------------------------------+
209 | **CPS Project** | |
211 +--------------------------------------+--------------------------------------------------------+
212 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
214 +--------------------------------------+--------------------------------------------------------+
215 | **Release designation** | 3.3.5 Montreal |
217 +--------------------------------------+--------------------------------------------------------+
218 | **Release date** | 2023 July 21 |
220 +--------------------------------------+--------------------------------------------------------+
228 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
236 +--------------------------------------+--------------------------------------------------------+
237 | **CPS Project** | |
239 +--------------------------------------+--------------------------------------------------------+
240 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
242 +--------------------------------------+--------------------------------------------------------+
243 | **Release designation** | 3.3.4 Montreal |
245 +--------------------------------------+--------------------------------------------------------+
246 | **Release date** | 2023 July 19 |
248 +--------------------------------------+--------------------------------------------------------+
256 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
264 +--------------------------------------+--------------------------------------------------------+
265 | **CPS Project** | |
267 +--------------------------------------+--------------------------------------------------------+
268 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
270 +--------------------------------------+--------------------------------------------------------+
271 | **Release designation** | 3.3.3 Montreal |
273 +--------------------------------------+--------------------------------------------------------+
274 | **Release date** | 2023 June 30 |
276 +--------------------------------------+--------------------------------------------------------+
284 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
285 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
286 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
294 +--------------------------------------+--------------------------------------------------------+
295 | **CPS Project** | |
297 +--------------------------------------+--------------------------------------------------------+
298 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
300 +--------------------------------------+--------------------------------------------------------+
301 | **Release designation** | 3.3.2 Montreal |
303 +--------------------------------------+--------------------------------------------------------+
304 | **Release date** | 2023 June 15 |
306 +--------------------------------------+--------------------------------------------------------+
311 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
315 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
316 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
317 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
318 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
319 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
327 +--------------------------------------+--------------------------------------------------------+
328 | **CPS Project** | |
330 +--------------------------------------+--------------------------------------------------------+
331 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
333 +--------------------------------------+--------------------------------------------------------+
334 | **Release designation** | 3.3.1 Montreal |
336 +--------------------------------------+--------------------------------------------------------+
337 | **Release date** | 2023 May 03 |
339 +--------------------------------------+--------------------------------------------------------+
348 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
349 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
350 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
351 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
352 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
360 +--------------------------------------+--------------------------------------------------------+
361 | **CPS Project** | |
363 +--------------------------------------+--------------------------------------------------------+
364 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
366 +--------------------------------------+--------------------------------------------------------+
367 | **Release designation** | 3.3.0 Montreal |
369 +--------------------------------------+--------------------------------------------------------+
370 | **Release date** | 2023 April 20 |
372 +--------------------------------------+--------------------------------------------------------+
381 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
382 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
384 .. ======================
385 .. * * * LONDON * * *
386 .. ======================
394 +--------------------------------------+--------------------------------------------------------+
395 | **CPS Project** | |
397 +--------------------------------------+--------------------------------------------------------+
398 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
400 +--------------------------------------+--------------------------------------------------------+
401 | **Release designation** | 3.2.6 London |
403 +--------------------------------------+--------------------------------------------------------+
404 | **Release date** | 2023 March 22 |
406 +--------------------------------------+--------------------------------------------------------+
411 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
412 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
416 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
424 +--------------------------------------+--------------------------------------------------------+
425 | **CPS Project** | |
427 +--------------------------------------+--------------------------------------------------------+
428 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
430 +--------------------------------------+--------------------------------------------------------+
431 | **Release designation** | 3.2.5 London |
433 +--------------------------------------+--------------------------------------------------------+
434 | **Release date** | 2023 March 10 |
436 +--------------------------------------+--------------------------------------------------------+
441 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
453 +--------------------------------------+--------------------------------------------------------+
454 | **CPS Project** | |
456 +--------------------------------------+--------------------------------------------------------+
457 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
459 +--------------------------------------+--------------------------------------------------------+
460 | **Release designation** | 3.2.4 London |
462 +--------------------------------------+--------------------------------------------------------+
463 | **Release date** | 2023 March 09 |
465 +--------------------------------------+--------------------------------------------------------+
470 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
471 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
483 +--------------------------------------+--------------------------------------------------------+
484 | **CPS Project** | |
486 +--------------------------------------+--------------------------------------------------------+
487 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
489 +--------------------------------------+--------------------------------------------------------+
490 | **Release designation** | 3.2.3 London |
492 +--------------------------------------+--------------------------------------------------------+
493 | **Release date** | 2023 March 07 |
495 +--------------------------------------+--------------------------------------------------------+
500 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
504 - `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
505 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
513 +--------------------------------------+--------------------------------------------------------+
514 | **CPS Project** | |
516 +--------------------------------------+--------------------------------------------------------+
517 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
519 +--------------------------------------+--------------------------------------------------------+
520 | **Release designation** | 3.2.2 London |
522 +--------------------------------------+--------------------------------------------------------+
523 | **Release date** | 2023 February 08 |
525 +--------------------------------------+--------------------------------------------------------+
530 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
542 +--------------------------------------+--------------------------------------------------------+
543 | **CPS Project** | |
545 +--------------------------------------+--------------------------------------------------------+
546 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
548 +--------------------------------------+--------------------------------------------------------+
549 | **Release designation** | 3.2.1 London |
551 +--------------------------------------+--------------------------------------------------------+
552 | **Release date** | 2023 January 27 |
554 +--------------------------------------+--------------------------------------------------------+
559 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
560 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
561 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
562 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
563 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
564 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
565 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
566 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
567 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
568 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
569 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
570 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
571 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
576 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
577 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
578 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
579 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
580 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
581 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
582 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
583 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
584 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
585 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
586 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
587 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
588 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
589 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
592 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
594 Known Limitations, Issues and Workarounds
595 -----------------------------------------
599 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
600 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.
602 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
603 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
605 .. ====================
607 .. ====================
615 +--------------------------------------+--------------------------------------------------------+
616 | **CPS Project** | |
618 +--------------------------------------+--------------------------------------------------------+
619 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
621 +--------------------------------------+--------------------------------------------------------+
622 | **Release designation** | 3.1.4 Kohn |
624 +--------------------------------------+--------------------------------------------------------+
625 | **Release date** | 2022 October 5 |
627 +--------------------------------------+--------------------------------------------------------+
631 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
632 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
640 +--------------------------------------+--------------------------------------------------------+
641 | **CPS Project** | |
643 +--------------------------------------+--------------------------------------------------------+
644 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
646 +--------------------------------------+--------------------------------------------------------+
647 | **Release designation** | 3.1.3 Kohn |
649 +--------------------------------------+--------------------------------------------------------+
650 | **Release date** | 2022 September 29 |
652 +--------------------------------------+--------------------------------------------------------+
664 +--------------------------------------+--------------------------------------------------------+
665 | **CPS Project** | |
667 +--------------------------------------+--------------------------------------------------------+
668 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
670 +--------------------------------------+--------------------------------------------------------+
671 | **Release designation** | 3.1.2 Kohn |
673 +--------------------------------------+--------------------------------------------------------+
674 | **Release date** | 2022 September 28 |
676 +--------------------------------------+--------------------------------------------------------+
688 +--------------------------------------+--------------------------------------------------------+
689 | **CPS Project** | |
691 +--------------------------------------+--------------------------------------------------------+
692 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
694 +--------------------------------------+--------------------------------------------------------+
695 | **Release designation** | 3.1.1 Kohn |
697 +--------------------------------------+--------------------------------------------------------+
698 | **Release date** | 2022 September 28 |
700 +--------------------------------------+--------------------------------------------------------+
709 *Fixed Security Issues*
711 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
719 +--------------------------------------+--------------------------------------------------------+
720 | **CPS Project** | |
722 +--------------------------------------+--------------------------------------------------------+
723 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
725 +--------------------------------------+--------------------------------------------------------+
726 | **Release designation** | 3.1.0 Kohn |
728 +--------------------------------------+--------------------------------------------------------+
729 | **Release date** | 2022 September 14 |
731 +--------------------------------------+--------------------------------------------------------+
735 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
736 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
737 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
738 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
739 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
740 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
741 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
742 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
743 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
744 - `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'
745 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
746 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
747 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
748 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
749 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
750 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
751 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
752 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
753 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
754 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
755 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
756 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
757 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
758 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
763 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
764 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
765 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
766 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
767 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMI Handles registered
768 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
769 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
770 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
771 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
772 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
773 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
774 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
775 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
776 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
778 Known Limitations, Issues and Workarounds
779 -----------------------------------------
783 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
784 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
786 *Known Vulnerabilities*
797 *Fixed Security Issues*
799 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
801 *Known Security Issues*
805 .. ========================
806 .. * * * JAKARTA * * *
807 .. ========================
815 +--------------------------------------+--------------------------------------------------------+
816 | **CPS Project** | |
818 +--------------------------------------+--------------------------------------------------------+
819 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
821 +--------------------------------------+--------------------------------------------------------+
822 | **Release designation** | 3.0.1 Jakarta |
824 +--------------------------------------+--------------------------------------------------------+
825 | **Release date** | 2022 April 28 |
827 +--------------------------------------+--------------------------------------------------------+
831 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
839 +--------------------------------------+--------------------------------------------------------+
840 | **CPS Project** | |
842 +--------------------------------------+--------------------------------------------------------+
843 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
845 +--------------------------------------+--------------------------------------------------------+
846 | **Release designation** | 3.0.0 Jakarta |
848 +--------------------------------------+--------------------------------------------------------+
849 | **Release date** | 2022 March 15 |
851 +--------------------------------------+--------------------------------------------------------+
855 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
856 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
857 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
858 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
859 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
860 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
861 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
862 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
863 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
864 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
865 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
870 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
871 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
872 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
873 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
874 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
875 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
876 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
877 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
878 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
879 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
881 Known Limitations, Issues and Workarounds
882 -----------------------------------------
886 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
887 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
888 of cm handle registration.
890 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
891 for more information.
893 *Known Vulnerabilities*
899 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
900 pass an empty string as the value if you do not want to include names for these values.
905 *Fixed Security Issues*
909 *Known Security Issues*
913 .. ========================
914 .. * * * ISTANBUL * * *
915 .. ========================
923 +--------------------------------------+--------------------------------------------------------+
924 | **CPS Project** | |
926 +--------------------------------------+--------------------------------------------------------+
927 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
929 +--------------------------------------+--------------------------------------------------------+
930 | **Release designation** | 2.0.4 Istanbul |
932 +--------------------------------------+--------------------------------------------------------+
933 | **Release date** | 2022 Feb 09 |
935 +--------------------------------------+--------------------------------------------------------+
940 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
941 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
949 +--------------------------------------+--------------------------------------------------------+
950 | **CPS Project** | |
952 +--------------------------------------+--------------------------------------------------------+
953 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
955 +--------------------------------------+--------------------------------------------------------+
956 | **Release designation** | 2.0.3 Istanbul |
958 +--------------------------------------+--------------------------------------------------------+
959 | **Release date** | 2022-07-01 |
961 +--------------------------------------+--------------------------------------------------------+
966 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
974 +--------------------------------------+--------------------------------------------------------+
975 | **CPS Project** | |
977 +--------------------------------------+--------------------------------------------------------+
978 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
980 +--------------------------------------+--------------------------------------------------------+
981 | **Release designation** | 2.0.2 Istanbul |
983 +--------------------------------------+--------------------------------------------------------+
984 | **Release date** | 2021-16-12 |
986 +--------------------------------------+--------------------------------------------------------+
991 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
999 +--------------------------------------+--------------------------------------------------------+
1000 | **CPS Project** | |
1002 +--------------------------------------+--------------------------------------------------------+
1003 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
1005 +--------------------------------------+--------------------------------------------------------+
1006 | **Release designation** | 2.0.1 Istanbul |
1008 +--------------------------------------+--------------------------------------------------------+
1009 | **Release date** | 2021-14-10 |
1011 +--------------------------------------+--------------------------------------------------------+
1016 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1017 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1018 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1019 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1021 Known Limitations, Issues and Workarounds
1022 -----------------------------------------
1024 *System Limitations*
1026 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1028 *Known Vulnerabilities*
1030 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1034 Add recursive method to save list node data to loop through all corresponding child nodes.
1039 *Fixed Security Issues*
1041 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1043 *Known Security Issues*
1053 This document provides the release notes for Istanbul release.
1058 +--------------------------------------+--------------------------------------------------------+
1059 | **CPS Project** | |
1061 +--------------------------------------+--------------------------------------------------------+
1062 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
1064 +--------------------------------------+--------------------------------------------------------+
1065 | **Release designation** | 2.0.0 Istanbul |
1067 +--------------------------------------+--------------------------------------------------------+
1068 | **Release date** | 2021-14-09 |
1070 +--------------------------------------+--------------------------------------------------------+
1074 * Register DMI-Plugins with NCMP for CM Handle registrations.
1075 * Update, Create and Remove CM Handles.
1076 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1077 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1082 Software Deliverables
1085 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1088 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1093 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1094 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1095 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1096 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1097 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1098 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1099 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1100 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1101 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1102 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1103 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1104 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1105 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1106 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1107 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1108 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1109 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1110 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1111 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1112 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1113 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1114 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1115 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1116 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1117 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1118 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1120 This document provides the release notes for Istanbul release.
1125 Following CPS components are available with default ONAP/CPS installation.
1128 * Platform components
1132 * Service components
1137 * Additional resources that CPS utilizes deployed using ONAP common charts
1142 Below service components (mS) are available to be deployed on-demand.
1146 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1148 Known Limitations, Issues and Workarounds
1149 -----------------------------------------
1151 *System Limitations*
1153 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1155 *Known Vulnerabilities*
1157 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1158 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1159 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1163 Add recursive method to save list node data to loop through all corresponding child nodes.
1168 *Fixed Security Issues*
1170 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1172 *Known Security Issues*
1174 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1178 * `Integration tests`
1180 .. ========================
1181 .. * * * HONOLULU * * *
1182 .. ========================
1190 +--------------------------------------+--------------------------------------------------------+
1191 | **CPS Project** | |
1193 +--------------------------------------+--------------------------------------------------------+
1194 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1196 +--------------------------------------+--------------------------------------------------------+
1197 | **Release designation** | 1.0.1 Honolulu |
1199 +--------------------------------------+--------------------------------------------------------+
1200 | **Release date** | 2021-04-09 |
1202 +--------------------------------------+--------------------------------------------------------+
1207 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1208 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1209 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1210 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1211 - `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
1212 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1213 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1214 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1219 *Fixed Security Issues*
1221 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1223 *Known Security Issues*
1225 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1234 This document provides the release notes for Honolulu release.
1239 Following CPS components are available with default ONAP/CPS installation.
1242 * Platform components
1246 * Service components
1250 * Additional resources that CPS utilizes deployed using ONAP common charts
1255 Below service components (mS) are available to be deployed on-demand.
1259 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1265 +--------------------------------------+--------------------------------------------------------+
1266 | **CPS Project** | |
1268 +--------------------------------------+--------------------------------------------------------+
1269 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1271 +--------------------------------------+--------------------------------------------------------+
1272 | **Release designation** | 1.0.0 Honolulu |
1274 +--------------------------------------+--------------------------------------------------------+
1275 | **Release date** | 2021-03-11 |
1277 +--------------------------------------+--------------------------------------------------------+
1282 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1283 CPS has been driven by the needs of the E2E Networking Slicing use case.
1284 It currently supports basic (rw) persistence and simple queries.
1285 It also provides MVP support for network data access using simulated data.
1287 .. _honolulu_deliverable:
1292 Software Deliverables
1295 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1298 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1301 Known Limitations, Issues and Workarounds
1302 -----------------------------------------
1304 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1305 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1306 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1307 - `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.
1309 *System Limitations*
1313 *Known Vulnerabilities*
1319 Documented under corresponding jira if applicable.
1324 *Fixed Security Issues*
1326 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1327 - Upgrade org.onap.oparent to 3.2.0
1328 - Upgrade spring.boot to 2.3.8.RELEASE
1329 - Upgrade yangtools to 5.0.7
1331 *Known Security Issues*
1333 * Weak Cryptography using md5
1334 * Risk seen in Zip file expansion
1336 *Known Vulnerabilities in Used Modules*
1340 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.
1344 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1349 For more information on the latest ONAP release, please see:
1351 #. `ONAP Home Page`_
1352 #. `ONAP Wiki Page`_
1353 #. `ONAP Documentation`_
1354 #. `ONAP CPS Documentation`_
1355 #. `ONAP Release Downloads`_
1358 .. _`ONAP Home Page`: https://www.onap.org
1359 .. _`ONAP Wiki Page`: https://wiki.onap.org
1360 .. _`ONAP Documentation`: https://docs.onap.org
1361 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1362 .. _`ONAP Release Downloads`: https://git.onap.org
1366 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1367 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_