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.
53 +--------------------------------------+--------------------------------------------------------+
56 +--------------------------------------+--------------------------------------------------------+
57 | **Docker images** | onap/cps-and-ncmp:3.4.0 |
59 +--------------------------------------+--------------------------------------------------------+
60 | **Release designation** | 3.4.0 New Delhi |
62 +--------------------------------------+--------------------------------------------------------+
63 | **Release date** | 2023 November 09 |
65 +--------------------------------------+--------------------------------------------------------+
70 - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
72 .. ========================
73 .. * * * MONTREAL * * *
74 .. ========================
82 +--------------------------------------+--------------------------------------------------------+
85 +--------------------------------------+--------------------------------------------------------+
86 | **Docker images** | onap/cps-and-ncmp:3.3.9 |
88 +--------------------------------------+--------------------------------------------------------+
89 | **Release designation** | 3.3.9 Montreal |
91 +--------------------------------------+--------------------------------------------------------+
92 | **Release date** | 2023 November 06 |
94 +--------------------------------------+--------------------------------------------------------+
99 - `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.
100 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
111 +--------------------------------------+--------------------------------------------------------+
112 | **CPS Project** | |
114 +--------------------------------------+--------------------------------------------------------+
115 | **Docker images** | onap/cps-and-ncmp:3.3.8 |
117 +--------------------------------------+--------------------------------------------------------+
118 | **Release designation** | 3.3.8 Montreal |
120 +--------------------------------------+--------------------------------------------------------+
121 | **Release date** | 2023 September 29 |
123 +--------------------------------------+--------------------------------------------------------+
131 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
139 +--------------------------------------+--------------------------------------------------------+
140 | **CPS Project** | |
142 +--------------------------------------+--------------------------------------------------------+
143 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
145 +--------------------------------------+--------------------------------------------------------+
146 | **Release designation** | 3.3.7 Montreal |
148 +--------------------------------------+--------------------------------------------------------+
149 | **Release date** | 2023 September 20 |
151 +--------------------------------------+--------------------------------------------------------+
156 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
160 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
164 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
172 +--------------------------------------+--------------------------------------------------------+
173 | **CPS Project** | |
175 +--------------------------------------+--------------------------------------------------------+
176 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
178 +--------------------------------------+--------------------------------------------------------+
179 | **Release designation** | 3.3.6 Montreal |
181 +--------------------------------------+--------------------------------------------------------+
182 | **Release date** | 2023 August 23 |
184 +--------------------------------------+--------------------------------------------------------+
189 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
190 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
194 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
195 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
204 +--------------------------------------+--------------------------------------------------------+
205 | **CPS Project** | |
207 +--------------------------------------+--------------------------------------------------------+
208 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
210 +--------------------------------------+--------------------------------------------------------+
211 | **Release designation** | 3.3.5 Montreal |
213 +--------------------------------------+--------------------------------------------------------+
214 | **Release date** | 2023 July 21 |
216 +--------------------------------------+--------------------------------------------------------+
224 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
232 +--------------------------------------+--------------------------------------------------------+
233 | **CPS Project** | |
235 +--------------------------------------+--------------------------------------------------------+
236 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
238 +--------------------------------------+--------------------------------------------------------+
239 | **Release designation** | 3.3.4 Montreal |
241 +--------------------------------------+--------------------------------------------------------+
242 | **Release date** | 2023 July 19 |
244 +--------------------------------------+--------------------------------------------------------+
252 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
260 +--------------------------------------+--------------------------------------------------------+
261 | **CPS Project** | |
263 +--------------------------------------+--------------------------------------------------------+
264 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
266 +--------------------------------------+--------------------------------------------------------+
267 | **Release designation** | 3.3.3 Montreal |
269 +--------------------------------------+--------------------------------------------------------+
270 | **Release date** | 2023 June 30 |
272 +--------------------------------------+--------------------------------------------------------+
280 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
281 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
282 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
290 +--------------------------------------+--------------------------------------------------------+
291 | **CPS Project** | |
293 +--------------------------------------+--------------------------------------------------------+
294 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
296 +--------------------------------------+--------------------------------------------------------+
297 | **Release designation** | 3.3.2 Montreal |
299 +--------------------------------------+--------------------------------------------------------+
300 | **Release date** | 2023 June 15 |
302 +--------------------------------------+--------------------------------------------------------+
307 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
311 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
312 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
313 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
314 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
315 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
323 +--------------------------------------+--------------------------------------------------------+
324 | **CPS Project** | |
326 +--------------------------------------+--------------------------------------------------------+
327 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
329 +--------------------------------------+--------------------------------------------------------+
330 | **Release designation** | 3.3.1 Montreal |
332 +--------------------------------------+--------------------------------------------------------+
333 | **Release date** | 2023 May 03 |
335 +--------------------------------------+--------------------------------------------------------+
344 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
345 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
346 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
347 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
348 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
356 +--------------------------------------+--------------------------------------------------------+
357 | **CPS Project** | |
359 +--------------------------------------+--------------------------------------------------------+
360 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
362 +--------------------------------------+--------------------------------------------------------+
363 | **Release designation** | 3.3.0 Montreal |
365 +--------------------------------------+--------------------------------------------------------+
366 | **Release date** | 2023 April 20 |
368 +--------------------------------------+--------------------------------------------------------+
377 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
378 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
380 .. ======================
381 .. * * * LONDON * * *
382 .. ======================
390 +--------------------------------------+--------------------------------------------------------+
391 | **CPS Project** | |
393 +--------------------------------------+--------------------------------------------------------+
394 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
396 +--------------------------------------+--------------------------------------------------------+
397 | **Release designation** | 3.2.6 London |
399 +--------------------------------------+--------------------------------------------------------+
400 | **Release date** | 2023 March 22 |
402 +--------------------------------------+--------------------------------------------------------+
407 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
408 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
412 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
420 +--------------------------------------+--------------------------------------------------------+
421 | **CPS Project** | |
423 +--------------------------------------+--------------------------------------------------------+
424 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
426 +--------------------------------------+--------------------------------------------------------+
427 | **Release designation** | 3.2.5 London |
429 +--------------------------------------+--------------------------------------------------------+
430 | **Release date** | 2023 March 10 |
432 +--------------------------------------+--------------------------------------------------------+
437 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
449 +--------------------------------------+--------------------------------------------------------+
450 | **CPS Project** | |
452 +--------------------------------------+--------------------------------------------------------+
453 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
455 +--------------------------------------+--------------------------------------------------------+
456 | **Release designation** | 3.2.4 London |
458 +--------------------------------------+--------------------------------------------------------+
459 | **Release date** | 2023 March 09 |
461 +--------------------------------------+--------------------------------------------------------+
466 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
467 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
479 +--------------------------------------+--------------------------------------------------------+
480 | **CPS Project** | |
482 +--------------------------------------+--------------------------------------------------------+
483 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
485 +--------------------------------------+--------------------------------------------------------+
486 | **Release designation** | 3.2.3 London |
488 +--------------------------------------+--------------------------------------------------------+
489 | **Release date** | 2023 March 07 |
491 +--------------------------------------+--------------------------------------------------------+
496 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
500 - `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
501 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
509 +--------------------------------------+--------------------------------------------------------+
510 | **CPS Project** | |
512 +--------------------------------------+--------------------------------------------------------+
513 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
515 +--------------------------------------+--------------------------------------------------------+
516 | **Release designation** | 3.2.2 London |
518 +--------------------------------------+--------------------------------------------------------+
519 | **Release date** | 2023 February 08 |
521 +--------------------------------------+--------------------------------------------------------+
526 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
538 +--------------------------------------+--------------------------------------------------------+
539 | **CPS Project** | |
541 +--------------------------------------+--------------------------------------------------------+
542 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
544 +--------------------------------------+--------------------------------------------------------+
545 | **Release designation** | 3.2.1 London |
547 +--------------------------------------+--------------------------------------------------------+
548 | **Release date** | 2023 January 27 |
550 +--------------------------------------+--------------------------------------------------------+
555 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
556 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
557 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
558 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
559 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
560 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
561 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
562 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
563 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
564 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
565 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
566 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
567 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
572 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
573 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
574 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
575 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
576 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
577 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
578 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
579 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
580 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
581 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
582 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
583 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
584 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
585 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
588 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
590 Known Limitations, Issues and Workarounds
591 -----------------------------------------
595 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
596 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.
598 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
599 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
601 .. ====================
603 .. ====================
611 +--------------------------------------+--------------------------------------------------------+
612 | **CPS Project** | |
614 +--------------------------------------+--------------------------------------------------------+
615 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
617 +--------------------------------------+--------------------------------------------------------+
618 | **Release designation** | 3.1.4 Kohn |
620 +--------------------------------------+--------------------------------------------------------+
621 | **Release date** | 2022 October 5 |
623 +--------------------------------------+--------------------------------------------------------+
627 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
628 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
636 +--------------------------------------+--------------------------------------------------------+
637 | **CPS Project** | |
639 +--------------------------------------+--------------------------------------------------------+
640 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
642 +--------------------------------------+--------------------------------------------------------+
643 | **Release designation** | 3.1.3 Kohn |
645 +--------------------------------------+--------------------------------------------------------+
646 | **Release date** | 2022 September 29 |
648 +--------------------------------------+--------------------------------------------------------+
660 +--------------------------------------+--------------------------------------------------------+
661 | **CPS Project** | |
663 +--------------------------------------+--------------------------------------------------------+
664 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
666 +--------------------------------------+--------------------------------------------------------+
667 | **Release designation** | 3.1.2 Kohn |
669 +--------------------------------------+--------------------------------------------------------+
670 | **Release date** | 2022 September 28 |
672 +--------------------------------------+--------------------------------------------------------+
684 +--------------------------------------+--------------------------------------------------------+
685 | **CPS Project** | |
687 +--------------------------------------+--------------------------------------------------------+
688 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
690 +--------------------------------------+--------------------------------------------------------+
691 | **Release designation** | 3.1.1 Kohn |
693 +--------------------------------------+--------------------------------------------------------+
694 | **Release date** | 2022 September 28 |
696 +--------------------------------------+--------------------------------------------------------+
705 *Fixed Security Issues*
707 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
715 +--------------------------------------+--------------------------------------------------------+
716 | **CPS Project** | |
718 +--------------------------------------+--------------------------------------------------------+
719 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
721 +--------------------------------------+--------------------------------------------------------+
722 | **Release designation** | 3.1.0 Kohn |
724 +--------------------------------------+--------------------------------------------------------+
725 | **Release date** | 2022 September 14 |
727 +--------------------------------------+--------------------------------------------------------+
731 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
732 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
733 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
734 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
735 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
736 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
737 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
738 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
739 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
740 - `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'
741 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
742 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
743 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
744 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
745 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
746 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
747 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
748 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
749 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
750 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
751 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
752 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
753 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
754 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
759 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
760 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
761 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
762 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
763 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMI Handles registered
764 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
765 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
766 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
767 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
768 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
769 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
770 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
771 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
772 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
774 Known Limitations, Issues and Workarounds
775 -----------------------------------------
779 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
780 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
782 *Known Vulnerabilities*
793 *Fixed Security Issues*
795 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
797 *Known Security Issues*
801 .. ========================
802 .. * * * JAKARTA * * *
803 .. ========================
811 +--------------------------------------+--------------------------------------------------------+
812 | **CPS Project** | |
814 +--------------------------------------+--------------------------------------------------------+
815 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
817 +--------------------------------------+--------------------------------------------------------+
818 | **Release designation** | 3.0.1 Jakarta |
820 +--------------------------------------+--------------------------------------------------------+
821 | **Release date** | 2022 April 28 |
823 +--------------------------------------+--------------------------------------------------------+
827 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
835 +--------------------------------------+--------------------------------------------------------+
836 | **CPS Project** | |
838 +--------------------------------------+--------------------------------------------------------+
839 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
841 +--------------------------------------+--------------------------------------------------------+
842 | **Release designation** | 3.0.0 Jakarta |
844 +--------------------------------------+--------------------------------------------------------+
845 | **Release date** | 2022 March 15 |
847 +--------------------------------------+--------------------------------------------------------+
851 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
852 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
853 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
854 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
855 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
856 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
857 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
858 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
859 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
860 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
861 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
866 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
867 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
868 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
869 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
870 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
871 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
872 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
873 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
874 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
875 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
877 Known Limitations, Issues and Workarounds
878 -----------------------------------------
882 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
883 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
884 of cm handle registration.
886 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
887 for more information.
889 *Known Vulnerabilities*
895 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
896 pass an empty string as the value if you do not want to include names for these values.
901 *Fixed Security Issues*
905 *Known Security Issues*
909 .. ========================
910 .. * * * ISTANBUL * * *
911 .. ========================
919 +--------------------------------------+--------------------------------------------------------+
920 | **CPS Project** | |
922 +--------------------------------------+--------------------------------------------------------+
923 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
925 +--------------------------------------+--------------------------------------------------------+
926 | **Release designation** | 2.0.4 Istanbul |
928 +--------------------------------------+--------------------------------------------------------+
929 | **Release date** | 2022 Feb 09 |
931 +--------------------------------------+--------------------------------------------------------+
936 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
937 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
945 +--------------------------------------+--------------------------------------------------------+
946 | **CPS Project** | |
948 +--------------------------------------+--------------------------------------------------------+
949 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
951 +--------------------------------------+--------------------------------------------------------+
952 | **Release designation** | 2.0.3 Istanbul |
954 +--------------------------------------+--------------------------------------------------------+
955 | **Release date** | 2022-07-01 |
957 +--------------------------------------+--------------------------------------------------------+
962 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
970 +--------------------------------------+--------------------------------------------------------+
971 | **CPS Project** | |
973 +--------------------------------------+--------------------------------------------------------+
974 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
976 +--------------------------------------+--------------------------------------------------------+
977 | **Release designation** | 2.0.2 Istanbul |
979 +--------------------------------------+--------------------------------------------------------+
980 | **Release date** | 2021-16-12 |
982 +--------------------------------------+--------------------------------------------------------+
987 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
995 +--------------------------------------+--------------------------------------------------------+
996 | **CPS Project** | |
998 +--------------------------------------+--------------------------------------------------------+
999 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
1001 +--------------------------------------+--------------------------------------------------------+
1002 | **Release designation** | 2.0.1 Istanbul |
1004 +--------------------------------------+--------------------------------------------------------+
1005 | **Release date** | 2021-14-10 |
1007 +--------------------------------------+--------------------------------------------------------+
1012 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1013 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1014 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1015 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1017 Known Limitations, Issues and Workarounds
1018 -----------------------------------------
1020 *System Limitations*
1022 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1024 *Known Vulnerabilities*
1026 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1030 Add recursive method to save list node data to loop through all corresponding child nodes.
1035 *Fixed Security Issues*
1037 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1039 *Known Security Issues*
1049 This document provides the release notes for Istanbul release.
1054 +--------------------------------------+--------------------------------------------------------+
1055 | **CPS Project** | |
1057 +--------------------------------------+--------------------------------------------------------+
1058 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
1060 +--------------------------------------+--------------------------------------------------------+
1061 | **Release designation** | 2.0.0 Istanbul |
1063 +--------------------------------------+--------------------------------------------------------+
1064 | **Release date** | 2021-14-09 |
1066 +--------------------------------------+--------------------------------------------------------+
1070 * Register DMI-Plugins with NCMP for CM Handle registrations.
1071 * Update, Create and Remove CM Handles.
1072 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1073 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1078 Software Deliverables
1081 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1084 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1089 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1090 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1091 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1092 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1093 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1094 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1095 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1096 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1097 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1098 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1099 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1100 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1101 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1102 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1103 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1104 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1105 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1106 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1107 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1108 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1109 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1110 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1111 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1112 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1113 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1114 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1116 This document provides the release notes for Istanbul release.
1121 Following CPS components are available with default ONAP/CPS installation.
1124 * Platform components
1128 * Service components
1133 * Additional resources that CPS utilizes deployed using ONAP common charts
1138 Below service components (mS) are available to be deployed on-demand.
1142 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1144 Known Limitations, Issues and Workarounds
1145 -----------------------------------------
1147 *System Limitations*
1149 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1151 *Known Vulnerabilities*
1153 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1154 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1155 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1159 Add recursive method to save list node data to loop through all corresponding child nodes.
1164 *Fixed Security Issues*
1166 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1168 *Known Security Issues*
1170 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1174 * `Integration tests`
1176 .. ========================
1177 .. * * * HONOLULU * * *
1178 .. ========================
1186 +--------------------------------------+--------------------------------------------------------+
1187 | **CPS Project** | |
1189 +--------------------------------------+--------------------------------------------------------+
1190 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1192 +--------------------------------------+--------------------------------------------------------+
1193 | **Release designation** | 1.0.1 Honolulu |
1195 +--------------------------------------+--------------------------------------------------------+
1196 | **Release date** | 2021-04-09 |
1198 +--------------------------------------+--------------------------------------------------------+
1203 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1204 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1205 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1206 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1207 - `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
1208 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1209 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1210 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1215 *Fixed Security Issues*
1217 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1219 *Known Security Issues*
1221 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1230 This document provides the release notes for Honolulu release.
1235 Following CPS components are available with default ONAP/CPS installation.
1238 * Platform components
1242 * Service components
1246 * Additional resources that CPS utilizes deployed using ONAP common charts
1251 Below service components (mS) are available to be deployed on-demand.
1255 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1261 +--------------------------------------+--------------------------------------------------------+
1262 | **CPS Project** | |
1264 +--------------------------------------+--------------------------------------------------------+
1265 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1267 +--------------------------------------+--------------------------------------------------------+
1268 | **Release designation** | 1.0.0 Honolulu |
1270 +--------------------------------------+--------------------------------------------------------+
1271 | **Release date** | 2021-03-11 |
1273 +--------------------------------------+--------------------------------------------------------+
1278 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1279 CPS has been driven by the needs of the E2E Networking Slicing use case.
1280 It currently supports basic (rw) persistence and simple queries.
1281 It also provides MVP support for network data access using simulated data.
1283 .. _honolulu_deliverable:
1288 Software Deliverables
1291 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1294 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1297 Known Limitations, Issues and Workarounds
1298 -----------------------------------------
1300 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1301 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1302 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1303 - `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.
1305 *System Limitations*
1309 *Known Vulnerabilities*
1315 Documented under corresponding jira if applicable.
1320 *Fixed Security Issues*
1322 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1323 - Upgrade org.onap.oparent to 3.2.0
1324 - Upgrade spring.boot to 2.3.8.RELEASE
1325 - Upgrade yangtools to 5.0.7
1327 *Known Security Issues*
1329 * Weak Cryptography using md5
1330 * Risk seen in Zip file expansion
1332 *Known Vulnerabilities in Used Modules*
1336 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.
1340 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1345 For more information on the latest ONAP release, please see:
1347 #. `ONAP Home Page`_
1348 #. `ONAP Wiki Page`_
1349 #. `ONAP Documentation`_
1350 #. `ONAP CPS Documentation`_
1351 #. `ONAP Release Downloads`_
1354 .. _`ONAP Home Page`: https://www.onap.org
1355 .. _`ONAP Wiki Page`: https://wiki.onap.org
1356 .. _`ONAP Documentation`: https://docs.onap.org
1357 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1358 .. _`ONAP Release Downloads`: https://git.onap.org
1362 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1363 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_