1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (C) 2021-2023 Nordix Foundation
5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
15 .. ========================
16 .. * * * MONTREAL * * *
17 .. ========================
25 +--------------------------------------+--------------------------------------------------------+
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images** | onap/cps-and-ncmp:3.3.7 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.3.7 Montreal |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | Not yet released |
37 +--------------------------------------+--------------------------------------------------------+
42 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
53 +--------------------------------------+--------------------------------------------------------+
56 +--------------------------------------+--------------------------------------------------------+
57 | **Docker images** | onap/cps-and-ncmp:3.3.6 |
59 +--------------------------------------+--------------------------------------------------------+
60 | **Release designation** | 3.3.6 Montreal |
62 +--------------------------------------+--------------------------------------------------------+
63 | **Release date** | 2023 August 23 |
65 +--------------------------------------+--------------------------------------------------------+
70 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
71 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
75 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
76 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
85 +--------------------------------------+--------------------------------------------------------+
88 +--------------------------------------+--------------------------------------------------------+
89 | **Docker images** | onap/cps-and-ncmp:3.3.5 |
91 +--------------------------------------+--------------------------------------------------------+
92 | **Release designation** | 3.3.5 Montreal |
94 +--------------------------------------+--------------------------------------------------------+
95 | **Release date** | 2023 July 21 |
97 +--------------------------------------+--------------------------------------------------------+
105 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
113 +--------------------------------------+--------------------------------------------------------+
114 | **CPS Project** | |
116 +--------------------------------------+--------------------------------------------------------+
117 | **Docker images** | onap/cps-and-ncmp:3.3.4 |
119 +--------------------------------------+--------------------------------------------------------+
120 | **Release designation** | 3.3.4 Montreal |
122 +--------------------------------------+--------------------------------------------------------+
123 | **Release date** | 2023 July 19 |
125 +--------------------------------------+--------------------------------------------------------+
133 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
141 +--------------------------------------+--------------------------------------------------------+
142 | **CPS Project** | |
144 +--------------------------------------+--------------------------------------------------------+
145 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
147 +--------------------------------------+--------------------------------------------------------+
148 | **Release designation** | 3.3.3 Montreal |
150 +--------------------------------------+--------------------------------------------------------+
151 | **Release date** | 2023 June 30 |
153 +--------------------------------------+--------------------------------------------------------+
161 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
162 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
163 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
171 +--------------------------------------+--------------------------------------------------------+
172 | **CPS Project** | |
174 +--------------------------------------+--------------------------------------------------------+
175 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
177 +--------------------------------------+--------------------------------------------------------+
178 | **Release designation** | 3.3.2 Montreal |
180 +--------------------------------------+--------------------------------------------------------+
181 | **Release date** | 2023 June 15 |
183 +--------------------------------------+--------------------------------------------------------+
188 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
192 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
193 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
194 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
195 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
196 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
204 +--------------------------------------+--------------------------------------------------------+
205 | **CPS Project** | |
207 +--------------------------------------+--------------------------------------------------------+
208 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
210 +--------------------------------------+--------------------------------------------------------+
211 | **Release designation** | 3.3.1 Montreal |
213 +--------------------------------------+--------------------------------------------------------+
214 | **Release date** | 2023 May 03 |
216 +--------------------------------------+--------------------------------------------------------+
225 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
226 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
227 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
228 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
229 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
237 +--------------------------------------+--------------------------------------------------------+
238 | **CPS Project** | |
240 +--------------------------------------+--------------------------------------------------------+
241 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
243 +--------------------------------------+--------------------------------------------------------+
244 | **Release designation** | 3.3.0 Montreal |
246 +--------------------------------------+--------------------------------------------------------+
247 | **Release date** | 2023 April 20 |
249 +--------------------------------------+--------------------------------------------------------+
258 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
259 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
261 .. ======================
262 .. * * * LONDON * * *
263 .. ======================
271 +--------------------------------------+--------------------------------------------------------+
272 | **CPS Project** | |
274 +--------------------------------------+--------------------------------------------------------+
275 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
277 +--------------------------------------+--------------------------------------------------------+
278 | **Release designation** | 3.2.6 London |
280 +--------------------------------------+--------------------------------------------------------+
281 | **Release date** | 2023 March 22 |
283 +--------------------------------------+--------------------------------------------------------+
288 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
289 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
293 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
301 +--------------------------------------+--------------------------------------------------------+
302 | **CPS Project** | |
304 +--------------------------------------+--------------------------------------------------------+
305 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
307 +--------------------------------------+--------------------------------------------------------+
308 | **Release designation** | 3.2.5 London |
310 +--------------------------------------+--------------------------------------------------------+
311 | **Release date** | 2023 March 10 |
313 +--------------------------------------+--------------------------------------------------------+
318 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
330 +--------------------------------------+--------------------------------------------------------+
331 | **CPS Project** | |
333 +--------------------------------------+--------------------------------------------------------+
334 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
336 +--------------------------------------+--------------------------------------------------------+
337 | **Release designation** | 3.2.4 London |
339 +--------------------------------------+--------------------------------------------------------+
340 | **Release date** | 2023 March 09 |
342 +--------------------------------------+--------------------------------------------------------+
347 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
348 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
360 +--------------------------------------+--------------------------------------------------------+
361 | **CPS Project** | |
363 +--------------------------------------+--------------------------------------------------------+
364 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
366 +--------------------------------------+--------------------------------------------------------+
367 | **Release designation** | 3.2.3 London |
369 +--------------------------------------+--------------------------------------------------------+
370 | **Release date** | 2023 March 07 |
372 +--------------------------------------+--------------------------------------------------------+
377 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
381 - `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
382 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
390 +--------------------------------------+--------------------------------------------------------+
391 | **CPS Project** | |
393 +--------------------------------------+--------------------------------------------------------+
394 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
396 +--------------------------------------+--------------------------------------------------------+
397 | **Release designation** | 3.2.2 London |
399 +--------------------------------------+--------------------------------------------------------+
400 | **Release date** | 2023 February 08 |
402 +--------------------------------------+--------------------------------------------------------+
407 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
419 +--------------------------------------+--------------------------------------------------------+
420 | **CPS Project** | |
422 +--------------------------------------+--------------------------------------------------------+
423 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
425 +--------------------------------------+--------------------------------------------------------+
426 | **Release designation** | 3.2.1 London |
428 +--------------------------------------+--------------------------------------------------------+
429 | **Release date** | 2023 January 27 |
431 +--------------------------------------+--------------------------------------------------------+
436 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
437 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
438 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
439 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
440 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
441 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
442 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
443 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
444 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
445 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
446 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
447 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
448 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
453 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
454 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
455 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
456 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
457 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
458 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
459 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
460 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
461 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
462 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
463 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
464 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
465 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
466 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
469 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
471 Known Limitations, Issues and Workarounds
472 -----------------------------------------
476 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
477 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.
479 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
480 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
482 .. ====================
484 .. ====================
492 +--------------------------------------+--------------------------------------------------------+
493 | **CPS Project** | |
495 +--------------------------------------+--------------------------------------------------------+
496 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
498 +--------------------------------------+--------------------------------------------------------+
499 | **Release designation** | 3.1.4 Kohn |
501 +--------------------------------------+--------------------------------------------------------+
502 | **Release date** | 2022 October 5 |
504 +--------------------------------------+--------------------------------------------------------+
508 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
509 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
517 +--------------------------------------+--------------------------------------------------------+
518 | **CPS Project** | |
520 +--------------------------------------+--------------------------------------------------------+
521 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
523 +--------------------------------------+--------------------------------------------------------+
524 | **Release designation** | 3.1.3 Kohn |
526 +--------------------------------------+--------------------------------------------------------+
527 | **Release date** | 2022 September 29 |
529 +--------------------------------------+--------------------------------------------------------+
541 +--------------------------------------+--------------------------------------------------------+
542 | **CPS Project** | |
544 +--------------------------------------+--------------------------------------------------------+
545 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
547 +--------------------------------------+--------------------------------------------------------+
548 | **Release designation** | 3.1.2 Kohn |
550 +--------------------------------------+--------------------------------------------------------+
551 | **Release date** | 2022 September 28 |
553 +--------------------------------------+--------------------------------------------------------+
565 +--------------------------------------+--------------------------------------------------------+
566 | **CPS Project** | |
568 +--------------------------------------+--------------------------------------------------------+
569 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
571 +--------------------------------------+--------------------------------------------------------+
572 | **Release designation** | 3.1.1 Kohn |
574 +--------------------------------------+--------------------------------------------------------+
575 | **Release date** | 2022 September 28 |
577 +--------------------------------------+--------------------------------------------------------+
586 *Fixed Security Issues*
588 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
596 +--------------------------------------+--------------------------------------------------------+
597 | **CPS Project** | |
599 +--------------------------------------+--------------------------------------------------------+
600 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
602 +--------------------------------------+--------------------------------------------------------+
603 | **Release designation** | 3.1.0 Kohn |
605 +--------------------------------------+--------------------------------------------------------+
606 | **Release date** | 2022 September 14 |
608 +--------------------------------------+--------------------------------------------------------+
612 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
613 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
614 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
615 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
616 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
617 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
618 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
619 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
620 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
621 - `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'
622 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
623 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
624 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
625 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
626 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
627 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
628 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
629 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
630 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
631 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
632 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
633 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
634 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
635 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
640 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
641 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
642 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
643 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
644 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
645 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
646 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
647 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
648 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
649 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
650 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
651 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
652 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
653 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
655 Known Limitations, Issues and Workarounds
656 -----------------------------------------
660 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
661 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
663 *Known Vulnerabilities*
674 *Fixed Security Issues*
676 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
678 *Known Security Issues*
682 .. ========================
683 .. * * * JAKARTA * * *
684 .. ========================
692 +--------------------------------------+--------------------------------------------------------+
693 | **CPS Project** | |
695 +--------------------------------------+--------------------------------------------------------+
696 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
698 +--------------------------------------+--------------------------------------------------------+
699 | **Release designation** | 3.0.1 Jakarta |
701 +--------------------------------------+--------------------------------------------------------+
702 | **Release date** | 2022 April 28 |
704 +--------------------------------------+--------------------------------------------------------+
708 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
716 +--------------------------------------+--------------------------------------------------------+
717 | **CPS Project** | |
719 +--------------------------------------+--------------------------------------------------------+
720 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
722 +--------------------------------------+--------------------------------------------------------+
723 | **Release designation** | 3.0.0 Jakarta |
725 +--------------------------------------+--------------------------------------------------------+
726 | **Release date** | 2022 March 15 |
728 +--------------------------------------+--------------------------------------------------------+
732 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
733 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
734 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
735 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
736 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
737 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
738 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
739 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
740 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
741 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
742 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
747 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
748 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
749 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
750 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
751 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
752 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
753 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
754 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
755 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
756 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
758 Known Limitations, Issues and Workarounds
759 -----------------------------------------
763 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
764 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
765 of cm handle registration.
767 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
768 for more information.
770 *Known Vulnerabilities*
776 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
777 pass an empty string as the value if you do not want to include names for these values.
782 *Fixed Security Issues*
786 *Known Security Issues*
790 .. ========================
791 .. * * * ISTANBUL * * *
792 .. ========================
800 +--------------------------------------+--------------------------------------------------------+
801 | **CPS Project** | |
803 +--------------------------------------+--------------------------------------------------------+
804 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
806 +--------------------------------------+--------------------------------------------------------+
807 | **Release designation** | 2.0.4 Istanbul |
809 +--------------------------------------+--------------------------------------------------------+
810 | **Release date** | 2022 Feb 09 |
812 +--------------------------------------+--------------------------------------------------------+
817 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
818 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
826 +--------------------------------------+--------------------------------------------------------+
827 | **CPS Project** | |
829 +--------------------------------------+--------------------------------------------------------+
830 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
832 +--------------------------------------+--------------------------------------------------------+
833 | **Release designation** | 2.0.3 Istanbul |
835 +--------------------------------------+--------------------------------------------------------+
836 | **Release date** | 2022-07-01 |
838 +--------------------------------------+--------------------------------------------------------+
843 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
851 +--------------------------------------+--------------------------------------------------------+
852 | **CPS Project** | |
854 +--------------------------------------+--------------------------------------------------------+
855 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
857 +--------------------------------------+--------------------------------------------------------+
858 | **Release designation** | 2.0.2 Istanbul |
860 +--------------------------------------+--------------------------------------------------------+
861 | **Release date** | 2021-16-12 |
863 +--------------------------------------+--------------------------------------------------------+
868 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
876 +--------------------------------------+--------------------------------------------------------+
877 | **CPS Project** | |
879 +--------------------------------------+--------------------------------------------------------+
880 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
882 +--------------------------------------+--------------------------------------------------------+
883 | **Release designation** | 2.0.1 Istanbul |
885 +--------------------------------------+--------------------------------------------------------+
886 | **Release date** | 2021-14-10 |
888 +--------------------------------------+--------------------------------------------------------+
893 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
894 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
895 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
896 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
898 Known Limitations, Issues and Workarounds
899 -----------------------------------------
903 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
905 *Known Vulnerabilities*
907 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
911 Add recursive method to save list node data to loop through all corresponding child nodes.
916 *Fixed Security Issues*
918 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
920 *Known Security Issues*
930 This document provides the release notes for Istanbul release.
935 +--------------------------------------+--------------------------------------------------------+
936 | **CPS Project** | |
938 +--------------------------------------+--------------------------------------------------------+
939 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
941 +--------------------------------------+--------------------------------------------------------+
942 | **Release designation** | 2.0.0 Istanbul |
944 +--------------------------------------+--------------------------------------------------------+
945 | **Release date** | 2021-14-09 |
947 +--------------------------------------+--------------------------------------------------------+
951 * Register DMI-Plugins with NCMP for CM Handle registrations.
952 * Update, Create and Remove CM Handles.
953 * Add support for retrieving and writing CM Handle data through NCMP datastores.
954 * Automatic retrieval and caching of model information for CM Handles within NCMP.
959 Software Deliverables
962 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
965 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
970 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
971 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
972 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
973 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
974 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
975 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
976 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
977 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
978 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
979 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
980 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
981 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
982 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
983 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
984 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
985 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
986 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
987 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
988 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
989 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
990 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
991 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
992 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
993 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
994 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
995 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
997 This document provides the release notes for Istanbul release.
1002 Following CPS components are available with default ONAP/CPS installation.
1005 * Platform components
1009 * Service components
1015 * Additional resources that CPS utilizes deployed using ONAP common charts
1020 Below service components (mS) are available to be deployed on-demand.
1024 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1026 Known Limitations, Issues and Workarounds
1027 -----------------------------------------
1029 *System Limitations*
1031 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1033 *Known Vulnerabilities*
1035 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1036 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1037 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1041 Add recursive method to save list node data to loop through all corresponding child nodes.
1046 *Fixed Security Issues*
1048 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1050 *Known Security Issues*
1052 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1056 * `Integration tests`
1058 .. ========================
1059 .. * * * HONOLULU * * *
1060 .. ========================
1068 +--------------------------------------+--------------------------------------------------------+
1069 | **CPS Project** | |
1071 +--------------------------------------+--------------------------------------------------------+
1072 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1074 +--------------------------------------+--------------------------------------------------------+
1075 | **Release designation** | 1.0.1 Honolulu |
1077 +--------------------------------------+--------------------------------------------------------+
1078 | **Release date** | 2021-04-09 |
1080 +--------------------------------------+--------------------------------------------------------+
1085 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1086 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1087 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1088 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1089 - `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
1090 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1091 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1092 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1097 *Fixed Security Issues*
1099 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1101 *Known Security Issues*
1103 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1112 This document provides the release notes for Honolulu release.
1117 Following CPS components are available with default ONAP/CPS installation.
1120 * Platform components
1124 * Service components
1128 * Additional resources that CPS utilizes deployed using ONAP common charts
1133 Below service components (mS) are available to be deployed on-demand.
1137 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1143 +--------------------------------------+--------------------------------------------------------+
1144 | **CPS Project** | |
1146 +--------------------------------------+--------------------------------------------------------+
1147 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1149 +--------------------------------------+--------------------------------------------------------+
1150 | **Release designation** | 1.0.0 Honolulu |
1152 +--------------------------------------+--------------------------------------------------------+
1153 | **Release date** | 2021-03-11 |
1155 +--------------------------------------+--------------------------------------------------------+
1160 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1161 CPS has been driven by the needs of the E2E Networking Slicing use case.
1162 It currently supports basic (rw) persistence and simple queries.
1163 It also provides MVP support for network data access using simulated data.
1165 .. _honolulu_deliverable:
1170 Software Deliverables
1173 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1176 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1179 Known Limitations, Issues and Workarounds
1180 -----------------------------------------
1182 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1183 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1184 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1185 - `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.
1187 *System Limitations*
1191 *Known Vulnerabilities*
1197 Documented under corresponding jira if applicable.
1202 *Fixed Security Issues*
1204 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1205 - Upgrade org.onap.oparent to 3.2.0
1206 - Upgrade spring.boot to 2.3.8.RELEASE
1207 - Upgrade yangtools to 5.0.7
1209 *Known Security Issues*
1211 * Weak Crytography using md5
1212 * Risk seen in Zip file expansion
1214 *Known Vulnerabilities in Used Modules*
1218 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.
1222 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1227 For more information on the latest ONAP release, please see:
1229 #. `ONAP Home Page`_
1230 #. `ONAP Wiki Page`_
1231 #. `ONAP Documentation`_
1232 #. `ONAP CPS Documentation`_
1233 #. `ONAP Release Downloads`_
1236 .. _`ONAP Home Page`: https://www.onap.org
1237 .. _`ONAP Wiki Page`: https://wiki.onap.org
1238 .. _`ONAP Documentation`: https://docs.onap.org
1239 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1240 .. _`ONAP Release Downloads`: https://git.onap.org
1244 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1245 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_