blob: 82a890d79c6820969f524ac9a38d65faec3c3b98 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
danielhanrahan9e871802023-08-17 14:58:30 +01003.. Copyright (C) 2021-2024 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +00004
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00008CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -04009#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +000010
11.. contents::
12 :depth: 2
13..
14
mpriyank89e0fe22023-11-09 12:12:38 +000015.. =========================
16.. * * * NEW DELHI * * *
17.. =========================
niamhcoref7b414e2021-11-17 11:02:07 +000018
mpriyankc6f18cf2024-05-14 10:09:55 +010019Version: 3.4.10
20===============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.4.10 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.4.10 New Delhi |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.4.10
42
43Features
44--------
45
danielhanrahana44b0562024-05-01 13:53:00 +010046Version: 3.4.9
47==============
48
49Release Data
50------------
51
52+--------------------------------------+--------------------------------------------------------+
53| **CPS Project** | |
54| | |
55+--------------------------------------+--------------------------------------------------------+
56| **Docker images** | onap/cps-and-ncmp:3.4.9 |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Release designation** | 3.4.9 New Delhi |
60| | |
61+--------------------------------------+--------------------------------------------------------+
mpriyankc6f18cf2024-05-14 10:09:55 +010062| **Release date** | 2024 May 14 |
danielhanrahana44b0562024-05-01 13:53:00 +010063| | |
64+--------------------------------------+--------------------------------------------------------+
65
66Bug Fixes
67---------
683.4.9
mpriyank5c099bc2024-05-09 11:46:09 +010069 - `CPS-2211 <https://jira.onap.org/browse/CPS-2211>`_ Toggle switch to disable CPS Core change events if not used by application. Set CPS_CHANGE_EVENT_NOTIFICATIONS_ENABLED environment variable for the same.
danielhanrahana44b0562024-05-01 13:53:00 +010070
71Features
72--------
73
mpriyank0ac5d962024-03-29 13:47:19 +000074Version: 3.4.8
75==============
76
77Release Data
78------------
79
80+--------------------------------------+--------------------------------------------------------+
81| **CPS Project** | |
82| | |
83+--------------------------------------+--------------------------------------------------------+
84| **Docker images** | onap/cps-and-ncmp:3.4.8 |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Release designation** | 3.4.8 New Delhi |
88| | |
89+--------------------------------------+--------------------------------------------------------+
danielhanrahana44b0562024-05-01 13:53:00 +010090| **Release date** | 2024 May 1 |
mpriyank0ac5d962024-03-29 13:47:19 +000091| | |
92+--------------------------------------+--------------------------------------------------------+
93
danielhanrahanbbfb0612024-04-16 22:04:44 +010094Bug Fixes
95---------
963.4.8
97 - `CPS-2186 <https://jira.onap.org/browse/CPS-2186>`_ Report async task failures to client topic during data operations request
danielhanrahance2acdf2024-04-26 11:55:55 +010098 - `CPS-2190 <https://jira.onap.org/browse/CPS-2190>`_ Improve performance of NCMP module searches
99 - `CPS-2194 <https://jira.onap.org/browse/CPS-2194>`_ Added defaults for CPS and DMI username and password
sourabh_sourabh384b0ca2024-05-03 13:10:36 +0100100 - `CPS-2204 <https://jira.onap.org/browse/CPS-2204>`_ Added error handling for yang module upgrade operation
danielhanrahanbbfb0612024-04-16 22:04:44 +0100101
mpriyank0ac5d962024-03-29 13:47:19 +0000102Features
103--------
104
mpriyanka1703ea2024-02-29 17:47:47 +0000105Version: 3.4.7
106==============
107
108Release Data
109------------
110
111+--------------------------------------+--------------------------------------------------------+
112| **CPS Project** | |
113| | |
114+--------------------------------------+--------------------------------------------------------+
115| **Docker images** | onap/cps-and-ncmp:3.4.7 |
116| | |
117+--------------------------------------+--------------------------------------------------------+
118| **Release designation** | 3.4.7 New Delhi |
119| | |
120+--------------------------------------+--------------------------------------------------------+
mpriyank0ac5d962024-03-29 13:47:19 +0000121| **Release date** | 2024 March 29 |
mpriyanka1703ea2024-02-29 17:47:47 +0000122| | |
123+--------------------------------------+--------------------------------------------------------+
124
125Bug Fixes
126---------
1273.4.7
mpriyank6b0e6b32024-03-08 12:50:53 +0000128 - `CPS-2150 <https://jira.onap.org/browse/CPS-2150>`_ Fix for Async task execution failed by TimeoutException.
mpriyanka1703ea2024-02-29 17:47:47 +0000129
130Features
131--------
david.mcweeney23378b52024-02-21 09:51:29 +00001323.4.7
133 - `CPS-2061 <https://jira.onap.org/browse/CPS-2061>`_ Liquibase Steps Condensing and Cleanup.
mpriyankb4f8b792024-03-29 10:57:05 +0000134 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot to 3.2.4 version.
mpriyanka1703ea2024-02-29 17:47:47 +0000135
mpriyank22e1f432024-02-27 14:04:38 +0000136Version: 3.4.6
137==============
138
139Release Data
140------------
141
142+--------------------------------------+--------------------------------------------------------+
143| **CPS Project** | |
144| | |
145+--------------------------------------+--------------------------------------------------------+
146| **Docker images** | onap/cps-and-ncmp:3.4.6 |
147| | |
148+--------------------------------------+--------------------------------------------------------+
149| **Release designation** | 3.4.6 New Delhi |
150| | |
151+--------------------------------------+--------------------------------------------------------+
mpriyanka1703ea2024-02-29 17:47:47 +0000152| **Release date** | 2024 February 29 |
mpriyank22e1f432024-02-27 14:04:38 +0000153| | |
154+--------------------------------------+--------------------------------------------------------+
155
156Bug Fixes
157---------
1583.4.6
mpriyank4a978d32024-02-29 14:39:00 +0000159 - `CPS-2126 <https://jira.onap.org/browse/CPS-2126>`_ Passing HTTP Authorization Bearer Token to DMI Plugins.
mpriyank22e1f432024-02-27 14:04:38 +0000160
161
162Features
163--------
mpriyank4a978d32024-02-29 14:39:00 +0000164 - `CPS-2133 <https://jira.onap.org/browse/CPS-2133>`_ Revert Uplift of Spring Boot version from 3.2.2 to 3.1.2
165
166Notes
167-----
168This release brings improvements to compatibility with Service Mesh and for that below measures are been taken.
169
170Basic authorization provided using Spring security is been removed from CPS-Core and NCMP and hence authorization is no longer enforced.(basic auth header will be ignored, but is still allowed).
171NCMP will propagate a bearer token to DMI conditionally.
172401 Unauthorized will not be returned. Best effort has been made to ensure backwards compatibility.
mpriyank22e1f432024-02-27 14:04:38 +0000173
danielhanrahanb8e677f2024-02-23 15:27:17 +0000174Version: 3.4.5
175==============
176
177Release Data
178------------
179
180+--------------------------------------+--------------------------------------------------------+
181| **CPS Project** | |
182| | |
183+--------------------------------------+--------------------------------------------------------+
184| **Docker images** | onap/cps-and-ncmp:3.4.5 |
185| | |
186+--------------------------------------+--------------------------------------------------------+
187| **Release designation** | 3.4.5 New Delhi |
188| | |
189+--------------------------------------+--------------------------------------------------------+
mpriyank22e1f432024-02-27 14:04:38 +0000190| **Release date** | 2024 February 27 |
danielhanrahanb8e677f2024-02-23 15:27:17 +0000191| | |
192+--------------------------------------+--------------------------------------------------------+
193
194Bug Fixes
195---------
1963.4.5
197
198
199Features
200--------
mpriyankcfac7192024-02-27 12:21:53 +0000201 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot version to 3.2.2
danielhanrahanb8e677f2024-02-23 15:27:17 +0000202
203
danielhanrahan97bad452024-02-07 16:07:27 +0000204Version: 3.4.4
205==============
206
207Release Data
208------------
209
210+--------------------------------------+--------------------------------------------------------+
211| **CPS Project** | |
212| | |
213+--------------------------------------+--------------------------------------------------------+
214| **Docker images** | onap/cps-and-ncmp:3.4.4 |
215| | |
216+--------------------------------------+--------------------------------------------------------+
217| **Release designation** | 3.4.4 New Delhi |
218| | |
219+--------------------------------------+--------------------------------------------------------+
danielhanrahanb8e677f2024-02-23 15:27:17 +0000220| **Release date** | 2024 February 23 |
danielhanrahan97bad452024-02-07 16:07:27 +0000221| | |
222+--------------------------------------+--------------------------------------------------------+
223
224Bug Fixes
225---------
2263.4.4
danielhanrahan8c37c032024-02-23 13:27:37 +0000227 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Upgrade Yang modules using module set tag functionalities fix
danielhanrahan97bad452024-02-07 16:07:27 +0000228
229Features
230--------
danielhanrahan8c37c032024-02-23 13:27:37 +0000231 - `CPS-2057 <https://jira.onap.org/browse/CPS-2057>`_ Leaf lists are sorted by default if Yang model does not specify order.
232 - `CPS-2087 <https://jira.onap.org/browse/CPS-2087>`_ Performance improvement of CPS Path Queries.
danielhanrahan97bad452024-02-07 16:07:27 +0000233
234
danielhanrahan345f40f2024-01-11 15:25:18 +0000235Version: 3.4.3
236==============
237
238Release Data
239------------
240
241+--------------------------------------+--------------------------------------------------------+
242| **CPS Project** | |
243| | |
244+--------------------------------------+--------------------------------------------------------+
245| **Docker images** | onap/cps-and-ncmp:3.4.3 |
246| | |
247+--------------------------------------+--------------------------------------------------------+
248| **Release designation** | 3.4.3 New Delhi |
249| | |
250+--------------------------------------+--------------------------------------------------------+
danielhanrahan97bad452024-02-07 16:07:27 +0000251| **Release date** | 2024 February 07 |
danielhanrahan345f40f2024-01-11 15:25:18 +0000252| | |
253+--------------------------------------+--------------------------------------------------------+
254
255Bug Fixes
256---------
2573.4.3
danielhanrahan7ce495b2024-02-07 14:21:58 +0000258 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed.
259 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag.
260 - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer.
danielhanrahan345f40f2024-01-11 15:25:18 +0000261
262Features
263--------
Arpit Singh1322b0f2024-01-19 13:46:03 +0530264 - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors.
danielhanrahan81f61b52024-02-02 12:25:47 +0000265 - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR.
halil.cakalc1b09262024-02-08 12:15:48 +0000266 - `CPS-1135 <https://jira.onap.org/browse/CPS-1135>`_ Extend CPS Module API to allow retrieval single module definition.
danielhanrahan81f61b52024-02-02 12:25:47 +0000267
268Notes
269-----
270The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a
271*-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename
272of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*.
danielhanrahan345f40f2024-01-11 15:25:18 +0000273
danielhanrahan9437af62023-12-20 15:12:47 +0000274Version: 3.4.2
275==============
276
277Release Data
278------------
279
280+--------------------------------------+--------------------------------------------------------+
281| **CPS Project** | |
282| | |
283+--------------------------------------+--------------------------------------------------------+
284| **Docker images** | onap/cps-and-ncmp:3.4.2 |
285| | |
286+--------------------------------------+--------------------------------------------------------+
287| **Release designation** | 3.4.2 New Delhi |
288| | |
289+--------------------------------------+--------------------------------------------------------+
danielhanrahan345f40f2024-01-11 15:25:18 +0000290| **Release date** | 2024 January 11 |
danielhanrahan9437af62023-12-20 15:12:47 +0000291| | |
292+--------------------------------------+--------------------------------------------------------+
293
294Bug Fixes
295---------
2963.4.2
297
298
299Features
300--------
halil.cakal37c6d4d2024-01-11 11:10:17 +0000301 - `CPS-1638 <https://jira.onap.org/browse/CPS-1638>`_ Introduce trust level for CM handle.
danielhanrahan36b81b22023-08-17 14:58:30 +0100302 - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
danielhanrahan9e871802023-08-17 14:58:30 +0100303 - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
danielhanrahan926d4082023-08-04 11:22:43 +0100304 - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
305
306Notes
307-----
308 - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
danielhanrahan9437af62023-12-20 15:12:47 +0000309
danielhanrahan36b81b22023-08-17 14:58:30 +0100310Known Limitations, Issues and Workarounds
311-----------------------------------------
312
313*System Limitations*
314
315For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
316(`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
317As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
318NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
319Other operations (read, update, delete) are not impacted.
320
danielhanrahan9437af62023-12-20 15:12:47 +0000321
mpriyank1d9dae02023-11-09 14:11:26 +0000322Version: 3.4.1
323==============
324
325Release Data
326------------
327
328+--------------------------------------+--------------------------------------------------------+
329| **CPS Project** | |
330| | |
331+--------------------------------------+--------------------------------------------------------+
332| **Docker images** | onap/cps-and-ncmp:3.4.1 |
333| | |
334+--------------------------------------+--------------------------------------------------------+
335| **Release designation** | 3.4.1 New Delhi |
336| | |
337+--------------------------------------+--------------------------------------------------------+
danielhanrahan9437af62023-12-20 15:12:47 +0000338| **Release date** | 2023 December 20 |
mpriyank1d9dae02023-11-09 14:11:26 +0000339| | |
340+--------------------------------------+--------------------------------------------------------+
341
342Bug Fixes
343---------
danielhanrahan3e14d392023-12-20 13:31:07 +00003443.4.1
mpriyank41727e52023-12-04 18:01:07 +0000345 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
mpriyank1d9dae02023-11-09 14:11:26 +0000346
ToineSiebelink8ee94852023-11-27 14:52:19 +0000347Features
348--------
349 - CPS-Temporal is no longer supported and any related documentation has been removed.
danielhanrahan3e14d392023-12-20 13:31:07 +0000350 - `CPS-1733 <https://jira.onap.org/browse/CPS-1733>`_ Upgrade YANG schema-set for CM handle without removing and adding it.
mpriyanka1bfa732023-11-30 14:41:03 +0000351 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
waqas.ikram60bbcb92023-12-20 10:40:29 +0000352 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
mpriyankdb6b8f82023-12-14 13:27:01 +0000353 - `CPS-2005 <https://jira.onap.org/browse/CPS-2005>`_ Removing notification feature for cps updated events ( exclusively used by cps-temporal )
ToineSiebelink8ee94852023-11-27 14:52:19 +0000354
danielhanrahan3e14d392023-12-20 13:31:07 +0000355Known Issues
356------------
357 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
358
ToineSiebelink8ee94852023-11-27 14:52:19 +0000359
mpriyank89e0fe22023-11-09 12:12:38 +0000360Version: 3.4.0
361==============
mpriyank2c4535d2023-11-06 17:06:15 +0000362
363Release Data
364------------
365
366+--------------------------------------+--------------------------------------------------------+
367| **CPS Project** | |
368| | |
369+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000370| **Docker images** | onap/cps-and-ncmp:3.4.0 |
mpriyank2c4535d2023-11-06 17:06:15 +0000371| | |
372+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000373| **Release designation** | 3.4.0 New Delhi |
mpriyank2c4535d2023-11-06 17:06:15 +0000374| | |
375+--------------------------------------+--------------------------------------------------------+
mpriyank1d9dae02023-11-09 14:11:26 +0000376| **Release date** | 2023 November 09 |
mpriyank2c4535d2023-11-06 17:06:15 +0000377| | |
378+--------------------------------------+--------------------------------------------------------+
379
380Bug Fixes
381---------
mpriyank89e0fe22023-11-09 12:12:38 +00003823.4.0
383 - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
mpriyank2c4535d2023-11-06 17:06:15 +0000384
mpriyank89e0fe22023-11-09 12:12:38 +0000385.. ========================
386.. * * * MONTREAL * * *
387.. ========================
mpriyank2c4535d2023-11-06 17:06:15 +0000388
egernugd91a7072023-09-29 12:12:36 +0100389Version: 3.3.9
390==============
391
392Release Data
393------------
394
395+--------------------------------------+--------------------------------------------------------+
396| **CPS Project** | |
397| | |
398+--------------------------------------+--------------------------------------------------------+
399| **Docker images** | onap/cps-and-ncmp:3.3.9 |
400| | |
401+--------------------------------------+--------------------------------------------------------+
402| **Release designation** | 3.3.9 Montreal |
403| | |
404+--------------------------------------+--------------------------------------------------------+
mpriyank2c4535d2023-11-06 17:06:15 +0000405| **Release date** | 2023 November 06 |
egernugd91a7072023-09-29 12:12:36 +0100406| | |
407+--------------------------------------+--------------------------------------------------------+
408
409Bug Fixes
410---------
4113.3.9
mpriyank02b2d2a2023-10-25 12:23:10 +0100412 - `CPS-1923 <https://jira.onap.org/browse/CPS-1923>`_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port.
mpriyankd74c2d22023-11-06 13:25:38 +0000413 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
egernugd91a7072023-09-29 12:12:36 +0100414
415Features
416--------
417
danielhanrahan56384d12023-09-20 17:10:40 +0100418Version: 3.3.8
419==============
420
421Release Data
422------------
423
424+--------------------------------------+--------------------------------------------------------+
425| **CPS Project** | |
426| | |
427+--------------------------------------+--------------------------------------------------------+
428| **Docker images** | onap/cps-and-ncmp:3.3.8 |
429| | |
430+--------------------------------------+--------------------------------------------------------+
431| **Release designation** | 3.3.8 Montreal |
432| | |
433+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +0100434| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +0100435| | |
436+--------------------------------------+--------------------------------------------------------+
437
438Bug Fixes
439---------
4403.3.8
441
442Features
443--------
egernugcb9d1502023-09-28 09:57:44 +0100444 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +0100445
leventecsanyid35ad5c2023-08-23 15:55:30 +0200446Version: 3.3.7
447==============
448
449Release Data
450------------
451
452+--------------------------------------+--------------------------------------------------------+
453| **CPS Project** | |
454| | |
455+--------------------------------------+--------------------------------------------------------+
456| **Docker images** | onap/cps-and-ncmp:3.3.7 |
457| | |
458+--------------------------------------+--------------------------------------------------------+
459| **Release designation** | 3.3.7 Montreal |
460| | |
461+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +0100462| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +0200463| | |
464+--------------------------------------+--------------------------------------------------------+
465
466Bug Fixes
467---------
4683.3.7
danielhanrahanefc55772023-09-15 12:02:35 +0100469 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +0200470
471Features
472--------
egernugcb9d1502023-09-28 09:57:44 +0100473 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100474
475Note
476----
477Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
leventecsanyid35ad5c2023-08-23 15:55:30 +0200478
egernugbdac4402023-07-21 13:27:24 +0100479Version: 3.3.6
480==============
481
482Release Data
483------------
484
485+--------------------------------------+--------------------------------------------------------+
486| **CPS Project** | |
487| | |
488+--------------------------------------+--------------------------------------------------------+
489| **Docker images** | onap/cps-and-ncmp:3.3.6 |
490| | |
491+--------------------------------------+--------------------------------------------------------+
492| **Release designation** | 3.3.6 Montreal |
493| | |
494+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200495| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100496| | |
497+--------------------------------------+--------------------------------------------------------+
498
499Bug Fixes
500---------
5013.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100502 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100503 - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
egernugbdac4402023-07-21 13:27:24 +0100504
505Features
506--------
danielhanrahan92705462023-05-18 10:18:10 +0100507 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100508 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100509
510
egernug6c9621a2023-07-19 11:05:00 +0100511Version: 3.3.5
512==============
513
514Release Data
515------------
516
517+--------------------------------------+--------------------------------------------------------+
518| **CPS Project** | |
519| | |
520+--------------------------------------+--------------------------------------------------------+
521| **Docker images** | onap/cps-and-ncmp:3.3.5 |
522| | |
523+--------------------------------------+--------------------------------------------------------+
524| **Release designation** | 3.3.5 Montreal |
525| | |
526+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100527| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100528| | |
529+--------------------------------------+--------------------------------------------------------+
530
531Bug Fixes
532---------
5333.3.5
534
535Features
536--------
danielhanrahan74a47152023-06-28 12:55:20 +0100537 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100538
mpriyank8caa3422023-06-30 11:14:10 +0100539Version: 3.3.4
540==============
541
542Release Data
543------------
544
545+--------------------------------------+--------------------------------------------------------+
546| **CPS Project** | |
547| | |
548+--------------------------------------+--------------------------------------------------------+
549| **Docker images** | onap/cps-and-ncmp:3.3.4 |
550| | |
551+--------------------------------------+--------------------------------------------------------+
552| **Release designation** | 3.3.4 Montreal |
553| | |
554+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100555| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100556| | |
557+--------------------------------------+--------------------------------------------------------+
558
559Bug Fixes
560---------
5613.3.4
562
563Features
564--------
egernugdb62ffb2023-07-18 10:57:42 +0100565 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100566
danielhanrahan19f963b2023-06-15 13:52:34 +0100567Version: 3.3.3
568==============
569
570Release Data
571------------
572
573+--------------------------------------+--------------------------------------------------------+
574| **CPS Project** | |
575| | |
576+--------------------------------------+--------------------------------------------------------+
577| **Docker images** | onap/cps-and-ncmp:3.3.3 |
578| | |
579+--------------------------------------+--------------------------------------------------------+
580| **Release designation** | 3.3.3 Montreal |
581| | |
582+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100583| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100584| | |
585+--------------------------------------+--------------------------------------------------------+
586
587Bug Fixes
588---------
5893.3.3
590
591Features
592--------
mpriyank6da95412023-06-29 16:56:11 +0100593 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
594 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
595 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100596
mpriyank436b75b2023-05-03 11:10:08 +0100597Version: 3.3.2
598==============
599
600Release Data
601------------
602
603+--------------------------------------+--------------------------------------------------------+
604| **CPS Project** | |
605| | |
606+--------------------------------------+--------------------------------------------------------+
607| **Docker images** | onap/cps-and-ncmp:3.3.2 |
608| | |
609+--------------------------------------+--------------------------------------------------------+
610| **Release designation** | 3.3.2 Montreal |
611| | |
612+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100613| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100614| | |
615+--------------------------------------+--------------------------------------------------------+
616
617Bug Fixes
618---------
6193.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100620 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
mpriyank436b75b2023-05-03 11:10:08 +0100621
622Features
623--------
--globalc7e5a802023-04-05 17:08:08 +0530624 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
danielhanrahan5cec5322023-06-15 11:08:54 +0100625 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
626 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
627 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
628 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100629
lukegleesond7764c42023-04-20 14:11:20 +0100630Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000631==============
632
633Release Data
634------------
635
636+--------------------------------------+--------------------------------------------------------+
637| **CPS Project** | |
638| | |
639+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100640| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000641| | |
642+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100643| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000644| | |
645+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100646| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000647| | |
648+--------------------------------------+--------------------------------------------------------+
649
650Bug Fixes
651---------
lukegleesond7764c42023-04-20 14:11:20 +01006523.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000653 - None
654
655Features
656--------
mpriyank52c5e542023-05-02 15:58:55 +0100657 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
658 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
659 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
660 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
661 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000662
lukegleesond7764c42023-04-20 14:11:20 +0100663Version: 3.3.0
664==============
665
666Release Data
667------------
668
669+--------------------------------------+--------------------------------------------------------+
670| **CPS Project** | |
671| | |
672+--------------------------------------+--------------------------------------------------------+
673| **Docker images** | onap/cps-and-ncmp:3.3.0 |
674| | |
675+--------------------------------------+--------------------------------------------------------+
676| **Release designation** | 3.3.0 Montreal |
677| | |
678+--------------------------------------+--------------------------------------------------------+
679| **Release date** | 2023 April 20 |
680| | |
681+--------------------------------------+--------------------------------------------------------+
682
683Bug Fixes
684---------
6853.3.0
686 - None
687
688Features
689--------
690 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
691 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
692
693.. ======================
694.. * * * LONDON * * *
695.. ======================
696
mpriyank0fd4d192023-03-10 13:48:20 +0000697Version: 3.2.6
698==============
699
700Release Data
701------------
702
703+--------------------------------------+--------------------------------------------------------+
704| **CPS Project** | |
705| | |
706+--------------------------------------+--------------------------------------------------------+
707| **Docker images** | onap/cps-and-ncmp:3.2.6 |
708| | |
709+--------------------------------------+--------------------------------------------------------+
710| **Release designation** | 3.2.6 London |
711| | |
712+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000713| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000714| | |
715+--------------------------------------+--------------------------------------------------------+
716
717Bug Fixes
718---------
7193.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530720 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000721 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
mpriyank0fd4d192023-03-10 13:48:20 +0000722
723Features
724--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000725 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000726
mpriyankade5a6e2023-03-09 17:58:31 +0000727Version: 3.2.5
728==============
729
730Release Data
731------------
732
733+--------------------------------------+--------------------------------------------------------+
734| **CPS Project** | |
735| | |
736+--------------------------------------+--------------------------------------------------------+
737| **Docker images** | onap/cps-and-ncmp:3.2.5 |
738| | |
739+--------------------------------------+--------------------------------------------------------+
740| **Release designation** | 3.2.5 London |
741| | |
742+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000743| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000744| | |
745+--------------------------------------+--------------------------------------------------------+
746
747Bug Fixes
748---------
7493.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000750 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000751
752Features
753--------
754 - None
755
seanbeirnef0f4fd82023-03-07 13:42:04 +0000756Version: 3.2.4
757==============
758
759Release Data
760------------
761
762+--------------------------------------+--------------------------------------------------------+
763| **CPS Project** | |
764| | |
765+--------------------------------------+--------------------------------------------------------+
766| **Docker images** | onap/cps-and-ncmp:3.2.4 |
767| | |
768+--------------------------------------+--------------------------------------------------------+
769| **Release designation** | 3.2.4 London |
770| | |
771+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000772| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000773| | |
774+--------------------------------------+--------------------------------------------------------+
775
776Bug Fixes
777---------
7783.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000779 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
780 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
781
782Features
783--------
784 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000785
mpriyankfd43dbe2023-02-08 11:21:08 +0000786Version: 3.2.3
787==============
788
789Release Data
790------------
791
792+--------------------------------------+--------------------------------------------------------+
793| **CPS Project** | |
794| | |
795+--------------------------------------+--------------------------------------------------------+
796| **Docker images** | onap/cps-and-ncmp:3.2.3 |
797| | |
798+--------------------------------------+--------------------------------------------------------+
799| **Release designation** | 3.2.3 London |
800| | |
801+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000802| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000803| | |
804+--------------------------------------+--------------------------------------------------------+
805
806Bug Fixes
807---------
8083.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000809 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000810
811Features
812--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000813 - `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
814 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000815
seanbeirnef8e980a2023-01-27 18:09:33 +0000816Version: 3.2.2
817==============
818
819Release Data
820------------
821
822+--------------------------------------+--------------------------------------------------------+
823| **CPS Project** | |
824| | |
825+--------------------------------------+--------------------------------------------------------+
826| **Docker images** | onap/cps-and-ncmp:3.2.2 |
827| | |
828+--------------------------------------+--------------------------------------------------------+
829| **Release designation** | 3.2.2 London |
830| | |
831+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000832| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000833| | |
834+--------------------------------------+--------------------------------------------------------+
835
836Bug Fixes
837---------
mpriyank0b5950d2023-02-07 17:55:10 +00008383.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000839 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000840
841Features
842--------
843 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000844
leventecsanyi37d72852022-10-26 10:44:08 +0200845Version: 3.2.1
846==============
mpriyank4bd450e2022-10-05 09:50:59 +0100847
848Release Data
849------------
850
851+--------------------------------------+--------------------------------------------------------+
852| **CPS Project** | |
853| | |
854+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000855| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100856| | |
857+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200858| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100859| | |
860+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000861| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100862| | |
863+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100864
lukegleeson3be99242022-10-11 14:34:56 +0100865Features
866--------
leventecsanyi37d72852022-10-26 10:44:08 +02008673.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000868 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
869 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
870 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000871 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
872 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000873 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
lukegleesone0154a62023-01-25 15:06:52 +0000874 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
ToineSiebelink294bcb52022-12-23 11:07:42 +0000875 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000876 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000877 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000878 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
879 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
880 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100881
882Bug Fixes
883---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00008843.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000885 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
886 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
887 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
888 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
889 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
ToineSiebelink74eed2c2023-08-31 17:38:52 +0100890 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000891 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000892 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000893 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
894 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
895 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
896 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
897 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
898 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000899
leventecsanyi37d72852022-10-26 10:44:08 +02009003.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000901 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100902
lukegleeson3be99242022-10-11 14:34:56 +0100903Known Limitations, Issues and Workarounds
904-----------------------------------------
905
906*System Limitations*
907
seanbeirne72c267e2022-10-18 12:39:22 +0100908For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
909This 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.
lukegleeson3be99242022-10-11 14:34:56 +0100910
arpitsingh2b4c4882023-03-03 21:38:57 +0530911CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
912a 400 Bad Request is sent as response. This is part of commit CPS-1526.
913
seanbeirnedba2b102022-10-27 09:59:17 +0100914.. ====================
915.. * * * KOHN * * *
916.. ====================
917
mpriyankfe775312022-09-30 14:16:51 +0100918Version: 3.1.4
919==============
920
921Release Data
922------------
923
924+--------------------------------------+--------------------------------------------------------+
925| **CPS Project** | |
926| | |
927+--------------------------------------+--------------------------------------------------------+
928| **Docker images** | onap/cps-and-ncmp:3.1.4 |
929| | |
930+--------------------------------------+--------------------------------------------------------+
931| **Release designation** | 3.1.4 Kohn |
932| | |
933+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100934| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100935| | |
936+--------------------------------------+--------------------------------------------------------+
937
938Bug Fixes
939---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100940 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
mpriyankac0bffc2022-10-03 12:26:10 +0100941 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100942
mpriyank06736cb2022-09-29 14:29:40 +0100943Version: 3.1.3
944==============
945
946Release Data
947------------
948
949+--------------------------------------+--------------------------------------------------------+
950| **CPS Project** | |
951| | |
952+--------------------------------------+--------------------------------------------------------+
953| **Docker images** | onap/cps-and-ncmp:3.1.3 |
954| | |
955+--------------------------------------+--------------------------------------------------------+
956| **Release designation** | 3.1.3 Kohn |
957| | |
958+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100959| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100960| | |
961+--------------------------------------+--------------------------------------------------------+
962
963Bug Fixes
964---------
965 - None
966
mpriyankef0ddfc2022-09-28 12:19:34 +0100967Version: 3.1.2
968==============
969
970Release Data
971------------
972
973+--------------------------------------+--------------------------------------------------------+
974| **CPS Project** | |
975| | |
976+--------------------------------------+--------------------------------------------------------+
977| **Docker images** | onap/cps-and-ncmp:3.1.2 |
978| | |
979+--------------------------------------+--------------------------------------------------------+
980| **Release designation** | 3.1.2 Kohn |
981| | |
982+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100983| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100984| | |
985+--------------------------------------+--------------------------------------------------------+
986
987Bug Fixes
988---------
989 - None
990
mpriyanka3f43502022-09-26 14:57:01 +0100991Version: 3.1.1
992==============
993
994Release Data
995------------
996
997+--------------------------------------+--------------------------------------------------------+
998| **CPS Project** | |
999| | |
1000+--------------------------------------+--------------------------------------------------------+
1001| **Docker images** | onap/cps-and-ncmp:3.1.1 |
1002| | |
1003+--------------------------------------+--------------------------------------------------------+
1004| **Release designation** | 3.1.1 Kohn |
1005| | |
1006+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +01001007| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +01001008| | |
1009+--------------------------------------+--------------------------------------------------------+
1010
1011Bug Fixes
1012---------
1013 - None
1014
lukegleesonc9ec9152022-09-07 14:21:36 +01001015Security Notes
1016--------------
1017
1018*Fixed Security Issues*
1019
1020 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
1021
lukegleeson4a34fa52022-09-19 15:31:59 +01001022Version: 3.1.0
1023==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001024
1025Release Data
1026------------
1027
DylanB95ESTb130fd32022-04-04 13:09:22 +01001028+--------------------------------------+--------------------------------------------------------+
1029| **CPS Project** | |
1030| | |
1031+--------------------------------------+--------------------------------------------------------+
1032| **Docker images** | onap/cps-and-ncmp:3.1.0 |
1033| | |
1034+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001035| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +01001036| | |
1037+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +01001038| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +01001039| | |
1040+--------------------------------------+--------------------------------------------------------+
1041
1042Features
1043--------
lukegleeson4a34fa52022-09-19 15:31:59 +01001044 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
1045 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
1046 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
1047 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
1048 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
1049 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
1050 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
1051 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
1052 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
1053 - `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'
1054 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
1055 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
1056 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
1057 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
1058 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
1059 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
1060 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
1061 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
1062 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
1063 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
1064 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
1065 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
1066 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
1067 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
1068
emacleeafb17362022-09-02 14:40:17 +01001069
1070Bug Fixes
1071---------
lukegleeson4a34fa52022-09-19 15:31:59 +01001072 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
1073 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
1074 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
1075 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001076 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMI Handles registered
lukegleeson4a34fa52022-09-19 15:31:59 +01001077 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
1078 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
1079 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
1080 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
1081 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
1082 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
1083 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
1084 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
1085 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +01001086
1087Known Limitations, Issues and Workarounds
1088-----------------------------------------
1089
1090*System Limitations*
1091
1092Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
1093Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +01001094
lukegleeson4a34fa52022-09-19 15:31:59 +01001095*Known Vulnerabilities*
1096
1097None
1098
1099*Workarounds*
1100
1101None
1102
1103Security Notes
1104--------------
1105
1106*Fixed Security Issues*
1107
1108 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
1109
1110*Known Security Issues*
1111
1112None
1113
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001114.. ========================
1115.. * * * JAKARTA * * *
1116.. ========================
1117
1118Version: 3.0.1
1119==============
1120
1121Release Data
1122------------
1123
1124+--------------------------------------+--------------------------------------------------------+
1125| **CPS Project** | |
1126| | |
1127+--------------------------------------+--------------------------------------------------------+
1128| **Docker images** | onap/cps-and-ncmp:3.0.1 |
1129| | |
1130+--------------------------------------+--------------------------------------------------------+
1131| **Release designation** | 3.0.1 Jakarta |
1132| | |
1133+--------------------------------------+--------------------------------------------------------+
1134| **Release date** | 2022 April 28 |
1135| | |
1136+--------------------------------------+--------------------------------------------------------+
1137
1138Bug Fixes
1139---------
1140 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
1141
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001142Version: 3.0.0
1143==============
niamhcoref7b414e2021-11-17 11:02:07 +00001144
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001145Release Data
1146------------
1147
1148+--------------------------------------+--------------------------------------------------------+
1149| **CPS Project** | |
1150| | |
1151+--------------------------------------+--------------------------------------------------------+
1152| **Docker images** | onap/cps-and-ncmp:3.0.0 |
1153| | |
1154+--------------------------------------+--------------------------------------------------------+
1155| **Release designation** | 3.0.0 Jakarta |
1156| | |
1157+--------------------------------------+--------------------------------------------------------+
1158| **Release date** | 2022 March 15 |
1159| | |
1160+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +00001161
1162Features
1163--------
puthuparambil.adityad0007332021-12-08 18:53:39 +00001164 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +00001165 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
1166 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +00001167 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +00001168 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +00001169 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +00001170 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001171 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
1172 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +00001173 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
mpriyank80dee972022-02-23 15:17:23 +05301174 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
niamhcoref7b414e2021-11-17 11:02:07 +00001175
1176Bug Fixes
1177---------
1178
1179 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
ToineSiebelink3f142302021-12-07 11:30:10 +00001180 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +00001181 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
puthuparambil.aditya71395fb2022-01-05 13:39:31 +00001182 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
puthuparambil.aditya62ac0c32022-02-03 16:42:13 +00001183 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +00001184 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +00001185 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +00001186 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
mpriyank80dee972022-02-23 15:17:23 +05301187 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001188 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
niamhcoref7b414e2021-11-17 11:02:07 +00001189
1190Known Limitations, Issues and Workarounds
1191-----------------------------------------
1192
1193*System Limitations*
1194
DylanB95ESTe5573382022-01-27 17:12:52 +00001195Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
1196`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
1197of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +00001198
Lathishb3550f12022-03-15 12:03:53 +00001199The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
1200for more information.
1201
niamhcoref7b414e2021-11-17 11:02:07 +00001202*Known Vulnerabilities*
1203
1204None
1205
1206*Workarounds*
1207
DylanB95ESTe5573382022-01-27 17:12:52 +00001208Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
1209pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +00001210
1211Security Notes
1212--------------
1213
1214*Fixed Security Issues*
1215
1216None
1217
1218*Known Security Issues*
1219
1220None
1221
1222.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +01001223.. * * * ISTANBUL * * *
1224.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001225
Bruno Sakoto0eaf3342022-02-11 15:05:29 -05001226Version: 2.0.4
1227==============
1228
1229Release Data
1230------------
1231
1232+--------------------------------------+--------------------------------------------------------+
1233| **CPS Project** | |
1234| | |
1235+--------------------------------------+--------------------------------------------------------+
1236| **Docker images** | onap/cps-and-ncmp:2.0.4 |
1237| | |
1238+--------------------------------------+--------------------------------------------------------+
1239| **Release designation** | 2.0.4 Istanbul |
1240| | |
1241+--------------------------------------+--------------------------------------------------------+
1242| **Release date** | 2022 Feb 09 |
1243| | |
1244+--------------------------------------+--------------------------------------------------------+
1245
1246Bug Fixes
1247---------
1248
1249 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
1250 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
1251
1252Version: 2.0.3
1253==============
1254
1255Release Data
1256------------
1257
1258+--------------------------------------+--------------------------------------------------------+
1259| **CPS Project** | |
1260| | |
1261+--------------------------------------+--------------------------------------------------------+
1262| **Docker images** | onap/cps-and-ncmp:2.0.3 |
1263| | |
1264+--------------------------------------+--------------------------------------------------------+
1265| **Release designation** | 2.0.3 Istanbul |
1266| | |
1267+--------------------------------------+--------------------------------------------------------+
1268| **Release date** | 2022-07-01 |
1269| | |
1270+--------------------------------------+--------------------------------------------------------+
1271
1272Bug Fixes
1273---------
1274
1275 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
1276
1277Version: 2.0.2
1278==============
1279
1280Release Data
1281------------
1282
1283+--------------------------------------+--------------------------------------------------------+
1284| **CPS Project** | |
1285| | |
1286+--------------------------------------+--------------------------------------------------------+
1287| **Docker images** | onap/cps-and-ncmp:2.0.2 |
1288| | |
1289+--------------------------------------+--------------------------------------------------------+
1290| **Release designation** | 2.0.2 Istanbul |
1291| | |
1292+--------------------------------------+--------------------------------------------------------+
1293| **Release date** | 2021-16-12 |
1294| | |
1295+--------------------------------------+--------------------------------------------------------+
1296
1297Bug Fixes
1298---------
1299
1300 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
1301
lukegleeson9c583712021-09-30 17:21:11 +01001302Version: 2.0.1
1303==============
1304
1305Release Data
1306------------
1307
1308+--------------------------------------+--------------------------------------------------------+
1309| **CPS Project** | |
1310| | |
1311+--------------------------------------+--------------------------------------------------------+
1312| **Docker images** | onap/cps-and-ncmp:2.0.1 |
1313| | |
1314+--------------------------------------+--------------------------------------------------------+
1315| **Release designation** | 2.0.1 Istanbul |
1316| | |
1317+--------------------------------------+--------------------------------------------------------+
1318| **Release date** | 2021-14-10 |
1319| | |
1320+--------------------------------------+--------------------------------------------------------+
1321
1322Bug Fixes
1323---------
1324
1325 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1326 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1327 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1328 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1329
1330Known Limitations, Issues and Workarounds
1331-----------------------------------------
1332
1333*System Limitations*
1334
1335Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1336
1337*Known Vulnerabilities*
1338
1339 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1340
1341*Workarounds*
1342
1343Add recursive method to save list node data to loop through all corresponding child nodes.
1344
1345Security Notes
1346--------------
1347
1348*Fixed Security Issues*
1349
1350 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1351
1352*Known Security Issues*
1353
1354None
1355
shivasubedi44beaa32021-09-13 15:16:30 +01001356Version: 2.0.0
1357==============
1358
1359Abstract
1360--------
1361
1362This document provides the release notes for Istanbul release.
1363
1364Release Data
1365------------
1366
1367+--------------------------------------+--------------------------------------------------------+
1368| **CPS Project** | |
1369| | |
1370+--------------------------------------+--------------------------------------------------------+
1371| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1372| | |
1373+--------------------------------------+--------------------------------------------------------+
1374| **Release designation** | 2.0.0 Istanbul |
1375| | |
1376+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +01001377| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +01001378| | |
1379+--------------------------------------+--------------------------------------------------------+
1380
1381Features
1382--------
DylanB95EST3fcf8692021-10-11 16:29:16 +01001383* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +01001384* Update, Create and Remove CM Handles.
1385* Add support for retrieving and writing CM Handle data through NCMP datastores.
1386* Automatic retrieval and caching of model information for CM Handles within NCMP.
1387
shivasubedi44beaa32021-09-13 15:16:30 +01001388Deliverables
1389------------
1390
1391Software Deliverables
1392
1393.. csv-table::
1394 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1395 :widths: auto
1396
1397 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1398
1399Bug Fixes
1400---------
1401
lukegleeson9c583712021-09-30 17:21:11 +01001402 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001403 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1404 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
lukegleeson9c583712021-09-30 17:21:11 +01001405 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1406 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
shivasubedi44beaa32021-09-13 15:16:30 +01001407 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
lukegleeson9c583712021-09-30 17:21:11 +01001408 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
shivasubedi44beaa32021-09-13 15:16:30 +01001409 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1410 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001411 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1412 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1413 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
shivasubedi44beaa32021-09-13 15:16:30 +01001414 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1415 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
lukegleeson9c583712021-09-30 17:21:11 +01001416 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001417 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
shivasubedi44beaa32021-09-13 15:16:30 +01001418 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1419 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1420 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001421 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1422 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1423 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
Bruno Sakoto0eaf3342022-02-11 15:05:29 -05001424 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001425 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1426 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1427 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001428
1429This document provides the release notes for Istanbul release.
1430
1431Summary
1432-------
1433
1434Following CPS components are available with default ONAP/CPS installation.
1435
1436
1437 * Platform components
1438
1439 - CPS (Helm charts)
1440
1441 * Service components
1442
DylanB95EST3fcf8692021-10-11 16:29:16 +01001443 - CPS-NCMP
DylanB95EST3fcf8692021-10-11 16:29:16 +01001444 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001445
1446 * Additional resources that CPS utilizes deployed using ONAP common charts
1447
1448 - Postgres Database
1449
1450
1451Below service components (mS) are available to be deployed on-demand.
1452 - CPS-TBDMT
1453
1454
1455Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1456
1457Known Limitations, Issues and Workarounds
1458-----------------------------------------
1459
shivasubedi44beaa32021-09-13 15:16:30 +01001460*System Limitations*
1461
1462Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1463
1464*Known Vulnerabilities*
1465
lukegleeson9c583712021-09-30 17:21:11 +01001466 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1467 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1468 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001469
1470*Workarounds*
1471
1472Add recursive method to save list node data to loop through all corresponding child nodes.
1473
1474Security Notes
1475--------------
1476
1477*Fixed Security Issues*
1478
1479 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001480
1481*Known Security Issues*
1482
lukegleeson9c583712021-09-30 17:21:11 +01001483 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1484
shivasubedi44beaa32021-09-13 15:16:30 +01001485Test Results
1486------------
1487 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001488
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001489.. ========================
1490.. * * * HONOLULU * * *
1491.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001492
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001493Version: 1.0.1
1494==============
1495
1496Release Data
1497------------
1498
1499+--------------------------------------+--------------------------------------------------------+
1500| **CPS Project** | |
1501| | |
1502+--------------------------------------+--------------------------------------------------------+
1503| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1504| | |
1505+--------------------------------------+--------------------------------------------------------+
1506| **Release designation** | 1.0.1 Honolulu |
1507| | |
1508+--------------------------------------+--------------------------------------------------------+
1509| **Release date** | 2021-04-09 |
1510| | |
1511+--------------------------------------+--------------------------------------------------------+
1512
1513Bug Fixes
1514---------
1515
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001516 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001517 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1518 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1519 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1520 - `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
1521 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1522 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1523 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1524
1525Security Notes
1526--------------
1527
1528*Fixed Security Issues*
1529
1530 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001531
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001532*Known Security Issues*
1533
1534 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1535
Rishi.Chail4359d282021-03-03 16:36:26 +00001536Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001537==============
1538
1539
1540Abstract
1541--------
1542
1543This document provides the release notes for Honolulu release.
1544
1545Summary
1546-------
1547
1548Following CPS components are available with default ONAP/CPS installation.
1549
1550
Rishi.Chail4359d282021-03-03 16:36:26 +00001551 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001552
Rishi.Chail4359d282021-03-03 16:36:26 +00001553 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001554
Rishi.Chail4359d282021-03-03 16:36:26 +00001555 * Service components
1556
1557 - CPS Core
1558
1559 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001560
1561 - Postgres Database
1562
1563
Rishi.Chail4359d282021-03-03 16:36:26 +00001564Below service components (mS) are available to be deployed on-demand.
1565 - CPS-TBDMT
1566
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001567
1568Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1569
1570
1571Release Data
1572------------
1573
1574+--------------------------------------+--------------------------------------------------------+
1575| **CPS Project** | |
1576| | |
1577+--------------------------------------+--------------------------------------------------------+
1578| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1579| | |
1580+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001581| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001582| | |
1583+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001584| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001585| | |
1586+--------------------------------------+--------------------------------------------------------+
1587
1588
1589Features
1590--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001591Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1592CPS has been driven by the needs of the E2E Networking Slicing use case.
1593It currently supports basic (rw) persistence and simple queries.
1594It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001595
1596.. _honolulu_deliverable:
1597
1598Deliverables
1599------------
1600
1601Software Deliverables
1602
1603.. csv-table::
1604 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1605 :widths: auto
1606
Rishi.Chail4359d282021-03-03 16:36:26 +00001607 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001608
1609
1610Known Limitations, Issues and Workarounds
1611-----------------------------------------
1612
Rishi.Chail4359d282021-03-03 16:36:26 +00001613 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1614 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1615 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001616 - `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.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001617
1618*System Limitations*
1619
1620None
1621
1622*Known Vulnerabilities*
1623
1624None
1625
1626*Workarounds*
1627
1628Documented under corresponding jira if applicable.
1629
1630Security Notes
1631--------------
1632
1633*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001634
1635* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001636 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001637 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001638 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001639
1640*Known Security Issues*
1641
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001642 * Weak Cryptography using md5
Rishi.Chail4359d282021-03-03 16:36:26 +00001643 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001644
1645*Known Vulnerabilities in Used Modules*
1646
Rishi.Chail4359d282021-03-03 16:36:26 +00001647 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001648
Rishi.Chail4359d282021-03-03 16:36:26 +00001649CPS 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.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001650
1651Test Results
1652------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001653 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001654
1655References
1656----------
1657
ToineSiebelinkcac21862023-06-22 09:24:04 +01001658For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001659
1660#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001661#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001662#. `ONAP Documentation`_
1663#. `ONAP CPS Documentation`_
1664#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001665
1666
1667.. _`ONAP Home Page`: https://www.onap.org
1668.. _`ONAP Wiki Page`: https://wiki.onap.org
1669.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001670.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001671.. _`ONAP Release Downloads`: https://git.onap.org
1672
1673Quick Links:
1674
1675 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1676 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_