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.8 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.3.8 Montreal |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | Not yet released |
37 +--------------------------------------+--------------------------------------------------------+
52 +--------------------------------------+--------------------------------------------------------+
55 +--------------------------------------+--------------------------------------------------------+
56 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
58 +--------------------------------------+--------------------------------------------------------+
59 | **Release designation** | 3.3.7 Montreal |
61 +--------------------------------------+--------------------------------------------------------+
62 | **Release date** | 2023 September 20 |
64 +--------------------------------------+--------------------------------------------------------+
69 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
73 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
77 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
85 +--------------------------------------+--------------------------------------------------------+
88 +--------------------------------------+--------------------------------------------------------+
89 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
91 +--------------------------------------+--------------------------------------------------------+
92 | **Release designation** | 3.3.6 Montreal |
94 +--------------------------------------+--------------------------------------------------------+
95 | **Release date** | 2023 August 23 |
97 +--------------------------------------+--------------------------------------------------------+
102 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
103 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
107 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
108 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
117 +--------------------------------------+--------------------------------------------------------+
118 | **CPS Project** | |
120 +--------------------------------------+--------------------------------------------------------+
121 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
123 +--------------------------------------+--------------------------------------------------------+
124 | **Release designation** | 3.3.5 Montreal |
126 +--------------------------------------+--------------------------------------------------------+
127 | **Release date** | 2023 July 21 |
129 +--------------------------------------+--------------------------------------------------------+
137 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
145 +--------------------------------------+--------------------------------------------------------+
146 | **CPS Project** | |
148 +--------------------------------------+--------------------------------------------------------+
149 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
151 +--------------------------------------+--------------------------------------------------------+
152 | **Release designation** | 3.3.4 Montreal |
154 +--------------------------------------+--------------------------------------------------------+
155 | **Release date** | 2023 July 19 |
157 +--------------------------------------+--------------------------------------------------------+
165 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
173 +--------------------------------------+--------------------------------------------------------+
174 | **CPS Project** | |
176 +--------------------------------------+--------------------------------------------------------+
177 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
179 +--------------------------------------+--------------------------------------------------------+
180 | **Release designation** | 3.3.3 Montreal |
182 +--------------------------------------+--------------------------------------------------------+
183 | **Release date** | 2023 June 30 |
185 +--------------------------------------+--------------------------------------------------------+
193 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
194 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
195 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
203 +--------------------------------------+--------------------------------------------------------+
204 | **CPS Project** | |
206 +--------------------------------------+--------------------------------------------------------+
207 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
209 +--------------------------------------+--------------------------------------------------------+
210 | **Release designation** | 3.3.2 Montreal |
212 +--------------------------------------+--------------------------------------------------------+
213 | **Release date** | 2023 June 15 |
215 +--------------------------------------+--------------------------------------------------------+
220 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
224 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
225 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
226 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
227 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
228 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
236 +--------------------------------------+--------------------------------------------------------+
237 | **CPS Project** | |
239 +--------------------------------------+--------------------------------------------------------+
240 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
242 +--------------------------------------+--------------------------------------------------------+
243 | **Release designation** | 3.3.1 Montreal |
245 +--------------------------------------+--------------------------------------------------------+
246 | **Release date** | 2023 May 03 |
248 +--------------------------------------+--------------------------------------------------------+
257 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
258 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
259 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
260 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
261 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
269 +--------------------------------------+--------------------------------------------------------+
270 | **CPS Project** | |
272 +--------------------------------------+--------------------------------------------------------+
273 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
275 +--------------------------------------+--------------------------------------------------------+
276 | **Release designation** | 3.3.0 Montreal |
278 +--------------------------------------+--------------------------------------------------------+
279 | **Release date** | 2023 April 20 |
281 +--------------------------------------+--------------------------------------------------------+
290 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
291 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
293 .. ======================
294 .. * * * LONDON * * *
295 .. ======================
303 +--------------------------------------+--------------------------------------------------------+
304 | **CPS Project** | |
306 +--------------------------------------+--------------------------------------------------------+
307 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
309 +--------------------------------------+--------------------------------------------------------+
310 | **Release designation** | 3.2.6 London |
312 +--------------------------------------+--------------------------------------------------------+
313 | **Release date** | 2023 March 22 |
315 +--------------------------------------+--------------------------------------------------------+
320 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
321 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
325 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
333 +--------------------------------------+--------------------------------------------------------+
334 | **CPS Project** | |
336 +--------------------------------------+--------------------------------------------------------+
337 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
339 +--------------------------------------+--------------------------------------------------------+
340 | **Release designation** | 3.2.5 London |
342 +--------------------------------------+--------------------------------------------------------+
343 | **Release date** | 2023 March 10 |
345 +--------------------------------------+--------------------------------------------------------+
350 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
362 +--------------------------------------+--------------------------------------------------------+
363 | **CPS Project** | |
365 +--------------------------------------+--------------------------------------------------------+
366 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
368 +--------------------------------------+--------------------------------------------------------+
369 | **Release designation** | 3.2.4 London |
371 +--------------------------------------+--------------------------------------------------------+
372 | **Release date** | 2023 March 09 |
374 +--------------------------------------+--------------------------------------------------------+
379 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
380 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
392 +--------------------------------------+--------------------------------------------------------+
393 | **CPS Project** | |
395 +--------------------------------------+--------------------------------------------------------+
396 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
398 +--------------------------------------+--------------------------------------------------------+
399 | **Release designation** | 3.2.3 London |
401 +--------------------------------------+--------------------------------------------------------+
402 | **Release date** | 2023 March 07 |
404 +--------------------------------------+--------------------------------------------------------+
409 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
413 - `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
414 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
422 +--------------------------------------+--------------------------------------------------------+
423 | **CPS Project** | |
425 +--------------------------------------+--------------------------------------------------------+
426 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
428 +--------------------------------------+--------------------------------------------------------+
429 | **Release designation** | 3.2.2 London |
431 +--------------------------------------+--------------------------------------------------------+
432 | **Release date** | 2023 February 08 |
434 +--------------------------------------+--------------------------------------------------------+
439 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
451 +--------------------------------------+--------------------------------------------------------+
452 | **CPS Project** | |
454 +--------------------------------------+--------------------------------------------------------+
455 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
457 +--------------------------------------+--------------------------------------------------------+
458 | **Release designation** | 3.2.1 London |
460 +--------------------------------------+--------------------------------------------------------+
461 | **Release date** | 2023 January 27 |
463 +--------------------------------------+--------------------------------------------------------+
468 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
469 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
470 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
471 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
472 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
473 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
474 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
475 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
476 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
477 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
478 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
479 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
480 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
485 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
486 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
487 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
488 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
489 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
490 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
491 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
492 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
493 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
494 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
495 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
496 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
497 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
498 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
501 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
503 Known Limitations, Issues and Workarounds
504 -----------------------------------------
508 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
509 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.
511 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
512 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
514 .. ====================
516 .. ====================
524 +--------------------------------------+--------------------------------------------------------+
525 | **CPS Project** | |
527 +--------------------------------------+--------------------------------------------------------+
528 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
530 +--------------------------------------+--------------------------------------------------------+
531 | **Release designation** | 3.1.4 Kohn |
533 +--------------------------------------+--------------------------------------------------------+
534 | **Release date** | 2022 October 5 |
536 +--------------------------------------+--------------------------------------------------------+
540 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
541 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
549 +--------------------------------------+--------------------------------------------------------+
550 | **CPS Project** | |
552 +--------------------------------------+--------------------------------------------------------+
553 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
555 +--------------------------------------+--------------------------------------------------------+
556 | **Release designation** | 3.1.3 Kohn |
558 +--------------------------------------+--------------------------------------------------------+
559 | **Release date** | 2022 September 29 |
561 +--------------------------------------+--------------------------------------------------------+
573 +--------------------------------------+--------------------------------------------------------+
574 | **CPS Project** | |
576 +--------------------------------------+--------------------------------------------------------+
577 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
579 +--------------------------------------+--------------------------------------------------------+
580 | **Release designation** | 3.1.2 Kohn |
582 +--------------------------------------+--------------------------------------------------------+
583 | **Release date** | 2022 September 28 |
585 +--------------------------------------+--------------------------------------------------------+
597 +--------------------------------------+--------------------------------------------------------+
598 | **CPS Project** | |
600 +--------------------------------------+--------------------------------------------------------+
601 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
603 +--------------------------------------+--------------------------------------------------------+
604 | **Release designation** | 3.1.1 Kohn |
606 +--------------------------------------+--------------------------------------------------------+
607 | **Release date** | 2022 September 28 |
609 +--------------------------------------+--------------------------------------------------------+
618 *Fixed Security Issues*
620 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
628 +--------------------------------------+--------------------------------------------------------+
629 | **CPS Project** | |
631 +--------------------------------------+--------------------------------------------------------+
632 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
634 +--------------------------------------+--------------------------------------------------------+
635 | **Release designation** | 3.1.0 Kohn |
637 +--------------------------------------+--------------------------------------------------------+
638 | **Release date** | 2022 September 14 |
640 +--------------------------------------+--------------------------------------------------------+
644 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
645 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
646 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
647 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
648 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
649 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
650 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
651 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
652 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
653 - `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'
654 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
655 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
656 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
657 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
658 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
659 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
660 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
661 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
662 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
663 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
664 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
665 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
666 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
667 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
672 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
673 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
674 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
675 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
676 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
677 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
678 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
679 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
680 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
681 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
682 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
683 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
684 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
685 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
687 Known Limitations, Issues and Workarounds
688 -----------------------------------------
692 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
693 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
695 *Known Vulnerabilities*
706 *Fixed Security Issues*
708 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
710 *Known Security Issues*
714 .. ========================
715 .. * * * JAKARTA * * *
716 .. ========================
724 +--------------------------------------+--------------------------------------------------------+
725 | **CPS Project** | |
727 +--------------------------------------+--------------------------------------------------------+
728 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
730 +--------------------------------------+--------------------------------------------------------+
731 | **Release designation** | 3.0.1 Jakarta |
733 +--------------------------------------+--------------------------------------------------------+
734 | **Release date** | 2022 April 28 |
736 +--------------------------------------+--------------------------------------------------------+
740 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
748 +--------------------------------------+--------------------------------------------------------+
749 | **CPS Project** | |
751 +--------------------------------------+--------------------------------------------------------+
752 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
754 +--------------------------------------+--------------------------------------------------------+
755 | **Release designation** | 3.0.0 Jakarta |
757 +--------------------------------------+--------------------------------------------------------+
758 | **Release date** | 2022 March 15 |
760 +--------------------------------------+--------------------------------------------------------+
764 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
765 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
766 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
767 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
768 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
769 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
770 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
771 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
772 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
773 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
774 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
779 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
780 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
781 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
782 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
783 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
784 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
785 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
786 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
787 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
788 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
790 Known Limitations, Issues and Workarounds
791 -----------------------------------------
795 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
796 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
797 of cm handle registration.
799 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
800 for more information.
802 *Known Vulnerabilities*
808 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
809 pass an empty string as the value if you do not want to include names for these values.
814 *Fixed Security Issues*
818 *Known Security Issues*
822 .. ========================
823 .. * * * ISTANBUL * * *
824 .. ========================
832 +--------------------------------------+--------------------------------------------------------+
833 | **CPS Project** | |
835 +--------------------------------------+--------------------------------------------------------+
836 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
838 +--------------------------------------+--------------------------------------------------------+
839 | **Release designation** | 2.0.4 Istanbul |
841 +--------------------------------------+--------------------------------------------------------+
842 | **Release date** | 2022 Feb 09 |
844 +--------------------------------------+--------------------------------------------------------+
849 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
850 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
858 +--------------------------------------+--------------------------------------------------------+
859 | **CPS Project** | |
861 +--------------------------------------+--------------------------------------------------------+
862 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
864 +--------------------------------------+--------------------------------------------------------+
865 | **Release designation** | 2.0.3 Istanbul |
867 +--------------------------------------+--------------------------------------------------------+
868 | **Release date** | 2022-07-01 |
870 +--------------------------------------+--------------------------------------------------------+
875 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
883 +--------------------------------------+--------------------------------------------------------+
884 | **CPS Project** | |
886 +--------------------------------------+--------------------------------------------------------+
887 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
889 +--------------------------------------+--------------------------------------------------------+
890 | **Release designation** | 2.0.2 Istanbul |
892 +--------------------------------------+--------------------------------------------------------+
893 | **Release date** | 2021-16-12 |
895 +--------------------------------------+--------------------------------------------------------+
900 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
908 +--------------------------------------+--------------------------------------------------------+
909 | **CPS Project** | |
911 +--------------------------------------+--------------------------------------------------------+
912 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
914 +--------------------------------------+--------------------------------------------------------+
915 | **Release designation** | 2.0.1 Istanbul |
917 +--------------------------------------+--------------------------------------------------------+
918 | **Release date** | 2021-14-10 |
920 +--------------------------------------+--------------------------------------------------------+
925 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
926 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
927 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
928 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
930 Known Limitations, Issues and Workarounds
931 -----------------------------------------
935 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
937 *Known Vulnerabilities*
939 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
943 Add recursive method to save list node data to loop through all corresponding child nodes.
948 *Fixed Security Issues*
950 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
952 *Known Security Issues*
962 This document provides the release notes for Istanbul release.
967 +--------------------------------------+--------------------------------------------------------+
968 | **CPS Project** | |
970 +--------------------------------------+--------------------------------------------------------+
971 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
973 +--------------------------------------+--------------------------------------------------------+
974 | **Release designation** | 2.0.0 Istanbul |
976 +--------------------------------------+--------------------------------------------------------+
977 | **Release date** | 2021-14-09 |
979 +--------------------------------------+--------------------------------------------------------+
983 * Register DMI-Plugins with NCMP for CM Handle registrations.
984 * Update, Create and Remove CM Handles.
985 * Add support for retrieving and writing CM Handle data through NCMP datastores.
986 * Automatic retrieval and caching of model information for CM Handles within NCMP.
991 Software Deliverables
994 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
997 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1002 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1003 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1004 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1005 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1006 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1007 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1008 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1009 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1010 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1011 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1012 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1013 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1014 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1015 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1016 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1017 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1018 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1019 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1020 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1021 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1022 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1023 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1024 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1025 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1026 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1027 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1029 This document provides the release notes for Istanbul release.
1034 Following CPS components are available with default ONAP/CPS installation.
1037 * Platform components
1041 * Service components
1047 * Additional resources that CPS utilizes deployed using ONAP common charts
1052 Below service components (mS) are available to be deployed on-demand.
1056 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1058 Known Limitations, Issues and Workarounds
1059 -----------------------------------------
1061 *System Limitations*
1063 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1065 *Known Vulnerabilities*
1067 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1068 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1069 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1073 Add recursive method to save list node data to loop through all corresponding child nodes.
1078 *Fixed Security Issues*
1080 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1082 *Known Security Issues*
1084 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1088 * `Integration tests`
1090 .. ========================
1091 .. * * * HONOLULU * * *
1092 .. ========================
1100 +--------------------------------------+--------------------------------------------------------+
1101 | **CPS Project** | |
1103 +--------------------------------------+--------------------------------------------------------+
1104 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1106 +--------------------------------------+--------------------------------------------------------+
1107 | **Release designation** | 1.0.1 Honolulu |
1109 +--------------------------------------+--------------------------------------------------------+
1110 | **Release date** | 2021-04-09 |
1112 +--------------------------------------+--------------------------------------------------------+
1117 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1118 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1119 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1120 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1121 - `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
1122 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1123 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1124 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1129 *Fixed Security Issues*
1131 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1133 *Known Security Issues*
1135 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1144 This document provides the release notes for Honolulu release.
1149 Following CPS components are available with default ONAP/CPS installation.
1152 * Platform components
1156 * Service components
1160 * Additional resources that CPS utilizes deployed using ONAP common charts
1165 Below service components (mS) are available to be deployed on-demand.
1169 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1175 +--------------------------------------+--------------------------------------------------------+
1176 | **CPS Project** | |
1178 +--------------------------------------+--------------------------------------------------------+
1179 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1181 +--------------------------------------+--------------------------------------------------------+
1182 | **Release designation** | 1.0.0 Honolulu |
1184 +--------------------------------------+--------------------------------------------------------+
1185 | **Release date** | 2021-03-11 |
1187 +--------------------------------------+--------------------------------------------------------+
1192 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1193 CPS has been driven by the needs of the E2E Networking Slicing use case.
1194 It currently supports basic (rw) persistence and simple queries.
1195 It also provides MVP support for network data access using simulated data.
1197 .. _honolulu_deliverable:
1202 Software Deliverables
1205 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1208 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1211 Known Limitations, Issues and Workarounds
1212 -----------------------------------------
1214 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1215 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1216 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1217 - `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.
1219 *System Limitations*
1223 *Known Vulnerabilities*
1229 Documented under corresponding jira if applicable.
1234 *Fixed Security Issues*
1236 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1237 - Upgrade org.onap.oparent to 3.2.0
1238 - Upgrade spring.boot to 2.3.8.RELEASE
1239 - Upgrade yangtools to 5.0.7
1241 *Known Security Issues*
1243 * Weak Crytography using md5
1244 * Risk seen in Zip file expansion
1246 *Known Vulnerabilities in Used Modules*
1250 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.
1254 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1259 For more information on the latest ONAP release, please see:
1261 #. `ONAP Home Page`_
1262 #. `ONAP Wiki Page`_
1263 #. `ONAP Documentation`_
1264 #. `ONAP CPS Documentation`_
1265 #. `ONAP Release Downloads`_
1268 .. _`ONAP Home Page`: https://www.onap.org
1269 .. _`ONAP Wiki Page`: https://wiki.onap.org
1270 .. _`ONAP Documentation`: https://docs.onap.org
1271 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1272 .. _`ONAP Release Downloads`: https://git.onap.org
1276 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1277 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_