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 .. * * * MONTREAL * * *
17 .. ========================
25 +--------------------------------------+--------------------------------------------------------+
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.3.7 Montreal |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | Not yet released |
37 +--------------------------------------+--------------------------------------------------------+
52 +--------------------------------------+--------------------------------------------------------+
55 +--------------------------------------+--------------------------------------------------------+
56 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
58 +--------------------------------------+--------------------------------------------------------+
59 | **Release designation** | 3.3.6 Montreal |
61 +--------------------------------------+--------------------------------------------------------+
62 | **Release date** | 2023 August 23 |
64 +--------------------------------------+--------------------------------------------------------+
69 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
70 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
74 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
75 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
84 +--------------------------------------+--------------------------------------------------------+
87 +--------------------------------------+--------------------------------------------------------+
88 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
90 +--------------------------------------+--------------------------------------------------------+
91 | **Release designation** | 3.3.5 Montreal |
93 +--------------------------------------+--------------------------------------------------------+
94 | **Release date** | 2023 July 21 |
96 +--------------------------------------+--------------------------------------------------------+
104 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
112 +--------------------------------------+--------------------------------------------------------+
113 | **CPS Project** | |
115 +--------------------------------------+--------------------------------------------------------+
116 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
118 +--------------------------------------+--------------------------------------------------------+
119 | **Release designation** | 3.3.4 Montreal |
121 +--------------------------------------+--------------------------------------------------------+
122 | **Release date** | 2023 July 19 |
124 +--------------------------------------+--------------------------------------------------------+
132 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
140 +--------------------------------------+--------------------------------------------------------+
141 | **CPS Project** | |
143 +--------------------------------------+--------------------------------------------------------+
144 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
146 +--------------------------------------+--------------------------------------------------------+
147 | **Release designation** | 3.3.3 Montreal |
149 +--------------------------------------+--------------------------------------------------------+
150 | **Release date** | 2023 June 30 |
152 +--------------------------------------+--------------------------------------------------------+
160 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
161 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
162 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
170 +--------------------------------------+--------------------------------------------------------+
171 | **CPS Project** | |
173 +--------------------------------------+--------------------------------------------------------+
174 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
176 +--------------------------------------+--------------------------------------------------------+
177 | **Release designation** | 3.3.2 Montreal |
179 +--------------------------------------+--------------------------------------------------------+
180 | **Release date** | 2023 June 15 |
182 +--------------------------------------+--------------------------------------------------------+
187 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
191 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
192 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
193 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
194 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
195 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
203 +--------------------------------------+--------------------------------------------------------+
204 | **CPS Project** | |
206 +--------------------------------------+--------------------------------------------------------+
207 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
209 +--------------------------------------+--------------------------------------------------------+
210 | **Release designation** | 3.3.1 Montreal |
212 +--------------------------------------+--------------------------------------------------------+
213 | **Release date** | 2023 May 03 |
215 +--------------------------------------+--------------------------------------------------------+
224 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
225 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
226 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
227 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
228 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
236 +--------------------------------------+--------------------------------------------------------+
237 | **CPS Project** | |
239 +--------------------------------------+--------------------------------------------------------+
240 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
242 +--------------------------------------+--------------------------------------------------------+
243 | **Release designation** | 3.3.0 Montreal |
245 +--------------------------------------+--------------------------------------------------------+
246 | **Release date** | 2023 April 20 |
248 +--------------------------------------+--------------------------------------------------------+
257 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
258 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
260 .. ======================
261 .. * * * LONDON * * *
262 .. ======================
270 +--------------------------------------+--------------------------------------------------------+
271 | **CPS Project** | |
273 +--------------------------------------+--------------------------------------------------------+
274 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
276 +--------------------------------------+--------------------------------------------------------+
277 | **Release designation** | 3.2.6 London |
279 +--------------------------------------+--------------------------------------------------------+
280 | **Release date** | 2023 March 22 |
282 +--------------------------------------+--------------------------------------------------------+
287 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
288 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
292 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
300 +--------------------------------------+--------------------------------------------------------+
301 | **CPS Project** | |
303 +--------------------------------------+--------------------------------------------------------+
304 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
306 +--------------------------------------+--------------------------------------------------------+
307 | **Release designation** | 3.2.5 London |
309 +--------------------------------------+--------------------------------------------------------+
310 | **Release date** | 2023 March 10 |
312 +--------------------------------------+--------------------------------------------------------+
317 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
329 +--------------------------------------+--------------------------------------------------------+
330 | **CPS Project** | |
332 +--------------------------------------+--------------------------------------------------------+
333 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
335 +--------------------------------------+--------------------------------------------------------+
336 | **Release designation** | 3.2.4 London |
338 +--------------------------------------+--------------------------------------------------------+
339 | **Release date** | 2023 March 09 |
341 +--------------------------------------+--------------------------------------------------------+
346 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
347 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
359 +--------------------------------------+--------------------------------------------------------+
360 | **CPS Project** | |
362 +--------------------------------------+--------------------------------------------------------+
363 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
365 +--------------------------------------+--------------------------------------------------------+
366 | **Release designation** | 3.2.3 London |
368 +--------------------------------------+--------------------------------------------------------+
369 | **Release date** | 2023 March 07 |
371 +--------------------------------------+--------------------------------------------------------+
376 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
380 - `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
381 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
389 +--------------------------------------+--------------------------------------------------------+
390 | **CPS Project** | |
392 +--------------------------------------+--------------------------------------------------------+
393 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
395 +--------------------------------------+--------------------------------------------------------+
396 | **Release designation** | 3.2.2 London |
398 +--------------------------------------+--------------------------------------------------------+
399 | **Release date** | 2023 February 08 |
401 +--------------------------------------+--------------------------------------------------------+
406 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
418 +--------------------------------------+--------------------------------------------------------+
419 | **CPS Project** | |
421 +--------------------------------------+--------------------------------------------------------+
422 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
424 +--------------------------------------+--------------------------------------------------------+
425 | **Release designation** | 3.2.1 London |
427 +--------------------------------------+--------------------------------------------------------+
428 | **Release date** | 2023 January 27 |
430 +--------------------------------------+--------------------------------------------------------+
435 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
436 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
437 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
438 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
439 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
440 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
441 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
442 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
443 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
444 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
445 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
446 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
447 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
452 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
453 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
454 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
455 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
456 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
457 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
458 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
459 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
460 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
461 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
462 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
463 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
464 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
465 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
468 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
470 Known Limitations, Issues and Workarounds
471 -----------------------------------------
475 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
476 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.
478 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
479 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
481 .. ====================
483 .. ====================
491 +--------------------------------------+--------------------------------------------------------+
492 | **CPS Project** | |
494 +--------------------------------------+--------------------------------------------------------+
495 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
497 +--------------------------------------+--------------------------------------------------------+
498 | **Release designation** | 3.1.4 Kohn |
500 +--------------------------------------+--------------------------------------------------------+
501 | **Release date** | 2022 October 5 |
503 +--------------------------------------+--------------------------------------------------------+
507 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
508 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
516 +--------------------------------------+--------------------------------------------------------+
517 | **CPS Project** | |
519 +--------------------------------------+--------------------------------------------------------+
520 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
522 +--------------------------------------+--------------------------------------------------------+
523 | **Release designation** | 3.1.3 Kohn |
525 +--------------------------------------+--------------------------------------------------------+
526 | **Release date** | 2022 September 29 |
528 +--------------------------------------+--------------------------------------------------------+
540 +--------------------------------------+--------------------------------------------------------+
541 | **CPS Project** | |
543 +--------------------------------------+--------------------------------------------------------+
544 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
546 +--------------------------------------+--------------------------------------------------------+
547 | **Release designation** | 3.1.2 Kohn |
549 +--------------------------------------+--------------------------------------------------------+
550 | **Release date** | 2022 September 28 |
552 +--------------------------------------+--------------------------------------------------------+
564 +--------------------------------------+--------------------------------------------------------+
565 | **CPS Project** | |
567 +--------------------------------------+--------------------------------------------------------+
568 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
570 +--------------------------------------+--------------------------------------------------------+
571 | **Release designation** | 3.1.1 Kohn |
573 +--------------------------------------+--------------------------------------------------------+
574 | **Release date** | 2022 September 28 |
576 +--------------------------------------+--------------------------------------------------------+
585 *Fixed Security Issues*
587 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
595 +--------------------------------------+--------------------------------------------------------+
596 | **CPS Project** | |
598 +--------------------------------------+--------------------------------------------------------+
599 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
601 +--------------------------------------+--------------------------------------------------------+
602 | **Release designation** | 3.1.0 Kohn |
604 +--------------------------------------+--------------------------------------------------------+
605 | **Release date** | 2022 September 14 |
607 +--------------------------------------+--------------------------------------------------------+
611 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
612 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
613 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
614 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
615 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
616 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
617 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
618 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
619 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
620 - `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'
621 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
622 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
623 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
624 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
625 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
626 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
627 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
628 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
629 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
630 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
631 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
632 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
633 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
634 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
639 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
640 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
641 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
642 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
643 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
644 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
645 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
646 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
647 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
648 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
649 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
650 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
651 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
652 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
654 Known Limitations, Issues and Workarounds
655 -----------------------------------------
659 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
660 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
662 *Known Vulnerabilities*
673 *Fixed Security Issues*
675 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
677 *Known Security Issues*
681 .. ========================
682 .. * * * JAKARTA * * *
683 .. ========================
691 +--------------------------------------+--------------------------------------------------------+
692 | **CPS Project** | |
694 +--------------------------------------+--------------------------------------------------------+
695 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
697 +--------------------------------------+--------------------------------------------------------+
698 | **Release designation** | 3.0.1 Jakarta |
700 +--------------------------------------+--------------------------------------------------------+
701 | **Release date** | 2022 April 28 |
703 +--------------------------------------+--------------------------------------------------------+
707 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
715 +--------------------------------------+--------------------------------------------------------+
716 | **CPS Project** | |
718 +--------------------------------------+--------------------------------------------------------+
719 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
721 +--------------------------------------+--------------------------------------------------------+
722 | **Release designation** | 3.0.0 Jakarta |
724 +--------------------------------------+--------------------------------------------------------+
725 | **Release date** | 2022 March 15 |
727 +--------------------------------------+--------------------------------------------------------+
731 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
732 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
733 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
734 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
735 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
736 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
737 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
738 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
739 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
740 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
741 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
746 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
747 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
748 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
749 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
750 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
751 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
752 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
753 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
754 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
755 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
757 Known Limitations, Issues and Workarounds
758 -----------------------------------------
762 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
763 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
764 of cm handle registration.
766 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
767 for more information.
769 *Known Vulnerabilities*
775 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
776 pass an empty string as the value if you do not want to include names for these values.
781 *Fixed Security Issues*
785 *Known Security Issues*
789 .. ========================
790 .. * * * ISTANBUL * * *
791 .. ========================
799 +--------------------------------------+--------------------------------------------------------+
800 | **CPS Project** | |
802 +--------------------------------------+--------------------------------------------------------+
803 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
805 +--------------------------------------+--------------------------------------------------------+
806 | **Release designation** | 2.0.4 Istanbul |
808 +--------------------------------------+--------------------------------------------------------+
809 | **Release date** | 2022 Feb 09 |
811 +--------------------------------------+--------------------------------------------------------+
816 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
817 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
825 +--------------------------------------+--------------------------------------------------------+
826 | **CPS Project** | |
828 +--------------------------------------+--------------------------------------------------------+
829 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
831 +--------------------------------------+--------------------------------------------------------+
832 | **Release designation** | 2.0.3 Istanbul |
834 +--------------------------------------+--------------------------------------------------------+
835 | **Release date** | 2022-07-01 |
837 +--------------------------------------+--------------------------------------------------------+
842 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
850 +--------------------------------------+--------------------------------------------------------+
851 | **CPS Project** | |
853 +--------------------------------------+--------------------------------------------------------+
854 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
856 +--------------------------------------+--------------------------------------------------------+
857 | **Release designation** | 2.0.2 Istanbul |
859 +--------------------------------------+--------------------------------------------------------+
860 | **Release date** | 2021-16-12 |
862 +--------------------------------------+--------------------------------------------------------+
867 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
875 +--------------------------------------+--------------------------------------------------------+
876 | **CPS Project** | |
878 +--------------------------------------+--------------------------------------------------------+
879 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
881 +--------------------------------------+--------------------------------------------------------+
882 | **Release designation** | 2.0.1 Istanbul |
884 +--------------------------------------+--------------------------------------------------------+
885 | **Release date** | 2021-14-10 |
887 +--------------------------------------+--------------------------------------------------------+
892 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
893 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
894 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
895 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
897 Known Limitations, Issues and Workarounds
898 -----------------------------------------
902 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
904 *Known Vulnerabilities*
906 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
910 Add recursive method to save list node data to loop through all corresponding child nodes.
915 *Fixed Security Issues*
917 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
919 *Known Security Issues*
929 This document provides the release notes for Istanbul release.
934 +--------------------------------------+--------------------------------------------------------+
935 | **CPS Project** | |
937 +--------------------------------------+--------------------------------------------------------+
938 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
940 +--------------------------------------+--------------------------------------------------------+
941 | **Release designation** | 2.0.0 Istanbul |
943 +--------------------------------------+--------------------------------------------------------+
944 | **Release date** | 2021-14-09 |
946 +--------------------------------------+--------------------------------------------------------+
950 * Register DMI-Plugins with NCMP for CM Handle registrations.
951 * Update, Create and Remove CM Handles.
952 * Add support for retrieving and writing CM Handle data through NCMP datastores.
953 * Automatic retrieval and caching of model information for CM Handles within NCMP.
958 Software Deliverables
961 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
964 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
969 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
970 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
971 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
972 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
973 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
974 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
975 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
976 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
977 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
978 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
979 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
980 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
981 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
982 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
983 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
984 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
985 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
986 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
987 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
988 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
989 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
990 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
991 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
992 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
993 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
994 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
996 This document provides the release notes for Istanbul release.
1001 Following CPS components are available with default ONAP/CPS installation.
1004 * Platform components
1008 * Service components
1014 * Additional resources that CPS utilizes deployed using ONAP common charts
1019 Below service components (mS) are available to be deployed on-demand.
1023 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1025 Known Limitations, Issues and Workarounds
1026 -----------------------------------------
1028 *System Limitations*
1030 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1032 *Known Vulnerabilities*
1034 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1035 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1036 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1040 Add recursive method to save list node data to loop through all corresponding child nodes.
1045 *Fixed Security Issues*
1047 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1049 *Known Security Issues*
1051 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1055 * `Integration tests`
1057 .. ========================
1058 .. * * * HONOLULU * * *
1059 .. ========================
1067 +--------------------------------------+--------------------------------------------------------+
1068 | **CPS Project** | |
1070 +--------------------------------------+--------------------------------------------------------+
1071 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1073 +--------------------------------------+--------------------------------------------------------+
1074 | **Release designation** | 1.0.1 Honolulu |
1076 +--------------------------------------+--------------------------------------------------------+
1077 | **Release date** | 2021-04-09 |
1079 +--------------------------------------+--------------------------------------------------------+
1084 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1085 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1086 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1087 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1088 - `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
1089 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1090 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1091 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1096 *Fixed Security Issues*
1098 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1100 *Known Security Issues*
1102 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1111 This document provides the release notes for Honolulu release.
1116 Following CPS components are available with default ONAP/CPS installation.
1119 * Platform components
1123 * Service components
1127 * Additional resources that CPS utilizes deployed using ONAP common charts
1132 Below service components (mS) are available to be deployed on-demand.
1136 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1142 +--------------------------------------+--------------------------------------------------------+
1143 | **CPS Project** | |
1145 +--------------------------------------+--------------------------------------------------------+
1146 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1148 +--------------------------------------+--------------------------------------------------------+
1149 | **Release designation** | 1.0.0 Honolulu |
1151 +--------------------------------------+--------------------------------------------------------+
1152 | **Release date** | 2021-03-11 |
1154 +--------------------------------------+--------------------------------------------------------+
1159 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1160 CPS has been driven by the needs of the E2E Networking Slicing use case.
1161 It currently supports basic (rw) persistence and simple queries.
1162 It also provides MVP support for network data access using simulated data.
1164 .. _honolulu_deliverable:
1169 Software Deliverables
1172 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1175 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1178 Known Limitations, Issues and Workarounds
1179 -----------------------------------------
1181 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1182 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1183 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1184 - `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.
1186 *System Limitations*
1190 *Known Vulnerabilities*
1196 Documented under corresponding jira if applicable.
1201 *Fixed Security Issues*
1203 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1204 - Upgrade org.onap.oparent to 3.2.0
1205 - Upgrade spring.boot to 2.3.8.RELEASE
1206 - Upgrade yangtools to 5.0.7
1208 *Known Security Issues*
1210 * Weak Crytography using md5
1211 * Risk seen in Zip file expansion
1213 *Known Vulnerabilities in Used Modules*
1217 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.
1221 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1226 For more information on the latest ONAP release, please see:
1228 #. `ONAP Home Page`_
1229 #. `ONAP Wiki Page`_
1230 #. `ONAP Documentation`_
1231 #. `ONAP CPS Documentation`_
1232 #. `ONAP Release Downloads`_
1235 .. _`ONAP Home Page`: https://www.onap.org
1236 .. _`ONAP Wiki Page`: https://wiki.onap.org
1237 .. _`ONAP Documentation`: https://docs.onap.org
1238 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1239 .. _`ONAP Release Downloads`: https://git.onap.org
1243 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1244 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_