blob: e14a725f7296dd9699346a4369858d11745bc2f9 [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
mpriyank59575272024-06-20 12:59:02 +010015.. ====================
16.. * * * OSLO * * *
17.. ====================
niamhcoref7b414e2021-11-17 11:02:07 +000018
mpriyankf582c462024-06-20 15:22:14 +010019Version: 3.5.1
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.5.1 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.5.1 Oslo |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.5.1
42
43Features
44--------
453.5.1
46
mpriyank59575272024-06-20 12:59:02 +010047Version: 3.5.0
48==============
mpriyankc6f18cf2024-05-14 10:09:55 +010049
50Release Data
51------------
52
53+--------------------------------------+--------------------------------------------------------+
54| **CPS Project** | |
55| | |
56+--------------------------------------+--------------------------------------------------------+
mpriyank59575272024-06-20 12:59:02 +010057| **Docker images** | onap/cps-and-ncmp:3.5.0 |
mpriyankc6f18cf2024-05-14 10:09:55 +010058| | |
59+--------------------------------------+--------------------------------------------------------+
mpriyank59575272024-06-20 12:59:02 +010060| **Release designation** | 3.5.0 Oslo |
mpriyankc6f18cf2024-05-14 10:09:55 +010061| | |
62+--------------------------------------+--------------------------------------------------------+
mpriyankf582c462024-06-20 15:22:14 +010063| **Release date** | 2024 June 20 |
mpriyankc6f18cf2024-05-14 10:09:55 +010064| | |
65+--------------------------------------+--------------------------------------------------------+
66
67Bug Fixes
68---------
mpriyank59575272024-06-20 12:59:02 +0100693.5.0
mpriyankc6f18cf2024-05-14 10:09:55 +010070
71Features
72--------
mpriyank59575272024-06-20 12:59:02 +0100733.5.0
74 - `CPS-989 <https://jira.onap.org/browse/CPS-989>`_ Replace RestTemplate with WebClient.
75 - `CPS-2172 <https://jira.onap.org/browse/CPS-2172>`_ Support for OpenTelemetry Tracing.
76
77.. =========================
78.. * * * NEW DELHI * * *
79.. =========================
mpriyankc6f18cf2024-05-14 10:09:55 +010080
danielhanrahana44b0562024-05-01 13:53:00 +010081Version: 3.4.9
82==============
83
84Release Data
85------------
86
87+--------------------------------------+--------------------------------------------------------+
88| **CPS Project** | |
89| | |
90+--------------------------------------+--------------------------------------------------------+
91| **Docker images** | onap/cps-and-ncmp:3.4.9 |
92| | |
93+--------------------------------------+--------------------------------------------------------+
94| **Release designation** | 3.4.9 New Delhi |
95| | |
96+--------------------------------------+--------------------------------------------------------+
mpriyankc6f18cf2024-05-14 10:09:55 +010097| **Release date** | 2024 May 14 |
danielhanrahana44b0562024-05-01 13:53:00 +010098| | |
99+--------------------------------------+--------------------------------------------------------+
100
101Bug Fixes
102---------
1033.4.9
mpriyank5c099bc2024-05-09 11:46:09 +0100104 - `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 +0100105
106Features
107--------
Arpit Singhd7fa9602023-09-07 17:05:37 +05301083.4.9
109 - `CPS-1836 <https://jira.onap.org/browse/CPS-1836>`_ Delta between anchor and JSON payload.
danielhanrahana44b0562024-05-01 13:53:00 +0100110
mpriyank0ac5d962024-03-29 13:47:19 +0000111Version: 3.4.8
112==============
113
114Release Data
115------------
116
117+--------------------------------------+--------------------------------------------------------+
118| **CPS Project** | |
119| | |
120+--------------------------------------+--------------------------------------------------------+
121| **Docker images** | onap/cps-and-ncmp:3.4.8 |
122| | |
123+--------------------------------------+--------------------------------------------------------+
124| **Release designation** | 3.4.8 New Delhi |
125| | |
126+--------------------------------------+--------------------------------------------------------+
danielhanrahana44b0562024-05-01 13:53:00 +0100127| **Release date** | 2024 May 1 |
mpriyank0ac5d962024-03-29 13:47:19 +0000128| | |
129+--------------------------------------+--------------------------------------------------------+
130
danielhanrahanbbfb0612024-04-16 22:04:44 +0100131Bug Fixes
132---------
1333.4.8
134 - `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 +0100135 - `CPS-2190 <https://jira.onap.org/browse/CPS-2190>`_ Improve performance of NCMP module searches
136 - `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 +0100137 - `CPS-2204 <https://jira.onap.org/browse/CPS-2204>`_ Added error handling for yang module upgrade operation
danielhanrahanbbfb0612024-04-16 22:04:44 +0100138
mpriyank0ac5d962024-03-29 13:47:19 +0000139Features
140--------
141
mpriyanka1703ea2024-02-29 17:47:47 +0000142Version: 3.4.7
143==============
144
145Release Data
146------------
147
148+--------------------------------------+--------------------------------------------------------+
149| **CPS Project** | |
150| | |
151+--------------------------------------+--------------------------------------------------------+
152| **Docker images** | onap/cps-and-ncmp:3.4.7 |
153| | |
154+--------------------------------------+--------------------------------------------------------+
155| **Release designation** | 3.4.7 New Delhi |
156| | |
157+--------------------------------------+--------------------------------------------------------+
mpriyank0ac5d962024-03-29 13:47:19 +0000158| **Release date** | 2024 March 29 |
mpriyanka1703ea2024-02-29 17:47:47 +0000159| | |
160+--------------------------------------+--------------------------------------------------------+
161
162Bug Fixes
163---------
1643.4.7
mpriyank6b0e6b32024-03-08 12:50:53 +0000165 - `CPS-2150 <https://jira.onap.org/browse/CPS-2150>`_ Fix for Async task execution failed by TimeoutException.
mpriyanka1703ea2024-02-29 17:47:47 +0000166
167Features
168--------
david.mcweeney23378b52024-02-21 09:51:29 +00001693.4.7
170 - `CPS-2061 <https://jira.onap.org/browse/CPS-2061>`_ Liquibase Steps Condensing and Cleanup.
mpriyankb4f8b792024-03-29 10:57:05 +0000171 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot to 3.2.4 version.
mpriyanka1703ea2024-02-29 17:47:47 +0000172
mpriyank22e1f432024-02-27 14:04:38 +0000173Version: 3.4.6
174==============
175
176Release Data
177------------
178
179+--------------------------------------+--------------------------------------------------------+
180| **CPS Project** | |
181| | |
182+--------------------------------------+--------------------------------------------------------+
183| **Docker images** | onap/cps-and-ncmp:3.4.6 |
184| | |
185+--------------------------------------+--------------------------------------------------------+
186| **Release designation** | 3.4.6 New Delhi |
187| | |
188+--------------------------------------+--------------------------------------------------------+
mpriyanka1703ea2024-02-29 17:47:47 +0000189| **Release date** | 2024 February 29 |
mpriyank22e1f432024-02-27 14:04:38 +0000190| | |
191+--------------------------------------+--------------------------------------------------------+
192
193Bug Fixes
194---------
1953.4.6
mpriyank4a978d32024-02-29 14:39:00 +0000196 - `CPS-2126 <https://jira.onap.org/browse/CPS-2126>`_ Passing HTTP Authorization Bearer Token to DMI Plugins.
mpriyank22e1f432024-02-27 14:04:38 +0000197
198
199Features
200--------
mpriyank4a978d32024-02-29 14:39:00 +0000201 - `CPS-2133 <https://jira.onap.org/browse/CPS-2133>`_ Revert Uplift of Spring Boot version from 3.2.2 to 3.1.2
202
203Notes
204-----
205This release brings improvements to compatibility with Service Mesh and for that below measures are been taken.
206
207Basic 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).
208NCMP will propagate a bearer token to DMI conditionally.
209401 Unauthorized will not be returned. Best effort has been made to ensure backwards compatibility.
mpriyank22e1f432024-02-27 14:04:38 +0000210
danielhanrahanb8e677f2024-02-23 15:27:17 +0000211Version: 3.4.5
212==============
213
214Release Data
215------------
216
217+--------------------------------------+--------------------------------------------------------+
218| **CPS Project** | |
219| | |
220+--------------------------------------+--------------------------------------------------------+
221| **Docker images** | onap/cps-and-ncmp:3.4.5 |
222| | |
223+--------------------------------------+--------------------------------------------------------+
224| **Release designation** | 3.4.5 New Delhi |
225| | |
226+--------------------------------------+--------------------------------------------------------+
mpriyank22e1f432024-02-27 14:04:38 +0000227| **Release date** | 2024 February 27 |
danielhanrahanb8e677f2024-02-23 15:27:17 +0000228| | |
229+--------------------------------------+--------------------------------------------------------+
230
231Bug Fixes
232---------
2333.4.5
234
235
236Features
237--------
mpriyankcfac7192024-02-27 12:21:53 +0000238 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot version to 3.2.2
danielhanrahanb8e677f2024-02-23 15:27:17 +0000239
240
danielhanrahan97bad452024-02-07 16:07:27 +0000241Version: 3.4.4
242==============
243
244Release Data
245------------
246
247+--------------------------------------+--------------------------------------------------------+
248| **CPS Project** | |
249| | |
250+--------------------------------------+--------------------------------------------------------+
251| **Docker images** | onap/cps-and-ncmp:3.4.4 |
252| | |
253+--------------------------------------+--------------------------------------------------------+
254| **Release designation** | 3.4.4 New Delhi |
255| | |
256+--------------------------------------+--------------------------------------------------------+
danielhanrahanb8e677f2024-02-23 15:27:17 +0000257| **Release date** | 2024 February 23 |
danielhanrahan97bad452024-02-07 16:07:27 +0000258| | |
259+--------------------------------------+--------------------------------------------------------+
260
261Bug Fixes
262---------
2633.4.4
danielhanrahan8c37c032024-02-23 13:27:37 +0000264 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Upgrade Yang modules using module set tag functionalities fix
danielhanrahan97bad452024-02-07 16:07:27 +0000265
266Features
267--------
danielhanrahan8c37c032024-02-23 13:27:37 +0000268 - `CPS-2057 <https://jira.onap.org/browse/CPS-2057>`_ Leaf lists are sorted by default if Yang model does not specify order.
269 - `CPS-2087 <https://jira.onap.org/browse/CPS-2087>`_ Performance improvement of CPS Path Queries.
danielhanrahan97bad452024-02-07 16:07:27 +0000270
271
danielhanrahan345f40f2024-01-11 15:25:18 +0000272Version: 3.4.3
273==============
274
275Release Data
276------------
277
278+--------------------------------------+--------------------------------------------------------+
279| **CPS Project** | |
280| | |
281+--------------------------------------+--------------------------------------------------------+
282| **Docker images** | onap/cps-and-ncmp:3.4.3 |
283| | |
284+--------------------------------------+--------------------------------------------------------+
285| **Release designation** | 3.4.3 New Delhi |
286| | |
287+--------------------------------------+--------------------------------------------------------+
danielhanrahan97bad452024-02-07 16:07:27 +0000288| **Release date** | 2024 February 07 |
danielhanrahan345f40f2024-01-11 15:25:18 +0000289| | |
290+--------------------------------------+--------------------------------------------------------+
291
292Bug Fixes
293---------
2943.4.3
danielhanrahan7ce495b2024-02-07 14:21:58 +0000295 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed.
296 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag.
297 - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer.
danielhanrahan345f40f2024-01-11 15:25:18 +0000298
299Features
300--------
Arpit Singh1322b0f2024-01-19 13:46:03 +0530301 - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors.
danielhanrahan81f61b52024-02-02 12:25:47 +0000302 - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR.
halil.cakalc1b09262024-02-08 12:15:48 +0000303 - `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 +0000304
305Notes
306-----
307The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a
308*-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename
309of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*.
danielhanrahan345f40f2024-01-11 15:25:18 +0000310
danielhanrahan9437af62023-12-20 15:12:47 +0000311Version: 3.4.2
312==============
313
314Release Data
315------------
316
317+--------------------------------------+--------------------------------------------------------+
318| **CPS Project** | |
319| | |
320+--------------------------------------+--------------------------------------------------------+
321| **Docker images** | onap/cps-and-ncmp:3.4.2 |
322| | |
323+--------------------------------------+--------------------------------------------------------+
324| **Release designation** | 3.4.2 New Delhi |
325| | |
326+--------------------------------------+--------------------------------------------------------+
danielhanrahan345f40f2024-01-11 15:25:18 +0000327| **Release date** | 2024 January 11 |
danielhanrahan9437af62023-12-20 15:12:47 +0000328| | |
329+--------------------------------------+--------------------------------------------------------+
330
331Bug Fixes
332---------
3333.4.2
334
335
336Features
337--------
halil.cakal37c6d4d2024-01-11 11:10:17 +0000338 - `CPS-1638 <https://jira.onap.org/browse/CPS-1638>`_ Introduce trust level for CM handle.
danielhanrahan36b81b22023-08-17 14:58:30 +0100339 - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
danielhanrahan9e871802023-08-17 14:58:30 +0100340 - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
danielhanrahan926d4082023-08-04 11:22:43 +0100341 - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
342
343Notes
344-----
345 - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
danielhanrahan9437af62023-12-20 15:12:47 +0000346
danielhanrahan36b81b22023-08-17 14:58:30 +0100347Known Limitations, Issues and Workarounds
348-----------------------------------------
349
350*System Limitations*
351
352For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
353(`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
354As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
355NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
356Other operations (read, update, delete) are not impacted.
357
danielhanrahan9437af62023-12-20 15:12:47 +0000358
mpriyank1d9dae02023-11-09 14:11:26 +0000359Version: 3.4.1
360==============
361
362Release Data
363------------
364
365+--------------------------------------+--------------------------------------------------------+
366| **CPS Project** | |
367| | |
368+--------------------------------------+--------------------------------------------------------+
369| **Docker images** | onap/cps-and-ncmp:3.4.1 |
370| | |
371+--------------------------------------+--------------------------------------------------------+
372| **Release designation** | 3.4.1 New Delhi |
373| | |
374+--------------------------------------+--------------------------------------------------------+
danielhanrahan9437af62023-12-20 15:12:47 +0000375| **Release date** | 2023 December 20 |
mpriyank1d9dae02023-11-09 14:11:26 +0000376| | |
377+--------------------------------------+--------------------------------------------------------+
378
379Bug Fixes
380---------
danielhanrahan3e14d392023-12-20 13:31:07 +00003813.4.1
mpriyank41727e52023-12-04 18:01:07 +0000382 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
mpriyank1d9dae02023-11-09 14:11:26 +0000383
ToineSiebelink8ee94852023-11-27 14:52:19 +0000384Features
385--------
386 - CPS-Temporal is no longer supported and any related documentation has been removed.
danielhanrahan3e14d392023-12-20 13:31:07 +0000387 - `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 +0000388 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
waqas.ikram60bbcb92023-12-20 10:40:29 +0000389 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
mpriyankdb6b8f82023-12-14 13:27:01 +0000390 - `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 +0000391
danielhanrahan3e14d392023-12-20 13:31:07 +0000392Known Issues
393------------
394 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
395
ToineSiebelink8ee94852023-11-27 14:52:19 +0000396
mpriyank89e0fe22023-11-09 12:12:38 +0000397Version: 3.4.0
398==============
mpriyank2c4535d2023-11-06 17:06:15 +0000399
400Release Data
401------------
402
403+--------------------------------------+--------------------------------------------------------+
404| **CPS Project** | |
405| | |
406+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000407| **Docker images** | onap/cps-and-ncmp:3.4.0 |
mpriyank2c4535d2023-11-06 17:06:15 +0000408| | |
409+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000410| **Release designation** | 3.4.0 New Delhi |
mpriyank2c4535d2023-11-06 17:06:15 +0000411| | |
412+--------------------------------------+--------------------------------------------------------+
mpriyank1d9dae02023-11-09 14:11:26 +0000413| **Release date** | 2023 November 09 |
mpriyank2c4535d2023-11-06 17:06:15 +0000414| | |
415+--------------------------------------+--------------------------------------------------------+
416
417Bug Fixes
418---------
mpriyank89e0fe22023-11-09 12:12:38 +00004193.4.0
420 - `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 +0000421
mpriyank89e0fe22023-11-09 12:12:38 +0000422.. ========================
423.. * * * MONTREAL * * *
424.. ========================
mpriyank2c4535d2023-11-06 17:06:15 +0000425
egernugd91a7072023-09-29 12:12:36 +0100426Version: 3.3.9
427==============
428
429Release Data
430------------
431
432+--------------------------------------+--------------------------------------------------------+
433| **CPS Project** | |
434| | |
435+--------------------------------------+--------------------------------------------------------+
436| **Docker images** | onap/cps-and-ncmp:3.3.9 |
437| | |
438+--------------------------------------+--------------------------------------------------------+
439| **Release designation** | 3.3.9 Montreal |
440| | |
441+--------------------------------------+--------------------------------------------------------+
mpriyank2c4535d2023-11-06 17:06:15 +0000442| **Release date** | 2023 November 06 |
egernugd91a7072023-09-29 12:12:36 +0100443| | |
444+--------------------------------------+--------------------------------------------------------+
445
446Bug Fixes
447---------
4483.3.9
mpriyank02b2d2a2023-10-25 12:23:10 +0100449 - `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 +0000450 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
egernugd91a7072023-09-29 12:12:36 +0100451
452Features
453--------
454
danielhanrahan56384d12023-09-20 17:10:40 +0100455Version: 3.3.8
456==============
457
458Release Data
459------------
460
461+--------------------------------------+--------------------------------------------------------+
462| **CPS Project** | |
463| | |
464+--------------------------------------+--------------------------------------------------------+
465| **Docker images** | onap/cps-and-ncmp:3.3.8 |
466| | |
467+--------------------------------------+--------------------------------------------------------+
468| **Release designation** | 3.3.8 Montreal |
469| | |
470+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +0100471| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +0100472| | |
473+--------------------------------------+--------------------------------------------------------+
474
475Bug Fixes
476---------
4773.3.8
478
479Features
480--------
egernugcb9d1502023-09-28 09:57:44 +0100481 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +0100482
leventecsanyid35ad5c2023-08-23 15:55:30 +0200483Version: 3.3.7
484==============
485
486Release Data
487------------
488
489+--------------------------------------+--------------------------------------------------------+
490| **CPS Project** | |
491| | |
492+--------------------------------------+--------------------------------------------------------+
493| **Docker images** | onap/cps-and-ncmp:3.3.7 |
494| | |
495+--------------------------------------+--------------------------------------------------------+
496| **Release designation** | 3.3.7 Montreal |
497| | |
498+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +0100499| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +0200500| | |
501+--------------------------------------+--------------------------------------------------------+
502
503Bug Fixes
504---------
5053.3.7
danielhanrahanefc55772023-09-15 12:02:35 +0100506 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +0200507
508Features
509--------
egernugcb9d1502023-09-28 09:57:44 +0100510 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100511
512Note
513----
514Migrating 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 +0200515
egernugbdac4402023-07-21 13:27:24 +0100516Version: 3.3.6
517==============
518
519Release Data
520------------
521
522+--------------------------------------+--------------------------------------------------------+
523| **CPS Project** | |
524| | |
525+--------------------------------------+--------------------------------------------------------+
526| **Docker images** | onap/cps-and-ncmp:3.3.6 |
527| | |
528+--------------------------------------+--------------------------------------------------------+
529| **Release designation** | 3.3.6 Montreal |
530| | |
531+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200532| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100533| | |
534+--------------------------------------+--------------------------------------------------------+
535
536Bug Fixes
537---------
5383.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100539 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100540 - `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 +0100541
542Features
543--------
danielhanrahan92705462023-05-18 10:18:10 +0100544 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100545 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100546
547
egernug6c9621a2023-07-19 11:05:00 +0100548Version: 3.3.5
549==============
550
551Release Data
552------------
553
554+--------------------------------------+--------------------------------------------------------+
555| **CPS Project** | |
556| | |
557+--------------------------------------+--------------------------------------------------------+
558| **Docker images** | onap/cps-and-ncmp:3.3.5 |
559| | |
560+--------------------------------------+--------------------------------------------------------+
561| **Release designation** | 3.3.5 Montreal |
562| | |
563+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100564| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100565| | |
566+--------------------------------------+--------------------------------------------------------+
567
568Bug Fixes
569---------
5703.3.5
571
572Features
573--------
danielhanrahan74a47152023-06-28 12:55:20 +0100574 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100575
mpriyank8caa3422023-06-30 11:14:10 +0100576Version: 3.3.4
577==============
578
579Release Data
580------------
581
582+--------------------------------------+--------------------------------------------------------+
583| **CPS Project** | |
584| | |
585+--------------------------------------+--------------------------------------------------------+
586| **Docker images** | onap/cps-and-ncmp:3.3.4 |
587| | |
588+--------------------------------------+--------------------------------------------------------+
589| **Release designation** | 3.3.4 Montreal |
590| | |
591+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100592| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100593| | |
594+--------------------------------------+--------------------------------------------------------+
595
596Bug Fixes
597---------
5983.3.4
599
600Features
601--------
egernugdb62ffb2023-07-18 10:57:42 +0100602 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100603
danielhanrahan19f963b2023-06-15 13:52:34 +0100604Version: 3.3.3
605==============
606
607Release Data
608------------
609
610+--------------------------------------+--------------------------------------------------------+
611| **CPS Project** | |
612| | |
613+--------------------------------------+--------------------------------------------------------+
614| **Docker images** | onap/cps-and-ncmp:3.3.3 |
615| | |
616+--------------------------------------+--------------------------------------------------------+
617| **Release designation** | 3.3.3 Montreal |
618| | |
619+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100620| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100621| | |
622+--------------------------------------+--------------------------------------------------------+
623
624Bug Fixes
625---------
6263.3.3
627
628Features
629--------
mpriyank6da95412023-06-29 16:56:11 +0100630 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
631 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
632 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100633
mpriyank436b75b2023-05-03 11:10:08 +0100634Version: 3.3.2
635==============
636
637Release Data
638------------
639
640+--------------------------------------+--------------------------------------------------------+
641| **CPS Project** | |
642| | |
643+--------------------------------------+--------------------------------------------------------+
644| **Docker images** | onap/cps-and-ncmp:3.3.2 |
645| | |
646+--------------------------------------+--------------------------------------------------------+
647| **Release designation** | 3.3.2 Montreal |
648| | |
649+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100650| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100651| | |
652+--------------------------------------+--------------------------------------------------------+
653
654Bug Fixes
655---------
6563.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100657 - `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 +0100658
659Features
660--------
--globalc7e5a802023-04-05 17:08:08 +0530661 - `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 +0100662 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
663 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
664 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
665 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100666
lukegleesond7764c42023-04-20 14:11:20 +0100667Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000668==============
669
670Release Data
671------------
672
673+--------------------------------------+--------------------------------------------------------+
674| **CPS Project** | |
675| | |
676+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100677| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000678| | |
679+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100680| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000681| | |
682+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100683| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000684| | |
685+--------------------------------------+--------------------------------------------------------+
686
687Bug Fixes
688---------
lukegleesond7764c42023-04-20 14:11:20 +01006893.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000690 - None
691
692Features
693--------
mpriyank52c5e542023-05-02 15:58:55 +0100694 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
695 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
696 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
697 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
698 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000699
lukegleesond7764c42023-04-20 14:11:20 +0100700Version: 3.3.0
701==============
702
703Release Data
704------------
705
706+--------------------------------------+--------------------------------------------------------+
707| **CPS Project** | |
708| | |
709+--------------------------------------+--------------------------------------------------------+
710| **Docker images** | onap/cps-and-ncmp:3.3.0 |
711| | |
712+--------------------------------------+--------------------------------------------------------+
713| **Release designation** | 3.3.0 Montreal |
714| | |
715+--------------------------------------+--------------------------------------------------------+
716| **Release date** | 2023 April 20 |
717| | |
718+--------------------------------------+--------------------------------------------------------+
719
720Bug Fixes
721---------
7223.3.0
723 - None
724
725Features
726--------
727 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
728 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
729
730.. ======================
731.. * * * LONDON * * *
732.. ======================
733
mpriyank0fd4d192023-03-10 13:48:20 +0000734Version: 3.2.6
735==============
736
737Release Data
738------------
739
740+--------------------------------------+--------------------------------------------------------+
741| **CPS Project** | |
742| | |
743+--------------------------------------+--------------------------------------------------------+
744| **Docker images** | onap/cps-and-ncmp:3.2.6 |
745| | |
746+--------------------------------------+--------------------------------------------------------+
747| **Release designation** | 3.2.6 London |
748| | |
749+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000750| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000751| | |
752+--------------------------------------+--------------------------------------------------------+
753
754Bug Fixes
755---------
7563.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530757 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000758 - `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 +0000759
760Features
761--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000762 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000763
mpriyankade5a6e2023-03-09 17:58:31 +0000764Version: 3.2.5
765==============
766
767Release Data
768------------
769
770+--------------------------------------+--------------------------------------------------------+
771| **CPS Project** | |
772| | |
773+--------------------------------------+--------------------------------------------------------+
774| **Docker images** | onap/cps-and-ncmp:3.2.5 |
775| | |
776+--------------------------------------+--------------------------------------------------------+
777| **Release designation** | 3.2.5 London |
778| | |
779+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000780| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000781| | |
782+--------------------------------------+--------------------------------------------------------+
783
784Bug Fixes
785---------
7863.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000787 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000788
789Features
790--------
791 - None
792
seanbeirnef0f4fd82023-03-07 13:42:04 +0000793Version: 3.2.4
794==============
795
796Release Data
797------------
798
799+--------------------------------------+--------------------------------------------------------+
800| **CPS Project** | |
801| | |
802+--------------------------------------+--------------------------------------------------------+
803| **Docker images** | onap/cps-and-ncmp:3.2.4 |
804| | |
805+--------------------------------------+--------------------------------------------------------+
806| **Release designation** | 3.2.4 London |
807| | |
808+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000809| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000810| | |
811+--------------------------------------+--------------------------------------------------------+
812
813Bug Fixes
814---------
8153.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000816 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
817 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
818
819Features
820--------
821 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000822
mpriyankfd43dbe2023-02-08 11:21:08 +0000823Version: 3.2.3
824==============
825
826Release Data
827------------
828
829+--------------------------------------+--------------------------------------------------------+
830| **CPS Project** | |
831| | |
832+--------------------------------------+--------------------------------------------------------+
833| **Docker images** | onap/cps-and-ncmp:3.2.3 |
834| | |
835+--------------------------------------+--------------------------------------------------------+
836| **Release designation** | 3.2.3 London |
837| | |
838+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000839| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000840| | |
841+--------------------------------------+--------------------------------------------------------+
842
843Bug Fixes
844---------
8453.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000846 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000847
848Features
849--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000850 - `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
851 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000852
seanbeirnef8e980a2023-01-27 18:09:33 +0000853Version: 3.2.2
854==============
855
856Release Data
857------------
858
859+--------------------------------------+--------------------------------------------------------+
860| **CPS Project** | |
861| | |
862+--------------------------------------+--------------------------------------------------------+
863| **Docker images** | onap/cps-and-ncmp:3.2.2 |
864| | |
865+--------------------------------------+--------------------------------------------------------+
866| **Release designation** | 3.2.2 London |
867| | |
868+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000869| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000870| | |
871+--------------------------------------+--------------------------------------------------------+
872
873Bug Fixes
874---------
mpriyank0b5950d2023-02-07 17:55:10 +00008753.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000876 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000877
878Features
879--------
880 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000881
leventecsanyi37d72852022-10-26 10:44:08 +0200882Version: 3.2.1
883==============
mpriyank4bd450e2022-10-05 09:50:59 +0100884
885Release Data
886------------
887
888+--------------------------------------+--------------------------------------------------------+
889| **CPS Project** | |
890| | |
891+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000892| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100893| | |
894+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200895| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100896| | |
897+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000898| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100899| | |
900+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100901
lukegleeson3be99242022-10-11 14:34:56 +0100902Features
903--------
leventecsanyi37d72852022-10-26 10:44:08 +02009043.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000905 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
906 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
907 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000908 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
909 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000910 - `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 +0000911 - `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 +0000912 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000913 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000914 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000915 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
916 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
917 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100918
919Bug Fixes
920---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00009213.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000922 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
923 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
924 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
925 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
926 - `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 +0100927 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000928 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000929 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000930 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
931 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
932 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
933 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
934 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
935 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000936
leventecsanyi37d72852022-10-26 10:44:08 +02009373.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000938 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100939
lukegleeson3be99242022-10-11 14:34:56 +0100940Known Limitations, Issues and Workarounds
941-----------------------------------------
942
943*System Limitations*
944
seanbeirne72c267e2022-10-18 12:39:22 +0100945For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
946This 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 +0100947
arpitsingh2b4c4882023-03-03 21:38:57 +0530948CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
949a 400 Bad Request is sent as response. This is part of commit CPS-1526.
950
seanbeirnedba2b102022-10-27 09:59:17 +0100951.. ====================
952.. * * * KOHN * * *
953.. ====================
954
mpriyankfe775312022-09-30 14:16:51 +0100955Version: 3.1.4
956==============
957
958Release Data
959------------
960
961+--------------------------------------+--------------------------------------------------------+
962| **CPS Project** | |
963| | |
964+--------------------------------------+--------------------------------------------------------+
965| **Docker images** | onap/cps-and-ncmp:3.1.4 |
966| | |
967+--------------------------------------+--------------------------------------------------------+
968| **Release designation** | 3.1.4 Kohn |
969| | |
970+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100971| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100972| | |
973+--------------------------------------+--------------------------------------------------------+
974
975Bug Fixes
976---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100977 - `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 +0100978 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100979
mpriyank06736cb2022-09-29 14:29:40 +0100980Version: 3.1.3
981==============
982
983Release Data
984------------
985
986+--------------------------------------+--------------------------------------------------------+
987| **CPS Project** | |
988| | |
989+--------------------------------------+--------------------------------------------------------+
990| **Docker images** | onap/cps-and-ncmp:3.1.3 |
991| | |
992+--------------------------------------+--------------------------------------------------------+
993| **Release designation** | 3.1.3 Kohn |
994| | |
995+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100996| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100997| | |
998+--------------------------------------+--------------------------------------------------------+
999
1000Bug Fixes
1001---------
1002 - None
1003
mpriyankef0ddfc2022-09-28 12:19:34 +01001004Version: 3.1.2
1005==============
1006
1007Release Data
1008------------
1009
1010+--------------------------------------+--------------------------------------------------------+
1011| **CPS Project** | |
1012| | |
1013+--------------------------------------+--------------------------------------------------------+
1014| **Docker images** | onap/cps-and-ncmp:3.1.2 |
1015| | |
1016+--------------------------------------+--------------------------------------------------------+
1017| **Release designation** | 3.1.2 Kohn |
1018| | |
1019+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +01001020| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +01001021| | |
1022+--------------------------------------+--------------------------------------------------------+
1023
1024Bug Fixes
1025---------
1026 - None
1027
mpriyanka3f43502022-09-26 14:57:01 +01001028Version: 3.1.1
1029==============
1030
1031Release Data
1032------------
1033
1034+--------------------------------------+--------------------------------------------------------+
1035| **CPS Project** | |
1036| | |
1037+--------------------------------------+--------------------------------------------------------+
1038| **Docker images** | onap/cps-and-ncmp:3.1.1 |
1039| | |
1040+--------------------------------------+--------------------------------------------------------+
1041| **Release designation** | 3.1.1 Kohn |
1042| | |
1043+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +01001044| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +01001045| | |
1046+--------------------------------------+--------------------------------------------------------+
1047
1048Bug Fixes
1049---------
1050 - None
1051
lukegleesonc9ec9152022-09-07 14:21:36 +01001052Security Notes
1053--------------
1054
1055*Fixed Security Issues*
1056
1057 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
1058
lukegleeson4a34fa52022-09-19 15:31:59 +01001059Version: 3.1.0
1060==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001061
1062Release Data
1063------------
1064
DylanB95ESTb130fd32022-04-04 13:09:22 +01001065+--------------------------------------+--------------------------------------------------------+
1066| **CPS Project** | |
1067| | |
1068+--------------------------------------+--------------------------------------------------------+
1069| **Docker images** | onap/cps-and-ncmp:3.1.0 |
1070| | |
1071+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001072| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +01001073| | |
1074+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +01001075| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +01001076| | |
1077+--------------------------------------+--------------------------------------------------------+
1078
1079Features
1080--------
lukegleeson4a34fa52022-09-19 15:31:59 +01001081 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
1082 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
1083 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
1084 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
1085 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
1086 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
1087 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
1088 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
1089 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
1090 - `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'
1091 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
1092 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
1093 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
1094 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
1095 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
1096 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
1097 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
1098 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
1099 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
1100 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
1101 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
1102 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
1103 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
1104 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
1105
emacleeafb17362022-09-02 14:40:17 +01001106
1107Bug Fixes
1108---------
lukegleeson4a34fa52022-09-19 15:31:59 +01001109 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
1110 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
1111 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
1112 - `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 +01001113 - `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 +01001114 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
1115 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
1116 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
1117 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
1118 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
1119 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
1120 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
1121 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
1122 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +01001123
1124Known Limitations, Issues and Workarounds
1125-----------------------------------------
1126
1127*System Limitations*
1128
1129Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
1130Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +01001131
lukegleeson4a34fa52022-09-19 15:31:59 +01001132*Known Vulnerabilities*
1133
1134None
1135
1136*Workarounds*
1137
1138None
1139
1140Security Notes
1141--------------
1142
1143*Fixed Security Issues*
1144
1145 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
1146
1147*Known Security Issues*
1148
1149None
1150
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001151.. ========================
1152.. * * * JAKARTA * * *
1153.. ========================
1154
1155Version: 3.0.1
1156==============
1157
1158Release Data
1159------------
1160
1161+--------------------------------------+--------------------------------------------------------+
1162| **CPS Project** | |
1163| | |
1164+--------------------------------------+--------------------------------------------------------+
1165| **Docker images** | onap/cps-and-ncmp:3.0.1 |
1166| | |
1167+--------------------------------------+--------------------------------------------------------+
1168| **Release designation** | 3.0.1 Jakarta |
1169| | |
1170+--------------------------------------+--------------------------------------------------------+
1171| **Release date** | 2022 April 28 |
1172| | |
1173+--------------------------------------+--------------------------------------------------------+
1174
1175Bug Fixes
1176---------
1177 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
1178
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001179Version: 3.0.0
1180==============
niamhcoref7b414e2021-11-17 11:02:07 +00001181
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001182Release Data
1183------------
1184
1185+--------------------------------------+--------------------------------------------------------+
1186| **CPS Project** | |
1187| | |
1188+--------------------------------------+--------------------------------------------------------+
1189| **Docker images** | onap/cps-and-ncmp:3.0.0 |
1190| | |
1191+--------------------------------------+--------------------------------------------------------+
1192| **Release designation** | 3.0.0 Jakarta |
1193| | |
1194+--------------------------------------+--------------------------------------------------------+
1195| **Release date** | 2022 March 15 |
1196| | |
1197+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +00001198
1199Features
1200--------
puthuparambil.adityad0007332021-12-08 18:53:39 +00001201 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +00001202 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
1203 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +00001204 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +00001205 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +00001206 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +00001207 - `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 -04001208 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
1209 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +00001210 - `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 +05301211 - `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 +00001212
1213Bug Fixes
1214---------
1215
1216 - `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 +00001217 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +00001218 - `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 +00001219 - `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 +00001220 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +00001221 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +00001222 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +00001223 - `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 +05301224 - `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 +01001225 - `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 +00001226
1227Known Limitations, Issues and Workarounds
1228-----------------------------------------
1229
1230*System Limitations*
1231
DylanB95ESTe5573382022-01-27 17:12:52 +00001232Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
1233`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
1234of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +00001235
Lathishb3550f12022-03-15 12:03:53 +00001236The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
1237for more information.
1238
niamhcoref7b414e2021-11-17 11:02:07 +00001239*Known Vulnerabilities*
1240
1241None
1242
1243*Workarounds*
1244
DylanB95ESTe5573382022-01-27 17:12:52 +00001245Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
1246pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +00001247
1248Security Notes
1249--------------
1250
1251*Fixed Security Issues*
1252
1253None
1254
1255*Known Security Issues*
1256
1257None
1258
1259.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +01001260.. * * * ISTANBUL * * *
1261.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001262
Bruno Sakoto0eaf3342022-02-11 15:05:29 -05001263Version: 2.0.4
1264==============
1265
1266Release Data
1267------------
1268
1269+--------------------------------------+--------------------------------------------------------+
1270| **CPS Project** | |
1271| | |
1272+--------------------------------------+--------------------------------------------------------+
1273| **Docker images** | onap/cps-and-ncmp:2.0.4 |
1274| | |
1275+--------------------------------------+--------------------------------------------------------+
1276| **Release designation** | 2.0.4 Istanbul |
1277| | |
1278+--------------------------------------+--------------------------------------------------------+
1279| **Release date** | 2022 Feb 09 |
1280| | |
1281+--------------------------------------+--------------------------------------------------------+
1282
1283Bug Fixes
1284---------
1285
1286 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
1287 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
1288
1289Version: 2.0.3
1290==============
1291
1292Release Data
1293------------
1294
1295+--------------------------------------+--------------------------------------------------------+
1296| **CPS Project** | |
1297| | |
1298+--------------------------------------+--------------------------------------------------------+
1299| **Docker images** | onap/cps-and-ncmp:2.0.3 |
1300| | |
1301+--------------------------------------+--------------------------------------------------------+
1302| **Release designation** | 2.0.3 Istanbul |
1303| | |
1304+--------------------------------------+--------------------------------------------------------+
1305| **Release date** | 2022-07-01 |
1306| | |
1307+--------------------------------------+--------------------------------------------------------+
1308
1309Bug Fixes
1310---------
1311
1312 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
1313
1314Version: 2.0.2
1315==============
1316
1317Release Data
1318------------
1319
1320+--------------------------------------+--------------------------------------------------------+
1321| **CPS Project** | |
1322| | |
1323+--------------------------------------+--------------------------------------------------------+
1324| **Docker images** | onap/cps-and-ncmp:2.0.2 |
1325| | |
1326+--------------------------------------+--------------------------------------------------------+
1327| **Release designation** | 2.0.2 Istanbul |
1328| | |
1329+--------------------------------------+--------------------------------------------------------+
1330| **Release date** | 2021-16-12 |
1331| | |
1332+--------------------------------------+--------------------------------------------------------+
1333
1334Bug Fixes
1335---------
1336
1337 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
1338
lukegleeson9c583712021-09-30 17:21:11 +01001339Version: 2.0.1
1340==============
1341
1342Release Data
1343------------
1344
1345+--------------------------------------+--------------------------------------------------------+
1346| **CPS Project** | |
1347| | |
1348+--------------------------------------+--------------------------------------------------------+
1349| **Docker images** | onap/cps-and-ncmp:2.0.1 |
1350| | |
1351+--------------------------------------+--------------------------------------------------------+
1352| **Release designation** | 2.0.1 Istanbul |
1353| | |
1354+--------------------------------------+--------------------------------------------------------+
1355| **Release date** | 2021-14-10 |
1356| | |
1357+--------------------------------------+--------------------------------------------------------+
1358
1359Bug Fixes
1360---------
1361
1362 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1363 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1364 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1365 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1366
1367Known Limitations, Issues and Workarounds
1368-----------------------------------------
1369
1370*System Limitations*
1371
1372Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1373
1374*Known Vulnerabilities*
1375
1376 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1377
1378*Workarounds*
1379
1380Add recursive method to save list node data to loop through all corresponding child nodes.
1381
1382Security Notes
1383--------------
1384
1385*Fixed Security Issues*
1386
1387 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1388
1389*Known Security Issues*
1390
1391None
1392
shivasubedi44beaa32021-09-13 15:16:30 +01001393Version: 2.0.0
1394==============
1395
1396Abstract
1397--------
1398
1399This document provides the release notes for Istanbul release.
1400
1401Release Data
1402------------
1403
1404+--------------------------------------+--------------------------------------------------------+
1405| **CPS Project** | |
1406| | |
1407+--------------------------------------+--------------------------------------------------------+
1408| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1409| | |
1410+--------------------------------------+--------------------------------------------------------+
1411| **Release designation** | 2.0.0 Istanbul |
1412| | |
1413+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +01001414| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +01001415| | |
1416+--------------------------------------+--------------------------------------------------------+
1417
1418Features
1419--------
DylanB95EST3fcf8692021-10-11 16:29:16 +01001420* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +01001421* Update, Create and Remove CM Handles.
1422* Add support for retrieving and writing CM Handle data through NCMP datastores.
1423* Automatic retrieval and caching of model information for CM Handles within NCMP.
1424
shivasubedi44beaa32021-09-13 15:16:30 +01001425Deliverables
1426------------
1427
1428Software Deliverables
1429
1430.. csv-table::
1431 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1432 :widths: auto
1433
1434 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1435
1436Bug Fixes
1437---------
1438
lukegleeson9c583712021-09-30 17:21:11 +01001439 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001440 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1441 - `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 +01001442 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1443 - `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 +01001444 - `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 +01001445 - `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 +01001446 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1447 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001448 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1449 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1450 - `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 +01001451 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1452 - `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 +01001453 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001454 - `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 +01001455 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1456 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1457 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001458 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1459 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1460 - `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 -05001461 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001462 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1463 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1464 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001465
1466This document provides the release notes for Istanbul release.
1467
1468Summary
1469-------
1470
1471Following CPS components are available with default ONAP/CPS installation.
1472
1473
1474 * Platform components
1475
1476 - CPS (Helm charts)
1477
1478 * Service components
1479
DylanB95EST3fcf8692021-10-11 16:29:16 +01001480 - CPS-NCMP
DylanB95EST3fcf8692021-10-11 16:29:16 +01001481 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001482
1483 * Additional resources that CPS utilizes deployed using ONAP common charts
1484
1485 - Postgres Database
1486
1487
1488Below service components (mS) are available to be deployed on-demand.
1489 - CPS-TBDMT
1490
1491
1492Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1493
1494Known Limitations, Issues and Workarounds
1495-----------------------------------------
1496
shivasubedi44beaa32021-09-13 15:16:30 +01001497*System Limitations*
1498
1499Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1500
1501*Known Vulnerabilities*
1502
lukegleeson9c583712021-09-30 17:21:11 +01001503 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1504 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1505 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001506
1507*Workarounds*
1508
1509Add recursive method to save list node data to loop through all corresponding child nodes.
1510
1511Security Notes
1512--------------
1513
1514*Fixed Security Issues*
1515
1516 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001517
1518*Known Security Issues*
1519
lukegleeson9c583712021-09-30 17:21:11 +01001520 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1521
shivasubedi44beaa32021-09-13 15:16:30 +01001522Test Results
1523------------
1524 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001525
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001526.. ========================
1527.. * * * HONOLULU * * *
1528.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001529
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001530Version: 1.0.1
1531==============
1532
1533Release Data
1534------------
1535
1536+--------------------------------------+--------------------------------------------------------+
1537| **CPS Project** | |
1538| | |
1539+--------------------------------------+--------------------------------------------------------+
1540| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1541| | |
1542+--------------------------------------+--------------------------------------------------------+
1543| **Release designation** | 1.0.1 Honolulu |
1544| | |
1545+--------------------------------------+--------------------------------------------------------+
1546| **Release date** | 2021-04-09 |
1547| | |
1548+--------------------------------------+--------------------------------------------------------+
1549
1550Bug Fixes
1551---------
1552
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001553 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001554 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1555 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1556 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1557 - `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
1558 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1559 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1560 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1561
1562Security Notes
1563--------------
1564
1565*Fixed Security Issues*
1566
1567 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001568
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001569*Known Security Issues*
1570
1571 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1572
Rishi.Chail4359d282021-03-03 16:36:26 +00001573Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001574==============
1575
1576
1577Abstract
1578--------
1579
1580This document provides the release notes for Honolulu release.
1581
1582Summary
1583-------
1584
1585Following CPS components are available with default ONAP/CPS installation.
1586
1587
Rishi.Chail4359d282021-03-03 16:36:26 +00001588 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001589
Rishi.Chail4359d282021-03-03 16:36:26 +00001590 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001591
Rishi.Chail4359d282021-03-03 16:36:26 +00001592 * Service components
1593
1594 - CPS Core
1595
1596 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001597
1598 - Postgres Database
1599
1600
Rishi.Chail4359d282021-03-03 16:36:26 +00001601Below service components (mS) are available to be deployed on-demand.
1602 - CPS-TBDMT
1603
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001604
1605Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1606
1607
1608Release Data
1609------------
1610
1611+--------------------------------------+--------------------------------------------------------+
1612| **CPS Project** | |
1613| | |
1614+--------------------------------------+--------------------------------------------------------+
1615| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1616| | |
1617+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001618| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001619| | |
1620+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001621| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001622| | |
1623+--------------------------------------+--------------------------------------------------------+
1624
1625
1626Features
1627--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001628Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1629CPS has been driven by the needs of the E2E Networking Slicing use case.
1630It currently supports basic (rw) persistence and simple queries.
1631It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001632
1633.. _honolulu_deliverable:
1634
1635Deliverables
1636------------
1637
1638Software Deliverables
1639
1640.. csv-table::
1641 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1642 :widths: auto
1643
Rishi.Chail4359d282021-03-03 16:36:26 +00001644 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001645
1646
1647Known Limitations, Issues and Workarounds
1648-----------------------------------------
1649
Rishi.Chail4359d282021-03-03 16:36:26 +00001650 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1651 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1652 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001653 - `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 +00001654
1655*System Limitations*
1656
1657None
1658
1659*Known Vulnerabilities*
1660
1661None
1662
1663*Workarounds*
1664
1665Documented under corresponding jira if applicable.
1666
1667Security Notes
1668--------------
1669
1670*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001671
1672* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001673 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001674 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001675 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001676
1677*Known Security Issues*
1678
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001679 * Weak Cryptography using md5
Rishi.Chail4359d282021-03-03 16:36:26 +00001680 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001681
1682*Known Vulnerabilities in Used Modules*
1683
Rishi.Chail4359d282021-03-03 16:36:26 +00001684 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001685
Rishi.Chail4359d282021-03-03 16:36:26 +00001686CPS 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 +00001687
1688Test Results
1689------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001690 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001691
1692References
1693----------
1694
ToineSiebelinkcac21862023-06-22 09:24:04 +01001695For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001696
1697#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001698#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001699#. `ONAP Documentation`_
1700#. `ONAP CPS Documentation`_
1701#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001702
1703
1704.. _`ONAP Home Page`: https://www.onap.org
1705.. _`ONAP Wiki Page`: https://wiki.onap.org
1706.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001707.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001708.. _`ONAP Release Downloads`: https://git.onap.org
1709
1710Quick Links:
1711
1712 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1713 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_