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.4 |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation** | 3.3.4 Montreal |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date** | Not yet released |
37 +--------------------------------------+--------------------------------------------------------+
45 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
53 +--------------------------------------+--------------------------------------------------------+
56 +--------------------------------------+--------------------------------------------------------+
57 | **Docker images** | onap/cps-and-ncmp:3.3.3 |
59 +--------------------------------------+--------------------------------------------------------+
60 | **Release designation** | 3.3.3 Montreal |
62 +--------------------------------------+--------------------------------------------------------+
63 | **Release date** | 2023 June 30 |
65 +--------------------------------------+--------------------------------------------------------+
73 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
74 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
75 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
83 +--------------------------------------+--------------------------------------------------------+
86 +--------------------------------------+--------------------------------------------------------+
87 | **Docker images** | onap/cps-and-ncmp:3.3.2 |
89 +--------------------------------------+--------------------------------------------------------+
90 | **Release designation** | 3.3.2 Montreal |
92 +--------------------------------------+--------------------------------------------------------+
93 | **Release date** | 2023 June 15 |
95 +--------------------------------------+--------------------------------------------------------+
100 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
104 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
105 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
106 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
107 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
108 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
116 +--------------------------------------+--------------------------------------------------------+
117 | **CPS Project** | |
119 +--------------------------------------+--------------------------------------------------------+
120 | **Docker images** | onap/cps-and-ncmp:3.3.1 |
122 +--------------------------------------+--------------------------------------------------------+
123 | **Release designation** | 3.3.1 Montreal |
125 +--------------------------------------+--------------------------------------------------------+
126 | **Release date** | 2023 May 03 |
128 +--------------------------------------+--------------------------------------------------------+
137 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
138 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
139 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
140 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
141 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
149 +--------------------------------------+--------------------------------------------------------+
150 | **CPS Project** | |
152 +--------------------------------------+--------------------------------------------------------+
153 | **Docker images** | onap/cps-and-ncmp:3.3.0 |
155 +--------------------------------------+--------------------------------------------------------+
156 | **Release designation** | 3.3.0 Montreal |
158 +--------------------------------------+--------------------------------------------------------+
159 | **Release date** | 2023 April 20 |
161 +--------------------------------------+--------------------------------------------------------+
170 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
171 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
173 .. ======================
174 .. * * * LONDON * * *
175 .. ======================
183 +--------------------------------------+--------------------------------------------------------+
184 | **CPS Project** | |
186 +--------------------------------------+--------------------------------------------------------+
187 | **Docker images** | onap/cps-and-ncmp:3.2.6 |
189 +--------------------------------------+--------------------------------------------------------+
190 | **Release designation** | 3.2.6 London |
192 +--------------------------------------+--------------------------------------------------------+
193 | **Release date** | 2023 March 22 |
195 +--------------------------------------+--------------------------------------------------------+
200 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
201 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
205 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
213 +--------------------------------------+--------------------------------------------------------+
214 | **CPS Project** | |
216 +--------------------------------------+--------------------------------------------------------+
217 | **Docker images** | onap/cps-and-ncmp:3.2.5 |
219 +--------------------------------------+--------------------------------------------------------+
220 | **Release designation** | 3.2.5 London |
222 +--------------------------------------+--------------------------------------------------------+
223 | **Release date** | 2023 March 10 |
225 +--------------------------------------+--------------------------------------------------------+
230 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
242 +--------------------------------------+--------------------------------------------------------+
243 | **CPS Project** | |
245 +--------------------------------------+--------------------------------------------------------+
246 | **Docker images** | onap/cps-and-ncmp:3.2.4 |
248 +--------------------------------------+--------------------------------------------------------+
249 | **Release designation** | 3.2.4 London |
251 +--------------------------------------+--------------------------------------------------------+
252 | **Release date** | 2023 March 09 |
254 +--------------------------------------+--------------------------------------------------------+
259 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
260 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
272 +--------------------------------------+--------------------------------------------------------+
273 | **CPS Project** | |
275 +--------------------------------------+--------------------------------------------------------+
276 | **Docker images** | onap/cps-and-ncmp:3.2.3 |
278 +--------------------------------------+--------------------------------------------------------+
279 | **Release designation** | 3.2.3 London |
281 +--------------------------------------+--------------------------------------------------------+
282 | **Release date** | 2023 March 07 |
284 +--------------------------------------+--------------------------------------------------------+
289 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
293 - `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
294 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
302 +--------------------------------------+--------------------------------------------------------+
303 | **CPS Project** | |
305 +--------------------------------------+--------------------------------------------------------+
306 | **Docker images** | onap/cps-and-ncmp:3.2.2 |
308 +--------------------------------------+--------------------------------------------------------+
309 | **Release designation** | 3.2.2 London |
311 +--------------------------------------+--------------------------------------------------------+
312 | **Release date** | 2023 February 08 |
314 +--------------------------------------+--------------------------------------------------------+
319 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
331 +--------------------------------------+--------------------------------------------------------+
332 | **CPS Project** | |
334 +--------------------------------------+--------------------------------------------------------+
335 | **Docker images** | onap/cps-and-ncmp:3.2.1 |
337 +--------------------------------------+--------------------------------------------------------+
338 | **Release designation** | 3.2.1 London |
340 +--------------------------------------+--------------------------------------------------------+
341 | **Release date** | 2023 January 27 |
343 +--------------------------------------+--------------------------------------------------------+
348 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
349 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
350 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
351 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
352 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
353 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
354 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
355 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
356 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
357 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
358 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
359 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
360 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
365 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
366 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
367 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
368 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
369 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
370 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
371 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
372 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
373 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
374 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
375 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
376 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
377 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
378 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
381 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
383 Known Limitations, Issues and Workarounds
384 -----------------------------------------
388 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
389 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.
391 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
392 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
394 .. ====================
396 .. ====================
404 +--------------------------------------+--------------------------------------------------------+
405 | **CPS Project** | |
407 +--------------------------------------+--------------------------------------------------------+
408 | **Docker images** | onap/cps-and-ncmp:3.1.4 |
410 +--------------------------------------+--------------------------------------------------------+
411 | **Release designation** | 3.1.4 Kohn |
413 +--------------------------------------+--------------------------------------------------------+
414 | **Release date** | 2022 October 5 |
416 +--------------------------------------+--------------------------------------------------------+
420 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
421 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
429 +--------------------------------------+--------------------------------------------------------+
430 | **CPS Project** | |
432 +--------------------------------------+--------------------------------------------------------+
433 | **Docker images** | onap/cps-and-ncmp:3.1.3 |
435 +--------------------------------------+--------------------------------------------------------+
436 | **Release designation** | 3.1.3 Kohn |
438 +--------------------------------------+--------------------------------------------------------+
439 | **Release date** | 2022 September 29 |
441 +--------------------------------------+--------------------------------------------------------+
453 +--------------------------------------+--------------------------------------------------------+
454 | **CPS Project** | |
456 +--------------------------------------+--------------------------------------------------------+
457 | **Docker images** | onap/cps-and-ncmp:3.1.2 |
459 +--------------------------------------+--------------------------------------------------------+
460 | **Release designation** | 3.1.2 Kohn |
462 +--------------------------------------+--------------------------------------------------------+
463 | **Release date** | 2022 September 28 |
465 +--------------------------------------+--------------------------------------------------------+
477 +--------------------------------------+--------------------------------------------------------+
478 | **CPS Project** | |
480 +--------------------------------------+--------------------------------------------------------+
481 | **Docker images** | onap/cps-and-ncmp:3.1.1 |
483 +--------------------------------------+--------------------------------------------------------+
484 | **Release designation** | 3.1.1 Kohn |
486 +--------------------------------------+--------------------------------------------------------+
487 | **Release date** | 2022 September 28 |
489 +--------------------------------------+--------------------------------------------------------+
498 *Fixed Security Issues*
500 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
508 +--------------------------------------+--------------------------------------------------------+
509 | **CPS Project** | |
511 +--------------------------------------+--------------------------------------------------------+
512 | **Docker images** | onap/cps-and-ncmp:3.1.0 |
514 +--------------------------------------+--------------------------------------------------------+
515 | **Release designation** | 3.1.0 Kohn |
517 +--------------------------------------+--------------------------------------------------------+
518 | **Release date** | 2022 September 14 |
520 +--------------------------------------+--------------------------------------------------------+
524 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
525 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
526 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
527 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
528 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
529 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
530 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
531 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
532 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
533 - `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'
534 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
535 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
536 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
537 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
538 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
539 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
540 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
541 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
542 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
543 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
544 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
545 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
546 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
547 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
552 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
553 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
554 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
555 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
556 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
557 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
558 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
559 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
560 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
561 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
562 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
563 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
564 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
565 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
567 Known Limitations, Issues and Workarounds
568 -----------------------------------------
572 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
573 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
575 *Known Vulnerabilities*
586 *Fixed Security Issues*
588 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
590 *Known Security Issues*
594 .. ========================
595 .. * * * JAKARTA * * *
596 .. ========================
604 +--------------------------------------+--------------------------------------------------------+
605 | **CPS Project** | |
607 +--------------------------------------+--------------------------------------------------------+
608 | **Docker images** | onap/cps-and-ncmp:3.0.1 |
610 +--------------------------------------+--------------------------------------------------------+
611 | **Release designation** | 3.0.1 Jakarta |
613 +--------------------------------------+--------------------------------------------------------+
614 | **Release date** | 2022 April 28 |
616 +--------------------------------------+--------------------------------------------------------+
620 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
628 +--------------------------------------+--------------------------------------------------------+
629 | **CPS Project** | |
631 +--------------------------------------+--------------------------------------------------------+
632 | **Docker images** | onap/cps-and-ncmp:3.0.0 |
634 +--------------------------------------+--------------------------------------------------------+
635 | **Release designation** | 3.0.0 Jakarta |
637 +--------------------------------------+--------------------------------------------------------+
638 | **Release date** | 2022 March 15 |
640 +--------------------------------------+--------------------------------------------------------+
644 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
645 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
646 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
647 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
648 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
649 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
650 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
651 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
652 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
653 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
654 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
659 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
660 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
661 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
662 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
663 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
664 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
665 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
666 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
667 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
668 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
670 Known Limitations, Issues and Workarounds
671 -----------------------------------------
675 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
676 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
677 of cm handle registration.
679 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
680 for more information.
682 *Known Vulnerabilities*
688 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
689 pass an empty string as the value if you do not want to include names for these values.
694 *Fixed Security Issues*
698 *Known Security Issues*
702 .. ========================
703 .. * * * ISTANBUL * * *
704 .. ========================
712 +--------------------------------------+--------------------------------------------------------+
713 | **CPS Project** | |
715 +--------------------------------------+--------------------------------------------------------+
716 | **Docker images** | onap/cps-and-ncmp:2.0.4 |
718 +--------------------------------------+--------------------------------------------------------+
719 | **Release designation** | 2.0.4 Istanbul |
721 +--------------------------------------+--------------------------------------------------------+
722 | **Release date** | 2022 Feb 09 |
724 +--------------------------------------+--------------------------------------------------------+
729 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
730 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
738 +--------------------------------------+--------------------------------------------------------+
739 | **CPS Project** | |
741 +--------------------------------------+--------------------------------------------------------+
742 | **Docker images** | onap/cps-and-ncmp:2.0.3 |
744 +--------------------------------------+--------------------------------------------------------+
745 | **Release designation** | 2.0.3 Istanbul |
747 +--------------------------------------+--------------------------------------------------------+
748 | **Release date** | 2022-07-01 |
750 +--------------------------------------+--------------------------------------------------------+
755 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
763 +--------------------------------------+--------------------------------------------------------+
764 | **CPS Project** | |
766 +--------------------------------------+--------------------------------------------------------+
767 | **Docker images** | onap/cps-and-ncmp:2.0.2 |
769 +--------------------------------------+--------------------------------------------------------+
770 | **Release designation** | 2.0.2 Istanbul |
772 +--------------------------------------+--------------------------------------------------------+
773 | **Release date** | 2021-16-12 |
775 +--------------------------------------+--------------------------------------------------------+
780 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
788 +--------------------------------------+--------------------------------------------------------+
789 | **CPS Project** | |
791 +--------------------------------------+--------------------------------------------------------+
792 | **Docker images** | onap/cps-and-ncmp:2.0.1 |
794 +--------------------------------------+--------------------------------------------------------+
795 | **Release designation** | 2.0.1 Istanbul |
797 +--------------------------------------+--------------------------------------------------------+
798 | **Release date** | 2021-14-10 |
800 +--------------------------------------+--------------------------------------------------------+
805 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
806 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
807 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
808 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
810 Known Limitations, Issues and Workarounds
811 -----------------------------------------
815 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
817 *Known Vulnerabilities*
819 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
823 Add recursive method to save list node data to loop through all corresponding child nodes.
828 *Fixed Security Issues*
830 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
832 *Known Security Issues*
842 This document provides the release notes for Istanbul release.
847 +--------------------------------------+--------------------------------------------------------+
848 | **CPS Project** | |
850 +--------------------------------------+--------------------------------------------------------+
851 | **Docker images** | onap/cps-and-ncmp:2.0.0 |
853 +--------------------------------------+--------------------------------------------------------+
854 | **Release designation** | 2.0.0 Istanbul |
856 +--------------------------------------+--------------------------------------------------------+
857 | **Release date** | 2021-14-09 |
859 +--------------------------------------+--------------------------------------------------------+
863 * Register DMI-Plugins with NCMP for CM Handle registrations.
864 * Update, Create and Remove CM Handles.
865 * Add support for retrieving and writing CM Handle data through NCMP datastores.
866 * Automatic retrieval and caching of model information for CM Handles within NCMP.
871 Software Deliverables
874 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
877 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
882 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
883 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
884 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
885 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
886 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
887 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
888 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
889 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
890 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
891 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
892 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
893 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
894 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
895 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
896 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
897 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
898 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
899 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
900 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
901 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
902 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
903 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
904 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
905 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
906 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
907 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
909 This document provides the release notes for Istanbul release.
914 Following CPS components are available with default ONAP/CPS installation.
917 * Platform components
927 * Additional resources that CPS utilizes deployed using ONAP common charts
932 Below service components (mS) are available to be deployed on-demand.
936 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
938 Known Limitations, Issues and Workarounds
939 -----------------------------------------
943 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
945 *Known Vulnerabilities*
947 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
948 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
949 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
953 Add recursive method to save list node data to loop through all corresponding child nodes.
958 *Fixed Security Issues*
960 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
962 *Known Security Issues*
964 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
968 * `Integration tests`
970 .. ========================
971 .. * * * HONOLULU * * *
972 .. ========================
980 +--------------------------------------+--------------------------------------------------------+
981 | **CPS Project** | |
983 +--------------------------------------+--------------------------------------------------------+
984 | **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
986 +--------------------------------------+--------------------------------------------------------+
987 | **Release designation** | 1.0.1 Honolulu |
989 +--------------------------------------+--------------------------------------------------------+
990 | **Release date** | 2021-04-09 |
992 +--------------------------------------+--------------------------------------------------------+
997 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
998 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
999 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1000 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1001 - `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
1002 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1003 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1004 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1009 *Fixed Security Issues*
1011 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1013 *Known Security Issues*
1015 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1024 This document provides the release notes for Honolulu release.
1029 Following CPS components are available with default ONAP/CPS installation.
1032 * Platform components
1036 * Service components
1040 * Additional resources that CPS utilizes deployed using ONAP common charts
1045 Below service components (mS) are available to be deployed on-demand.
1049 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1055 +--------------------------------------+--------------------------------------------------------+
1056 | **CPS Project** | |
1058 +--------------------------------------+--------------------------------------------------------+
1059 | **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1061 +--------------------------------------+--------------------------------------------------------+
1062 | **Release designation** | 1.0.0 Honolulu |
1064 +--------------------------------------+--------------------------------------------------------+
1065 | **Release date** | 2021-03-11 |
1067 +--------------------------------------+--------------------------------------------------------+
1072 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1073 CPS has been driven by the needs of the E2E Networking Slicing use case.
1074 It currently supports basic (rw) persistence and simple queries.
1075 It also provides MVP support for network data access using simulated data.
1077 .. _honolulu_deliverable:
1082 Software Deliverables
1085 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1088 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1091 Known Limitations, Issues and Workarounds
1092 -----------------------------------------
1094 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1095 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1096 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1097 - `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.
1099 *System Limitations*
1103 *Known Vulnerabilities*
1109 Documented under corresponding jira if applicable.
1114 *Fixed Security Issues*
1116 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1117 - Upgrade org.onap.oparent to 3.2.0
1118 - Upgrade spring.boot to 2.3.8.RELEASE
1119 - Upgrade yangtools to 5.0.7
1121 *Known Security Issues*
1123 * Weak Crytography using md5
1124 * Risk seen in Zip file expansion
1126 *Known Vulnerabilities in Used Modules*
1130 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.
1134 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1139 For more information on the latest ONAP release, please see:
1141 #. `ONAP Home Page`_
1142 #. `ONAP Wiki Page`_
1143 #. `ONAP Documentation`_
1144 #. `ONAP CPS Documentation`_
1145 #. `ONAP Release Downloads`_
1148 .. _`ONAP Home Page`: https://www.onap.org
1149 .. _`ONAP Wiki Page`: https://wiki.onap.org
1150 .. _`ONAP Documentation`: https://docs.onap.org
1151 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1152 .. _`ONAP Release Downloads`: https://git.onap.org
1156 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1157 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_