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 +--------------------------------------+--------------------------------------------------------+
44 - CPS-Temporal is no longer supported and any related documentation has been removed.
45 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
54 +--------------------------------------+--------------------------------------------------------+
57 +--------------------------------------+--------------------------------------------------------+
58 | **Docker images** | onap/cps-and-ncmp:3.4.0 |
60 +--------------------------------------+--------------------------------------------------------+
61 | **Release designation** | 3.4.0 New Delhi |
63 +--------------------------------------+--------------------------------------------------------+
64 | **Release date** | 2023 November 09 |
66 +--------------------------------------+--------------------------------------------------------+
71 - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
73 .. ========================
74 .. * * * MONTREAL * * *
75 .. ========================
83 +--------------------------------------+--------------------------------------------------------+
86 +--------------------------------------+--------------------------------------------------------+
87 | **Docker images** | onap/cps-and-ncmp:3.3.9 |
89 +--------------------------------------+--------------------------------------------------------+
90 | **Release designation** | 3.3.9 Montreal |
92 +--------------------------------------+--------------------------------------------------------+
93 | **Release date** | 2023 November 06 |
95 +--------------------------------------+--------------------------------------------------------+
100 - `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.
101 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
112 +--------------------------------------+--------------------------------------------------------+
113 | **CPS Project** | |
115 +--------------------------------------+--------------------------------------------------------+
116 | **Docker images** | onap/cps-and-ncmp:3.3.8 |
118 +--------------------------------------+--------------------------------------------------------+
119 | **Release designation** | 3.3.8 Montreal |
121 +--------------------------------------+--------------------------------------------------------+
122 | **Release date** | 2023 September 29 |
124 +--------------------------------------+--------------------------------------------------------+
132 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
140 +--------------------------------------+--------------------------------------------------------+
141 | **CPS Project** | |
143 +--------------------------------------+--------------------------------------------------------+
144 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
146 +--------------------------------------+--------------------------------------------------------+
147 | **Release designation** | 3.3.7 Montreal |
149 +--------------------------------------+--------------------------------------------------------+
150 | **Release date** | 2023 September 20 |
152 +--------------------------------------+--------------------------------------------------------+
157 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
161 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
165 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
173 +--------------------------------------+--------------------------------------------------------+
174 | **CPS Project** | |
176 +--------------------------------------+--------------------------------------------------------+
177 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
179 +--------------------------------------+--------------------------------------------------------+
180 | **Release designation** | 3.3.6 Montreal |
182 +--------------------------------------+--------------------------------------------------------+
183 | **Release date** | 2023 August 23 |
185 +--------------------------------------+--------------------------------------------------------+
190 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
191 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
195 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
196 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
205 +--------------------------------------+--------------------------------------------------------+
206 | **CPS Project** | |
208 +--------------------------------------+--------------------------------------------------------+
209 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
211 +--------------------------------------+--------------------------------------------------------+
212 | **Release designation** | 3.3.5 Montreal |
214 +--------------------------------------+--------------------------------------------------------+
215 | **Release date** | 2023 July 21 |
217 +--------------------------------------+--------------------------------------------------------+
225 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
233 +--------------------------------------+--------------------------------------------------------+
234 | **CPS Project** | |
236 +--------------------------------------+--------------------------------------------------------+
237 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
239 +--------------------------------------+--------------------------------------------------------+
240 | **Release designation** | 3.3.4 Montreal |
242 +--------------------------------------+--------------------------------------------------------+
243 | **Release date** | 2023 July 19 |
245 +--------------------------------------+--------------------------------------------------------+
253 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
261 +--------------------------------------+--------------------------------------------------------+
262 | **CPS Project** | |
264 +--------------------------------------+--------------------------------------------------------+
265 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
267 +--------------------------------------+--------------------------------------------------------+
268 | **Release designation** | 3.3.3 Montreal |
270 +--------------------------------------+--------------------------------------------------------+
271 | **Release date** | 2023 June 30 |
273 +--------------------------------------+--------------------------------------------------------+
281 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
282 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
283 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
291 +--------------------------------------+--------------------------------------------------------+
292 | **CPS Project** | |
294 +--------------------------------------+--------------------------------------------------------+
295 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
297 +--------------------------------------+--------------------------------------------------------+
298 | **Release designation** | 3.3.2 Montreal |
300 +--------------------------------------+--------------------------------------------------------+
301 | **Release date** | 2023 June 15 |
303 +--------------------------------------+--------------------------------------------------------+
308 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
312 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
313 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
314 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
315 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
316 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
324 +--------------------------------------+--------------------------------------------------------+
325 | **CPS Project** | |
327 +--------------------------------------+--------------------------------------------------------+
328 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
330 +--------------------------------------+--------------------------------------------------------+
331 | **Release designation** | 3.3.1 Montreal |
333 +--------------------------------------+--------------------------------------------------------+
334 | **Release date** | 2023 May 03 |
336 +--------------------------------------+--------------------------------------------------------+
345 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
346 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
347 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
348 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
349 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
357 +--------------------------------------+--------------------------------------------------------+
358 | **CPS Project** | |
360 +--------------------------------------+--------------------------------------------------------+
361 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
363 +--------------------------------------+--------------------------------------------------------+
364 | **Release designation** | 3.3.0 Montreal |
366 +--------------------------------------+--------------------------------------------------------+
367 | **Release date** | 2023 April 20 |
369 +--------------------------------------+--------------------------------------------------------+
378 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
379 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
381 .. ======================
382 .. * * * LONDON * * *
383 .. ======================
391 +--------------------------------------+--------------------------------------------------------+
392 | **CPS Project** | |
394 +--------------------------------------+--------------------------------------------------------+
395 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
397 +--------------------------------------+--------------------------------------------------------+
398 | **Release designation** | 3.2.6 London |
400 +--------------------------------------+--------------------------------------------------------+
401 | **Release date** | 2023 March 22 |
403 +--------------------------------------+--------------------------------------------------------+
408 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
409 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
413 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
421 +--------------------------------------+--------------------------------------------------------+
422 | **CPS Project** | |
424 +--------------------------------------+--------------------------------------------------------+
425 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
427 +--------------------------------------+--------------------------------------------------------+
428 | **Release designation** | 3.2.5 London |
430 +--------------------------------------+--------------------------------------------------------+
431 | **Release date** | 2023 March 10 |
433 +--------------------------------------+--------------------------------------------------------+
438 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
450 +--------------------------------------+--------------------------------------------------------+
451 | **CPS Project** | |
453 +--------------------------------------+--------------------------------------------------------+
454 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
456 +--------------------------------------+--------------------------------------------------------+
457 | **Release designation** | 3.2.4 London |
459 +--------------------------------------+--------------------------------------------------------+
460 | **Release date** | 2023 March 09 |
462 +--------------------------------------+--------------------------------------------------------+
467 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
468 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
480 +--------------------------------------+--------------------------------------------------------+
481 | **CPS Project** | |
483 +--------------------------------------+--------------------------------------------------------+
484 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
486 +--------------------------------------+--------------------------------------------------------+
487 | **Release designation** | 3.2.3 London |
489 +--------------------------------------+--------------------------------------------------------+
490 | **Release date** | 2023 March 07 |
492 +--------------------------------------+--------------------------------------------------------+
497 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
501 - `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
502 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
510 +--------------------------------------+--------------------------------------------------------+
511 | **CPS Project** | |
513 +--------------------------------------+--------------------------------------------------------+
514 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
516 +--------------------------------------+--------------------------------------------------------+
517 | **Release designation** | 3.2.2 London |
519 +--------------------------------------+--------------------------------------------------------+
520 | **Release date** | 2023 February 08 |
522 +--------------------------------------+--------------------------------------------------------+
527 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
539 +--------------------------------------+--------------------------------------------------------+
540 | **CPS Project** | |
542 +--------------------------------------+--------------------------------------------------------+
543 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
545 +--------------------------------------+--------------------------------------------------------+
546 | **Release designation** | 3.2.1 London |
548 +--------------------------------------+--------------------------------------------------------+
549 | **Release date** | 2023 January 27 |
551 +--------------------------------------+--------------------------------------------------------+
556 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
557 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
558 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
559 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
560 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
561 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
562 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
563 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
564 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
565 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
566 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
567 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
568 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
573 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
574 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
575 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
576 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
577 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
578 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
579 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
580 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
581 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
582 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
583 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
584 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
585 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
586 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
589 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
591 Known Limitations, Issues and Workarounds
592 -----------------------------------------
596 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
597 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.
599 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
600 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
602 .. ====================
604 .. ====================
612 +--------------------------------------+--------------------------------------------------------+
613 | **CPS Project** | |
615 +--------------------------------------+--------------------------------------------------------+
616 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
618 +--------------------------------------+--------------------------------------------------------+
619 | **Release designation** | 3.1.4 Kohn |
621 +--------------------------------------+--------------------------------------------------------+
622 | **Release date** | 2022 October 5 |
624 +--------------------------------------+--------------------------------------------------------+
628 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
629 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
637 +--------------------------------------+--------------------------------------------------------+
638 | **CPS Project** | |
640 +--------------------------------------+--------------------------------------------------------+
641 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
643 +--------------------------------------+--------------------------------------------------------+
644 | **Release designation** | 3.1.3 Kohn |
646 +--------------------------------------+--------------------------------------------------------+
647 | **Release date** | 2022 September 29 |
649 +--------------------------------------+--------------------------------------------------------+
661 +--------------------------------------+--------------------------------------------------------+
662 | **CPS Project** | |
664 +--------------------------------------+--------------------------------------------------------+
665 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
667 +--------------------------------------+--------------------------------------------------------+
668 | **Release designation** | 3.1.2 Kohn |
670 +--------------------------------------+--------------------------------------------------------+
671 | **Release date** | 2022 September 28 |
673 +--------------------------------------+--------------------------------------------------------+
685 +--------------------------------------+--------------------------------------------------------+
686 | **CPS Project** | |
688 +--------------------------------------+--------------------------------------------------------+
689 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
691 +--------------------------------------+--------------------------------------------------------+
692 | **Release designation** | 3.1.1 Kohn |
694 +--------------------------------------+--------------------------------------------------------+
695 | **Release date** | 2022 September 28 |
697 +--------------------------------------+--------------------------------------------------------+
706 *Fixed Security Issues*
708 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
716 +--------------------------------------+--------------------------------------------------------+
717 | **CPS Project** | |
719 +--------------------------------------+--------------------------------------------------------+
720 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
722 +--------------------------------------+--------------------------------------------------------+
723 | **Release designation** | 3.1.0 Kohn |
725 +--------------------------------------+--------------------------------------------------------+
726 | **Release date** | 2022 September 14 |
728 +--------------------------------------+--------------------------------------------------------+
732 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
733 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
734 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
735 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
736 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
737 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
738 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
739 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
740 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
741 - `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'
742 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
743 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
744 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
745 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
746 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
747 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
748 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
749 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
750 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
751 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
752 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
753 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
754 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
755 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
760 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
761 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
762 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
763 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
764 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMI Handles registered
765 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
766 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
767 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
768 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
769 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
770 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
771 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
772 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
773 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
775 Known Limitations, Issues and Workarounds
776 -----------------------------------------
780 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
781 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
783 *Known Vulnerabilities*
794 *Fixed Security Issues*
796 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
798 *Known Security Issues*
802 .. ========================
803 .. * * * JAKARTA * * *
804 .. ========================
812 +--------------------------------------+--------------------------------------------------------+
813 | **CPS Project** | |
815 +--------------------------------------+--------------------------------------------------------+
816 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
818 +--------------------------------------+--------------------------------------------------------+
819 | **Release designation** | 3.0.1 Jakarta |
821 +--------------------------------------+--------------------------------------------------------+
822 | **Release date** | 2022 April 28 |
824 +--------------------------------------+--------------------------------------------------------+
828 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
836 +--------------------------------------+--------------------------------------------------------+
837 | **CPS Project** | |
839 +--------------------------------------+--------------------------------------------------------+
840 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
842 +--------------------------------------+--------------------------------------------------------+
843 | **Release designation** | 3.0.0 Jakarta |
845 +--------------------------------------+--------------------------------------------------------+
846 | **Release date** | 2022 March 15 |
848 +--------------------------------------+--------------------------------------------------------+
852 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
853 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
854 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
855 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
856 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
857 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
858 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
859 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
860 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
861 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
862 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
867 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
868 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
869 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
870 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
871 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
872 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
873 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
874 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
875 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
876 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
878 Known Limitations, Issues and Workarounds
879 -----------------------------------------
883 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
884 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
885 of cm handle registration.
887 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
888 for more information.
890 *Known Vulnerabilities*
896 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
897 pass an empty string as the value if you do not want to include names for these values.
902 *Fixed Security Issues*
906 *Known Security Issues*
910 .. ========================
911 .. * * * ISTANBUL * * *
912 .. ========================
920 +--------------------------------------+--------------------------------------------------------+
921 | **CPS Project** | |
923 +--------------------------------------+--------------------------------------------------------+
924 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
926 +--------------------------------------+--------------------------------------------------------+
927 | **Release designation** | 2.0.4 Istanbul |
929 +--------------------------------------+--------------------------------------------------------+
930 | **Release date** | 2022 Feb 09 |
932 +--------------------------------------+--------------------------------------------------------+
937 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
938 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
946 +--------------------------------------+--------------------------------------------------------+
947 | **CPS Project** | |
949 +--------------------------------------+--------------------------------------------------------+
950 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
952 +--------------------------------------+--------------------------------------------------------+
953 | **Release designation** | 2.0.3 Istanbul |
955 +--------------------------------------+--------------------------------------------------------+
956 | **Release date** | 2022-07-01 |
958 +--------------------------------------+--------------------------------------------------------+
963 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
971 +--------------------------------------+--------------------------------------------------------+
972 | **CPS Project** | |
974 +--------------------------------------+--------------------------------------------------------+
975 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
977 +--------------------------------------+--------------------------------------------------------+
978 | **Release designation** | 2.0.2 Istanbul |
980 +--------------------------------------+--------------------------------------------------------+
981 | **Release date** | 2021-16-12 |
983 +--------------------------------------+--------------------------------------------------------+
988 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
996 +--------------------------------------+--------------------------------------------------------+
997 | **CPS Project** | |
999 +--------------------------------------+--------------------------------------------------------+
1000 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
1002 +--------------------------------------+--------------------------------------------------------+
1003 | **Release designation** | 2.0.1 Istanbul |
1005 +--------------------------------------+--------------------------------------------------------+
1006 | **Release date** | 2021-14-10 |
1008 +--------------------------------------+--------------------------------------------------------+
1013 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1014 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1015 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1016 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1018 Known Limitations, Issues and Workarounds
1019 -----------------------------------------
1021 *System Limitations*
1023 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1025 *Known Vulnerabilities*
1027 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1031 Add recursive method to save list node data to loop through all corresponding child nodes.
1036 *Fixed Security Issues*
1038 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1040 *Known Security Issues*
1050 This document provides the release notes for Istanbul release.
1055 +--------------------------------------+--------------------------------------------------------+
1056 | **CPS Project** | |
1058 +--------------------------------------+--------------------------------------------------------+
1059 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
1061 +--------------------------------------+--------------------------------------------------------+
1062 | **Release designation** | 2.0.0 Istanbul |
1064 +--------------------------------------+--------------------------------------------------------+
1065 | **Release date** | 2021-14-09 |
1067 +--------------------------------------+--------------------------------------------------------+
1071 * Register DMI-Plugins with NCMP for CM Handle registrations.
1072 * Update, Create and Remove CM Handles.
1073 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1074 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1079 Software Deliverables
1082 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1085 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1090 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1091 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1092 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1093 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1094 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1095 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1096 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1097 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1098 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1099 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1100 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1101 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1102 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1103 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1104 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1105 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1106 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1107 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1108 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1109 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1110 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1111 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1112 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1113 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1114 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1115 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1117 This document provides the release notes for Istanbul release.
1122 Following CPS components are available with default ONAP/CPS installation.
1125 * Platform components
1129 * Service components
1134 * Additional resources that CPS utilizes deployed using ONAP common charts
1139 Below service components (mS) are available to be deployed on-demand.
1143 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1145 Known Limitations, Issues and Workarounds
1146 -----------------------------------------
1148 *System Limitations*
1150 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1152 *Known Vulnerabilities*
1154 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1155 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1156 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1160 Add recursive method to save list node data to loop through all corresponding child nodes.
1165 *Fixed Security Issues*
1167 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1169 *Known Security Issues*
1171 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1175 * `Integration tests`
1177 .. ========================
1178 .. * * * HONOLULU * * *
1179 .. ========================
1187 +--------------------------------------+--------------------------------------------------------+
1188 | **CPS Project** | |
1190 +--------------------------------------+--------------------------------------------------------+
1191 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1193 +--------------------------------------+--------------------------------------------------------+
1194 | **Release designation** | 1.0.1 Honolulu |
1196 +--------------------------------------+--------------------------------------------------------+
1197 | **Release date** | 2021-04-09 |
1199 +--------------------------------------+--------------------------------------------------------+
1204 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1205 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1206 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1207 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1208 - `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
1209 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1210 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1211 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1216 *Fixed Security Issues*
1218 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1220 *Known Security Issues*
1222 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1231 This document provides the release notes for Honolulu release.
1236 Following CPS components are available with default ONAP/CPS installation.
1239 * Platform components
1243 * Service components
1247 * Additional resources that CPS utilizes deployed using ONAP common charts
1252 Below service components (mS) are available to be deployed on-demand.
1256 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1262 +--------------------------------------+--------------------------------------------------------+
1263 | **CPS Project** | |
1265 +--------------------------------------+--------------------------------------------------------+
1266 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1268 +--------------------------------------+--------------------------------------------------------+
1269 | **Release designation** | 1.0.0 Honolulu |
1271 +--------------------------------------+--------------------------------------------------------+
1272 | **Release date** | 2021-03-11 |
1274 +--------------------------------------+--------------------------------------------------------+
1279 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1280 CPS has been driven by the needs of the E2E Networking Slicing use case.
1281 It currently supports basic (rw) persistence and simple queries.
1282 It also provides MVP support for network data access using simulated data.
1284 .. _honolulu_deliverable:
1289 Software Deliverables
1292 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1295 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1298 Known Limitations, Issues and Workarounds
1299 -----------------------------------------
1301 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1302 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1303 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1304 - `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.
1306 *System Limitations*
1310 *Known Vulnerabilities*
1316 Documented under corresponding jira if applicable.
1321 *Fixed Security Issues*
1323 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1324 - Upgrade org.onap.oparent to 3.2.0
1325 - Upgrade spring.boot to 2.3.8.RELEASE
1326 - Upgrade yangtools to 5.0.7
1328 *Known Security Issues*
1330 * Weak Cryptography using md5
1331 * Risk seen in Zip file expansion
1333 *Known Vulnerabilities in Used Modules*
1337 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.
1341 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1346 For more information on the latest ONAP release, please see:
1348 #. `ONAP Home Page`_
1349 #. `ONAP Wiki Page`_
1350 #. `ONAP Documentation`_
1351 #. `ONAP CPS Documentation`_
1352 #. `ONAP Release Downloads`_
1355 .. _`ONAP Home Page`: https://www.onap.org
1356 .. _`ONAP Wiki Page`: https://wiki.onap.org
1357 .. _`ONAP Documentation`: https://docs.onap.org
1358 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1359 .. _`ONAP Release Downloads`: https://git.onap.org
1363 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1364 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_