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
80 +--------------------------------------+--------------------------------------------------------+
83 +--------------------------------------+--------------------------------------------------------+
84 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
86 +--------------------------------------+--------------------------------------------------------+
87 | **Release designation** | 3.3.6 Montreal |
89 +--------------------------------------+--------------------------------------------------------+
90 | **Release date** | 2023 August 23 |
92 +--------------------------------------+--------------------------------------------------------+
97 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
98 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
102 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
103 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
112 +--------------------------------------+--------------------------------------------------------+
113 | **CPS Project** | |
115 +--------------------------------------+--------------------------------------------------------+
116 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
118 +--------------------------------------+--------------------------------------------------------+
119 | **Release designation** | 3.3.5 Montreal |
121 +--------------------------------------+--------------------------------------------------------+
122 | **Release date** | 2023 July 21 |
124 +--------------------------------------+--------------------------------------------------------+
132 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
140 +--------------------------------------+--------------------------------------------------------+
141 | **CPS Project** | |
143 +--------------------------------------+--------------------------------------------------------+
144 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
146 +--------------------------------------+--------------------------------------------------------+
147 | **Release designation** | 3.3.4 Montreal |
149 +--------------------------------------+--------------------------------------------------------+
150 | **Release date** | 2023 July 19 |
152 +--------------------------------------+--------------------------------------------------------+
160 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
168 +--------------------------------------+--------------------------------------------------------+
169 | **CPS Project** | |
171 +--------------------------------------+--------------------------------------------------------+
172 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
174 +--------------------------------------+--------------------------------------------------------+
175 | **Release designation** | 3.3.3 Montreal |
177 +--------------------------------------+--------------------------------------------------------+
178 | **Release date** | 2023 June 30 |
180 +--------------------------------------+--------------------------------------------------------+
188 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
189 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
190 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
198 +--------------------------------------+--------------------------------------------------------+
199 | **CPS Project** | |
201 +--------------------------------------+--------------------------------------------------------+
202 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
204 +--------------------------------------+--------------------------------------------------------+
205 | **Release designation** | 3.3.2 Montreal |
207 +--------------------------------------+--------------------------------------------------------+
208 | **Release date** | 2023 June 15 |
210 +--------------------------------------+--------------------------------------------------------+
215 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
219 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
220 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
221 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
222 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
223 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
231 +--------------------------------------+--------------------------------------------------------+
232 | **CPS Project** | |
234 +--------------------------------------+--------------------------------------------------------+
235 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
237 +--------------------------------------+--------------------------------------------------------+
238 | **Release designation** | 3.3.1 Montreal |
240 +--------------------------------------+--------------------------------------------------------+
241 | **Release date** | 2023 May 03 |
243 +--------------------------------------+--------------------------------------------------------+
252 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
253 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
254 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
255 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
256 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
264 +--------------------------------------+--------------------------------------------------------+
265 | **CPS Project** | |
267 +--------------------------------------+--------------------------------------------------------+
268 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
270 +--------------------------------------+--------------------------------------------------------+
271 | **Release designation** | 3.3.0 Montreal |
273 +--------------------------------------+--------------------------------------------------------+
274 | **Release date** | 2023 April 20 |
276 +--------------------------------------+--------------------------------------------------------+
285 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
286 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
288 .. ======================
289 .. * * * LONDON * * *
290 .. ======================
298 +--------------------------------------+--------------------------------------------------------+
299 | **CPS Project** | |
301 +--------------------------------------+--------------------------------------------------------+
302 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
304 +--------------------------------------+--------------------------------------------------------+
305 | **Release designation** | 3.2.6 London |
307 +--------------------------------------+--------------------------------------------------------+
308 | **Release date** | 2023 March 22 |
310 +--------------------------------------+--------------------------------------------------------+
315 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
316 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
320 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
328 +--------------------------------------+--------------------------------------------------------+
329 | **CPS Project** | |
331 +--------------------------------------+--------------------------------------------------------+
332 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
334 +--------------------------------------+--------------------------------------------------------+
335 | **Release designation** | 3.2.5 London |
337 +--------------------------------------+--------------------------------------------------------+
338 | **Release date** | 2023 March 10 |
340 +--------------------------------------+--------------------------------------------------------+
345 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
357 +--------------------------------------+--------------------------------------------------------+
358 | **CPS Project** | |
360 +--------------------------------------+--------------------------------------------------------+
361 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
363 +--------------------------------------+--------------------------------------------------------+
364 | **Release designation** | 3.2.4 London |
366 +--------------------------------------+--------------------------------------------------------+
367 | **Release date** | 2023 March 09 |
369 +--------------------------------------+--------------------------------------------------------+
374 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
375 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
387 +--------------------------------------+--------------------------------------------------------+
388 | **CPS Project** | |
390 +--------------------------------------+--------------------------------------------------------+
391 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
393 +--------------------------------------+--------------------------------------------------------+
394 | **Release designation** | 3.2.3 London |
396 +--------------------------------------+--------------------------------------------------------+
397 | **Release date** | 2023 March 07 |
399 +--------------------------------------+--------------------------------------------------------+
404 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
408 - `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
409 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
417 +--------------------------------------+--------------------------------------------------------+
418 | **CPS Project** | |
420 +--------------------------------------+--------------------------------------------------------+
421 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
423 +--------------------------------------+--------------------------------------------------------+
424 | **Release designation** | 3.2.2 London |
426 +--------------------------------------+--------------------------------------------------------+
427 | **Release date** | 2023 February 08 |
429 +--------------------------------------+--------------------------------------------------------+
434 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
446 +--------------------------------------+--------------------------------------------------------+
447 | **CPS Project** | |
449 +--------------------------------------+--------------------------------------------------------+
450 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
452 +--------------------------------------+--------------------------------------------------------+
453 | **Release designation** | 3.2.1 London |
455 +--------------------------------------+--------------------------------------------------------+
456 | **Release date** | 2023 January 27 |
458 +--------------------------------------+--------------------------------------------------------+
463 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
464 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
465 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
466 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
467 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
468 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
469 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
470 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
471 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
472 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
473 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
474 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
475 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
480 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
481 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
482 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
483 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
484 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
485 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
486 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
487 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
488 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
489 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
490 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
491 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
492 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
493 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
496 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
498 Known Limitations, Issues and Workarounds
499 -----------------------------------------
503 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
504 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.
506 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
507 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
509 .. ====================
511 .. ====================
519 +--------------------------------------+--------------------------------------------------------+
520 | **CPS Project** | |
522 +--------------------------------------+--------------------------------------------------------+
523 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
525 +--------------------------------------+--------------------------------------------------------+
526 | **Release designation** | 3.1.4 Kohn |
528 +--------------------------------------+--------------------------------------------------------+
529 | **Release date** | 2022 October 5 |
531 +--------------------------------------+--------------------------------------------------------+
535 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
536 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
544 +--------------------------------------+--------------------------------------------------------+
545 | **CPS Project** | |
547 +--------------------------------------+--------------------------------------------------------+
548 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
550 +--------------------------------------+--------------------------------------------------------+
551 | **Release designation** | 3.1.3 Kohn |
553 +--------------------------------------+--------------------------------------------------------+
554 | **Release date** | 2022 September 29 |
556 +--------------------------------------+--------------------------------------------------------+
568 +--------------------------------------+--------------------------------------------------------+
569 | **CPS Project** | |
571 +--------------------------------------+--------------------------------------------------------+
572 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
574 +--------------------------------------+--------------------------------------------------------+
575 | **Release designation** | 3.1.2 Kohn |
577 +--------------------------------------+--------------------------------------------------------+
578 | **Release date** | 2022 September 28 |
580 +--------------------------------------+--------------------------------------------------------+
592 +--------------------------------------+--------------------------------------------------------+
593 | **CPS Project** | |
595 +--------------------------------------+--------------------------------------------------------+
596 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
598 +--------------------------------------+--------------------------------------------------------+
599 | **Release designation** | 3.1.1 Kohn |
601 +--------------------------------------+--------------------------------------------------------+
602 | **Release date** | 2022 September 28 |
604 +--------------------------------------+--------------------------------------------------------+
613 *Fixed Security Issues*
615 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
623 +--------------------------------------+--------------------------------------------------------+
624 | **CPS Project** | |
626 +--------------------------------------+--------------------------------------------------------+
627 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
629 +--------------------------------------+--------------------------------------------------------+
630 | **Release designation** | 3.1.0 Kohn |
632 +--------------------------------------+--------------------------------------------------------+
633 | **Release date** | 2022 September 14 |
635 +--------------------------------------+--------------------------------------------------------+
639 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
640 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
641 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
642 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
643 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
644 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
645 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
646 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
647 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
648 - `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'
649 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
650 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
651 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
652 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
653 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
654 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
655 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
656 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
657 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
658 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
659 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
660 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
661 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
662 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
667 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
668 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
669 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
670 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
671 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
672 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
673 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
674 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
675 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
676 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
677 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
678 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
679 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
680 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
682 Known Limitations, Issues and Workarounds
683 -----------------------------------------
687 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
688 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
690 *Known Vulnerabilities*
701 *Fixed Security Issues*
703 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
705 *Known Security Issues*
709 .. ========================
710 .. * * * JAKARTA * * *
711 .. ========================
719 +--------------------------------------+--------------------------------------------------------+
720 | **CPS Project** | |
722 +--------------------------------------+--------------------------------------------------------+
723 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
725 +--------------------------------------+--------------------------------------------------------+
726 | **Release designation** | 3.0.1 Jakarta |
728 +--------------------------------------+--------------------------------------------------------+
729 | **Release date** | 2022 April 28 |
731 +--------------------------------------+--------------------------------------------------------+
735 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
743 +--------------------------------------+--------------------------------------------------------+
744 | **CPS Project** | |
746 +--------------------------------------+--------------------------------------------------------+
747 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
749 +--------------------------------------+--------------------------------------------------------+
750 | **Release designation** | 3.0.0 Jakarta |
752 +--------------------------------------+--------------------------------------------------------+
753 | **Release date** | 2022 March 15 |
755 +--------------------------------------+--------------------------------------------------------+
759 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
760 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
761 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
762 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
763 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
764 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
765 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
766 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
767 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
768 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
769 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
774 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
775 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
776 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
777 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
778 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
779 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
780 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
781 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
782 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
783 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
785 Known Limitations, Issues and Workarounds
786 -----------------------------------------
790 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
791 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
792 of cm handle registration.
794 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
795 for more information.
797 *Known Vulnerabilities*
803 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
804 pass an empty string as the value if you do not want to include names for these values.
809 *Fixed Security Issues*
813 *Known Security Issues*
817 .. ========================
818 .. * * * ISTANBUL * * *
819 .. ========================
827 +--------------------------------------+--------------------------------------------------------+
828 | **CPS Project** | |
830 +--------------------------------------+--------------------------------------------------------+
831 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
833 +--------------------------------------+--------------------------------------------------------+
834 | **Release designation** | 2.0.4 Istanbul |
836 +--------------------------------------+--------------------------------------------------------+
837 | **Release date** | 2022 Feb 09 |
839 +--------------------------------------+--------------------------------------------------------+
844 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
845 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
853 +--------------------------------------+--------------------------------------------------------+
854 | **CPS Project** | |
856 +--------------------------------------+--------------------------------------------------------+
857 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
859 +--------------------------------------+--------------------------------------------------------+
860 | **Release designation** | 2.0.3 Istanbul |
862 +--------------------------------------+--------------------------------------------------------+
863 | **Release date** | 2022-07-01 |
865 +--------------------------------------+--------------------------------------------------------+
870 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
878 +--------------------------------------+--------------------------------------------------------+
879 | **CPS Project** | |
881 +--------------------------------------+--------------------------------------------------------+
882 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
884 +--------------------------------------+--------------------------------------------------------+
885 | **Release designation** | 2.0.2 Istanbul |
887 +--------------------------------------+--------------------------------------------------------+
888 | **Release date** | 2021-16-12 |
890 +--------------------------------------+--------------------------------------------------------+
895 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
903 +--------------------------------------+--------------------------------------------------------+
904 | **CPS Project** | |
906 +--------------------------------------+--------------------------------------------------------+
907 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
909 +--------------------------------------+--------------------------------------------------------+
910 | **Release designation** | 2.0.1 Istanbul |
912 +--------------------------------------+--------------------------------------------------------+
913 | **Release date** | 2021-14-10 |
915 +--------------------------------------+--------------------------------------------------------+
920 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
921 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
922 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
923 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
925 Known Limitations, Issues and Workarounds
926 -----------------------------------------
930 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
932 *Known Vulnerabilities*
934 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
938 Add recursive method to save list node data to loop through all corresponding child nodes.
943 *Fixed Security Issues*
945 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
947 *Known Security Issues*
957 This document provides the release notes for Istanbul release.
962 +--------------------------------------+--------------------------------------------------------+
963 | **CPS Project** | |
965 +--------------------------------------+--------------------------------------------------------+
966 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
968 +--------------------------------------+--------------------------------------------------------+
969 | **Release designation** | 2.0.0 Istanbul |
971 +--------------------------------------+--------------------------------------------------------+
972 | **Release date** | 2021-14-09 |
974 +--------------------------------------+--------------------------------------------------------+
978 * Register DMI-Plugins with NCMP for CM Handle registrations.
979 * Update, Create and Remove CM Handles.
980 * Add support for retrieving and writing CM Handle data through NCMP datastores.
981 * Automatic retrieval and caching of model information for CM Handles within NCMP.
986 Software Deliverables
989 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
992 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
997 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
998 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
999 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1000 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1001 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1002 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1003 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1004 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1005 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1006 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1007 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1008 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1009 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1010 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1011 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1012 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1013 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1014 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1015 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1016 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1017 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1018 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1019 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1020 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1021 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1022 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1024 This document provides the release notes for Istanbul release.
1029 Following CPS components are available with default ONAP/CPS installation.
1032 * Platform components
1036 * Service components
1042 * Additional resources that CPS utilizes deployed using ONAP common charts
1047 Below service components (mS) are available to be deployed on-demand.
1051 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1053 Known Limitations, Issues and Workarounds
1054 -----------------------------------------
1056 *System Limitations*
1058 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1060 *Known Vulnerabilities*
1062 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1063 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1064 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1068 Add recursive method to save list node data to loop through all corresponding child nodes.
1073 *Fixed Security Issues*
1075 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1077 *Known Security Issues*
1079 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1083 * `Integration tests`
1085 .. ========================
1086 .. * * * HONOLULU * * *
1087 .. ========================
1095 +--------------------------------------+--------------------------------------------------------+
1096 | **CPS Project** | |
1098 +--------------------------------------+--------------------------------------------------------+
1099 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1101 +--------------------------------------+--------------------------------------------------------+
1102 | **Release designation** | 1.0.1 Honolulu |
1104 +--------------------------------------+--------------------------------------------------------+
1105 | **Release date** | 2021-04-09 |
1107 +--------------------------------------+--------------------------------------------------------+
1112 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1113 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1114 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1115 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1116 - `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
1117 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1118 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1119 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1124 *Fixed Security Issues*
1126 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1128 *Known Security Issues*
1130 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1139 This document provides the release notes for Honolulu release.
1144 Following CPS components are available with default ONAP/CPS installation.
1147 * Platform components
1151 * Service components
1155 * Additional resources that CPS utilizes deployed using ONAP common charts
1160 Below service components (mS) are available to be deployed on-demand.
1164 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1170 +--------------------------------------+--------------------------------------------------------+
1171 | **CPS Project** | |
1173 +--------------------------------------+--------------------------------------------------------+
1174 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1176 +--------------------------------------+--------------------------------------------------------+
1177 | **Release designation** | 1.0.0 Honolulu |
1179 +--------------------------------------+--------------------------------------------------------+
1180 | **Release date** | 2021-03-11 |
1182 +--------------------------------------+--------------------------------------------------------+
1187 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1188 CPS has been driven by the needs of the E2E Networking Slicing use case.
1189 It currently supports basic (rw) persistence and simple queries.
1190 It also provides MVP support for network data access using simulated data.
1192 .. _honolulu_deliverable:
1197 Software Deliverables
1200 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1203 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1206 Known Limitations, Issues and Workarounds
1207 -----------------------------------------
1209 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1210 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1211 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1212 - `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.
1214 *System Limitations*
1218 *Known Vulnerabilities*
1224 Documented under corresponding jira if applicable.
1229 *Fixed Security Issues*
1231 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1232 - Upgrade org.onap.oparent to 3.2.0
1233 - Upgrade spring.boot to 2.3.8.RELEASE
1234 - Upgrade yangtools to 5.0.7
1236 *Known Security Issues*
1238 * Weak Crytography using md5
1239 * Risk seen in Zip file expansion
1241 *Known Vulnerabilities in Used Modules*
1245 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.
1249 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1254 For more information on the latest ONAP release, please see:
1256 #. `ONAP Home Page`_
1257 #. `ONAP Wiki Page`_
1258 #. `ONAP Documentation`_
1259 #. `ONAP CPS Documentation`_
1260 #. `ONAP Release Downloads`_
1263 .. _`ONAP Home Page`: https://www.onap.org
1264 .. _`ONAP Wiki Page`: https://wiki.onap.org
1265 .. _`ONAP Documentation`: https://docs.onap.org
1266 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1267 .. _`ONAP Release Downloads`: https://git.onap.org
1271 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1272 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_