blob: 28ab072e1239d433edfa3b5eb662bb7112c41dcd [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
mpriyanka1703ea2024-02-29 17:47:47 +000019Version: 3.4.7
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.4.7 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.4.7 New Delhi |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.4.7
mpriyank6b0e6b32024-03-08 12:50:53 +000042 - `CPS-2150 <https://jira.onap.org/browse/CPS-2150>`_ Fix for Async task execution failed by TimeoutException.
mpriyanka1703ea2024-02-29 17:47:47 +000043
44Features
45--------
david.mcweeney23378b52024-02-21 09:51:29 +0000463.4.7
47 - `CPS-2061 <https://jira.onap.org/browse/CPS-2061>`_ Liquibase Steps Condensing and Cleanup.
mpriyankb4f8b792024-03-29 10:57:05 +000048 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot to 3.2.4 version.
mpriyanka1703ea2024-02-29 17:47:47 +000049
mpriyank22e1f432024-02-27 14:04:38 +000050Version: 3.4.6
51==============
52
53Release Data
54------------
55
56+--------------------------------------+--------------------------------------------------------+
57| **CPS Project** | |
58| | |
59+--------------------------------------+--------------------------------------------------------+
60| **Docker images** | onap/cps-and-ncmp:3.4.6 |
61| | |
62+--------------------------------------+--------------------------------------------------------+
63| **Release designation** | 3.4.6 New Delhi |
64| | |
65+--------------------------------------+--------------------------------------------------------+
mpriyanka1703ea2024-02-29 17:47:47 +000066| **Release date** | 2024 February 29 |
mpriyank22e1f432024-02-27 14:04:38 +000067| | |
68+--------------------------------------+--------------------------------------------------------+
69
70Bug Fixes
71---------
723.4.6
mpriyank4a978d32024-02-29 14:39:00 +000073 - `CPS-2126 <https://jira.onap.org/browse/CPS-2126>`_ Passing HTTP Authorization Bearer Token to DMI Plugins.
mpriyank22e1f432024-02-27 14:04:38 +000074
75
76Features
77--------
mpriyank4a978d32024-02-29 14:39:00 +000078 - `CPS-2133 <https://jira.onap.org/browse/CPS-2133>`_ Revert Uplift of Spring Boot version from 3.2.2 to 3.1.2
79
80Notes
81-----
82This release brings improvements to compatibility with Service Mesh and for that below measures are been taken.
83
84Basic 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).
85NCMP will propagate a bearer token to DMI conditionally.
86401 Unauthorized will not be returned. Best effort has been made to ensure backwards compatibility.
mpriyank22e1f432024-02-27 14:04:38 +000087
danielhanrahanb8e677f2024-02-23 15:27:17 +000088Version: 3.4.5
89==============
90
91Release Data
92------------
93
94+--------------------------------------+--------------------------------------------------------+
95| **CPS Project** | |
96| | |
97+--------------------------------------+--------------------------------------------------------+
98| **Docker images** | onap/cps-and-ncmp:3.4.5 |
99| | |
100+--------------------------------------+--------------------------------------------------------+
101| **Release designation** | 3.4.5 New Delhi |
102| | |
103+--------------------------------------+--------------------------------------------------------+
mpriyank22e1f432024-02-27 14:04:38 +0000104| **Release date** | 2024 February 27 |
danielhanrahanb8e677f2024-02-23 15:27:17 +0000105| | |
106+--------------------------------------+--------------------------------------------------------+
107
108Bug Fixes
109---------
1103.4.5
111
112
113Features
114--------
mpriyankcfac7192024-02-27 12:21:53 +0000115 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot version to 3.2.2
danielhanrahanb8e677f2024-02-23 15:27:17 +0000116
117
danielhanrahan97bad452024-02-07 16:07:27 +0000118Version: 3.4.4
119==============
120
121Release Data
122------------
123
124+--------------------------------------+--------------------------------------------------------+
125| **CPS Project** | |
126| | |
127+--------------------------------------+--------------------------------------------------------+
128| **Docker images** | onap/cps-and-ncmp:3.4.4 |
129| | |
130+--------------------------------------+--------------------------------------------------------+
131| **Release designation** | 3.4.4 New Delhi |
132| | |
133+--------------------------------------+--------------------------------------------------------+
danielhanrahanb8e677f2024-02-23 15:27:17 +0000134| **Release date** | 2024 February 23 |
danielhanrahan97bad452024-02-07 16:07:27 +0000135| | |
136+--------------------------------------+--------------------------------------------------------+
137
138Bug Fixes
139---------
1403.4.4
danielhanrahan8c37c032024-02-23 13:27:37 +0000141 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Upgrade Yang modules using module set tag functionalities fix
danielhanrahan97bad452024-02-07 16:07:27 +0000142
143Features
144--------
danielhanrahan8c37c032024-02-23 13:27:37 +0000145 - `CPS-2057 <https://jira.onap.org/browse/CPS-2057>`_ Leaf lists are sorted by default if Yang model does not specify order.
146 - `CPS-2087 <https://jira.onap.org/browse/CPS-2087>`_ Performance improvement of CPS Path Queries.
danielhanrahan97bad452024-02-07 16:07:27 +0000147
148
danielhanrahan345f40f2024-01-11 15:25:18 +0000149Version: 3.4.3
150==============
151
152Release Data
153------------
154
155+--------------------------------------+--------------------------------------------------------+
156| **CPS Project** | |
157| | |
158+--------------------------------------+--------------------------------------------------------+
159| **Docker images** | onap/cps-and-ncmp:3.4.3 |
160| | |
161+--------------------------------------+--------------------------------------------------------+
162| **Release designation** | 3.4.3 New Delhi |
163| | |
164+--------------------------------------+--------------------------------------------------------+
danielhanrahan97bad452024-02-07 16:07:27 +0000165| **Release date** | 2024 February 07 |
danielhanrahan345f40f2024-01-11 15:25:18 +0000166| | |
167+--------------------------------------+--------------------------------------------------------+
168
169Bug Fixes
170---------
1713.4.3
danielhanrahan7ce495b2024-02-07 14:21:58 +0000172 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed.
173 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag.
174 - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer.
danielhanrahan345f40f2024-01-11 15:25:18 +0000175
176Features
177--------
Arpit Singh1322b0f2024-01-19 13:46:03 +0530178 - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors.
danielhanrahan81f61b52024-02-02 12:25:47 +0000179 - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR.
halil.cakalc1b09262024-02-08 12:15:48 +0000180 - `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 +0000181
182Notes
183-----
184The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a
185*-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename
186of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*.
danielhanrahan345f40f2024-01-11 15:25:18 +0000187
danielhanrahan9437af62023-12-20 15:12:47 +0000188Version: 3.4.2
189==============
190
191Release Data
192------------
193
194+--------------------------------------+--------------------------------------------------------+
195| **CPS Project** | |
196| | |
197+--------------------------------------+--------------------------------------------------------+
198| **Docker images** | onap/cps-and-ncmp:3.4.2 |
199| | |
200+--------------------------------------+--------------------------------------------------------+
201| **Release designation** | 3.4.2 New Delhi |
202| | |
203+--------------------------------------+--------------------------------------------------------+
danielhanrahan345f40f2024-01-11 15:25:18 +0000204| **Release date** | 2024 January 11 |
danielhanrahan9437af62023-12-20 15:12:47 +0000205| | |
206+--------------------------------------+--------------------------------------------------------+
207
208Bug Fixes
209---------
2103.4.2
211
212
213Features
214--------
halil.cakal37c6d4d2024-01-11 11:10:17 +0000215 - `CPS-1638 <https://jira.onap.org/browse/CPS-1638>`_ Introduce trust level for CM handle.
danielhanrahan36b81b22023-08-17 14:58:30 +0100216 - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
danielhanrahan9e871802023-08-17 14:58:30 +0100217 - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
danielhanrahan926d4082023-08-04 11:22:43 +0100218 - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
219
220Notes
221-----
222 - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
danielhanrahan9437af62023-12-20 15:12:47 +0000223
danielhanrahan36b81b22023-08-17 14:58:30 +0100224Known Limitations, Issues and Workarounds
225-----------------------------------------
226
227*System Limitations*
228
229For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
230(`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
231As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
232NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
233Other operations (read, update, delete) are not impacted.
234
danielhanrahan9437af62023-12-20 15:12:47 +0000235
mpriyank1d9dae02023-11-09 14:11:26 +0000236Version: 3.4.1
237==============
238
239Release Data
240------------
241
242+--------------------------------------+--------------------------------------------------------+
243| **CPS Project** | |
244| | |
245+--------------------------------------+--------------------------------------------------------+
246| **Docker images** | onap/cps-and-ncmp:3.4.1 |
247| | |
248+--------------------------------------+--------------------------------------------------------+
249| **Release designation** | 3.4.1 New Delhi |
250| | |
251+--------------------------------------+--------------------------------------------------------+
danielhanrahan9437af62023-12-20 15:12:47 +0000252| **Release date** | 2023 December 20 |
mpriyank1d9dae02023-11-09 14:11:26 +0000253| | |
254+--------------------------------------+--------------------------------------------------------+
255
256Bug Fixes
257---------
danielhanrahan3e14d392023-12-20 13:31:07 +00002583.4.1
mpriyank41727e52023-12-04 18:01:07 +0000259 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
mpriyank1d9dae02023-11-09 14:11:26 +0000260
ToineSiebelink8ee94852023-11-27 14:52:19 +0000261Features
262--------
263 - CPS-Temporal is no longer supported and any related documentation has been removed.
danielhanrahan3e14d392023-12-20 13:31:07 +0000264 - `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 +0000265 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
waqas.ikram60bbcb92023-12-20 10:40:29 +0000266 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
mpriyankdb6b8f82023-12-14 13:27:01 +0000267 - `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 +0000268
danielhanrahan3e14d392023-12-20 13:31:07 +0000269Known Issues
270------------
271 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
272
ToineSiebelink8ee94852023-11-27 14:52:19 +0000273
mpriyank89e0fe22023-11-09 12:12:38 +0000274Version: 3.4.0
275==============
mpriyank2c4535d2023-11-06 17:06:15 +0000276
277Release Data
278------------
279
280+--------------------------------------+--------------------------------------------------------+
281| **CPS Project** | |
282| | |
283+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000284| **Docker images** | onap/cps-and-ncmp:3.4.0 |
mpriyank2c4535d2023-11-06 17:06:15 +0000285| | |
286+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000287| **Release designation** | 3.4.0 New Delhi |
mpriyank2c4535d2023-11-06 17:06:15 +0000288| | |
289+--------------------------------------+--------------------------------------------------------+
mpriyank1d9dae02023-11-09 14:11:26 +0000290| **Release date** | 2023 November 09 |
mpriyank2c4535d2023-11-06 17:06:15 +0000291| | |
292+--------------------------------------+--------------------------------------------------------+
293
294Bug Fixes
295---------
mpriyank89e0fe22023-11-09 12:12:38 +00002963.4.0
297 - `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 +0000298
mpriyank89e0fe22023-11-09 12:12:38 +0000299.. ========================
300.. * * * MONTREAL * * *
301.. ========================
mpriyank2c4535d2023-11-06 17:06:15 +0000302
egernugd91a7072023-09-29 12:12:36 +0100303Version: 3.3.9
304==============
305
306Release Data
307------------
308
309+--------------------------------------+--------------------------------------------------------+
310| **CPS Project** | |
311| | |
312+--------------------------------------+--------------------------------------------------------+
313| **Docker images** | onap/cps-and-ncmp:3.3.9 |
314| | |
315+--------------------------------------+--------------------------------------------------------+
316| **Release designation** | 3.3.9 Montreal |
317| | |
318+--------------------------------------+--------------------------------------------------------+
mpriyank2c4535d2023-11-06 17:06:15 +0000319| **Release date** | 2023 November 06 |
egernugd91a7072023-09-29 12:12:36 +0100320| | |
321+--------------------------------------+--------------------------------------------------------+
322
323Bug Fixes
324---------
3253.3.9
mpriyank02b2d2a2023-10-25 12:23:10 +0100326 - `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 +0000327 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
egernugd91a7072023-09-29 12:12:36 +0100328
329Features
330--------
331
danielhanrahan56384d12023-09-20 17:10:40 +0100332Version: 3.3.8
333==============
334
335Release Data
336------------
337
338+--------------------------------------+--------------------------------------------------------+
339| **CPS Project** | |
340| | |
341+--------------------------------------+--------------------------------------------------------+
342| **Docker images** | onap/cps-and-ncmp:3.3.8 |
343| | |
344+--------------------------------------+--------------------------------------------------------+
345| **Release designation** | 3.3.8 Montreal |
346| | |
347+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +0100348| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +0100349| | |
350+--------------------------------------+--------------------------------------------------------+
351
352Bug Fixes
353---------
3543.3.8
355
356Features
357--------
egernugcb9d1502023-09-28 09:57:44 +0100358 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +0100359
leventecsanyid35ad5c2023-08-23 15:55:30 +0200360Version: 3.3.7
361==============
362
363Release Data
364------------
365
366+--------------------------------------+--------------------------------------------------------+
367| **CPS Project** | |
368| | |
369+--------------------------------------+--------------------------------------------------------+
370| **Docker images** | onap/cps-and-ncmp:3.3.7 |
371| | |
372+--------------------------------------+--------------------------------------------------------+
373| **Release designation** | 3.3.7 Montreal |
374| | |
375+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +0100376| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +0200377| | |
378+--------------------------------------+--------------------------------------------------------+
379
380Bug Fixes
381---------
3823.3.7
danielhanrahanefc55772023-09-15 12:02:35 +0100383 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +0200384
385Features
386--------
egernugcb9d1502023-09-28 09:57:44 +0100387 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100388
389Note
390----
391Migrating 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 +0200392
egernugbdac4402023-07-21 13:27:24 +0100393Version: 3.3.6
394==============
395
396Release Data
397------------
398
399+--------------------------------------+--------------------------------------------------------+
400| **CPS Project** | |
401| | |
402+--------------------------------------+--------------------------------------------------------+
403| **Docker images** | onap/cps-and-ncmp:3.3.6 |
404| | |
405+--------------------------------------+--------------------------------------------------------+
406| **Release designation** | 3.3.6 Montreal |
407| | |
408+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200409| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100410| | |
411+--------------------------------------+--------------------------------------------------------+
412
413Bug Fixes
414---------
4153.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100416 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100417 - `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 +0100418
419Features
420--------
danielhanrahan92705462023-05-18 10:18:10 +0100421 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100422 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100423
424
egernug6c9621a2023-07-19 11:05:00 +0100425Version: 3.3.5
426==============
427
428Release Data
429------------
430
431+--------------------------------------+--------------------------------------------------------+
432| **CPS Project** | |
433| | |
434+--------------------------------------+--------------------------------------------------------+
435| **Docker images** | onap/cps-and-ncmp:3.3.5 |
436| | |
437+--------------------------------------+--------------------------------------------------------+
438| **Release designation** | 3.3.5 Montreal |
439| | |
440+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100441| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100442| | |
443+--------------------------------------+--------------------------------------------------------+
444
445Bug Fixes
446---------
4473.3.5
448
449Features
450--------
danielhanrahan74a47152023-06-28 12:55:20 +0100451 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100452
mpriyank8caa3422023-06-30 11:14:10 +0100453Version: 3.3.4
454==============
455
456Release Data
457------------
458
459+--------------------------------------+--------------------------------------------------------+
460| **CPS Project** | |
461| | |
462+--------------------------------------+--------------------------------------------------------+
463| **Docker images** | onap/cps-and-ncmp:3.3.4 |
464| | |
465+--------------------------------------+--------------------------------------------------------+
466| **Release designation** | 3.3.4 Montreal |
467| | |
468+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100469| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100470| | |
471+--------------------------------------+--------------------------------------------------------+
472
473Bug Fixes
474---------
4753.3.4
476
477Features
478--------
egernugdb62ffb2023-07-18 10:57:42 +0100479 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100480
danielhanrahan19f963b2023-06-15 13:52:34 +0100481Version: 3.3.3
482==============
483
484Release Data
485------------
486
487+--------------------------------------+--------------------------------------------------------+
488| **CPS Project** | |
489| | |
490+--------------------------------------+--------------------------------------------------------+
491| **Docker images** | onap/cps-and-ncmp:3.3.3 |
492| | |
493+--------------------------------------+--------------------------------------------------------+
494| **Release designation** | 3.3.3 Montreal |
495| | |
496+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100497| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100498| | |
499+--------------------------------------+--------------------------------------------------------+
500
501Bug Fixes
502---------
5033.3.3
504
505Features
506--------
mpriyank6da95412023-06-29 16:56:11 +0100507 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
508 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
509 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100510
mpriyank436b75b2023-05-03 11:10:08 +0100511Version: 3.3.2
512==============
513
514Release Data
515------------
516
517+--------------------------------------+--------------------------------------------------------+
518| **CPS Project** | |
519| | |
520+--------------------------------------+--------------------------------------------------------+
521| **Docker images** | onap/cps-and-ncmp:3.3.2 |
522| | |
523+--------------------------------------+--------------------------------------------------------+
524| **Release designation** | 3.3.2 Montreal |
525| | |
526+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100527| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100528| | |
529+--------------------------------------+--------------------------------------------------------+
530
531Bug Fixes
532---------
5333.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100534 - `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 +0100535
536Features
537--------
--globalc7e5a802023-04-05 17:08:08 +0530538 - `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 +0100539 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
540 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
541 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
542 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100543
lukegleesond7764c42023-04-20 14:11:20 +0100544Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000545==============
546
547Release Data
548------------
549
550+--------------------------------------+--------------------------------------------------------+
551| **CPS Project** | |
552| | |
553+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100554| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000555| | |
556+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100557| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000558| | |
559+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100560| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000561| | |
562+--------------------------------------+--------------------------------------------------------+
563
564Bug Fixes
565---------
lukegleesond7764c42023-04-20 14:11:20 +01005663.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000567 - None
568
569Features
570--------
mpriyank52c5e542023-05-02 15:58:55 +0100571 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
572 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
573 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
574 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
575 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000576
lukegleesond7764c42023-04-20 14:11:20 +0100577Version: 3.3.0
578==============
579
580Release Data
581------------
582
583+--------------------------------------+--------------------------------------------------------+
584| **CPS Project** | |
585| | |
586+--------------------------------------+--------------------------------------------------------+
587| **Docker images** | onap/cps-and-ncmp:3.3.0 |
588| | |
589+--------------------------------------+--------------------------------------------------------+
590| **Release designation** | 3.3.0 Montreal |
591| | |
592+--------------------------------------+--------------------------------------------------------+
593| **Release date** | 2023 April 20 |
594| | |
595+--------------------------------------+--------------------------------------------------------+
596
597Bug Fixes
598---------
5993.3.0
600 - None
601
602Features
603--------
604 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
605 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
606
607.. ======================
608.. * * * LONDON * * *
609.. ======================
610
mpriyank0fd4d192023-03-10 13:48:20 +0000611Version: 3.2.6
612==============
613
614Release Data
615------------
616
617+--------------------------------------+--------------------------------------------------------+
618| **CPS Project** | |
619| | |
620+--------------------------------------+--------------------------------------------------------+
621| **Docker images** | onap/cps-and-ncmp:3.2.6 |
622| | |
623+--------------------------------------+--------------------------------------------------------+
624| **Release designation** | 3.2.6 London |
625| | |
626+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000627| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000628| | |
629+--------------------------------------+--------------------------------------------------------+
630
631Bug Fixes
632---------
6333.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530634 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000635 - `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 +0000636
637Features
638--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000639 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000640
mpriyankade5a6e2023-03-09 17:58:31 +0000641Version: 3.2.5
642==============
643
644Release Data
645------------
646
647+--------------------------------------+--------------------------------------------------------+
648| **CPS Project** | |
649| | |
650+--------------------------------------+--------------------------------------------------------+
651| **Docker images** | onap/cps-and-ncmp:3.2.5 |
652| | |
653+--------------------------------------+--------------------------------------------------------+
654| **Release designation** | 3.2.5 London |
655| | |
656+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000657| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000658| | |
659+--------------------------------------+--------------------------------------------------------+
660
661Bug Fixes
662---------
6633.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000664 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000665
666Features
667--------
668 - None
669
seanbeirnef0f4fd82023-03-07 13:42:04 +0000670Version: 3.2.4
671==============
672
673Release Data
674------------
675
676+--------------------------------------+--------------------------------------------------------+
677| **CPS Project** | |
678| | |
679+--------------------------------------+--------------------------------------------------------+
680| **Docker images** | onap/cps-and-ncmp:3.2.4 |
681| | |
682+--------------------------------------+--------------------------------------------------------+
683| **Release designation** | 3.2.4 London |
684| | |
685+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000686| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000687| | |
688+--------------------------------------+--------------------------------------------------------+
689
690Bug Fixes
691---------
6923.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000693 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
694 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
695
696Features
697--------
698 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000699
mpriyankfd43dbe2023-02-08 11:21:08 +0000700Version: 3.2.3
701==============
702
703Release Data
704------------
705
706+--------------------------------------+--------------------------------------------------------+
707| **CPS Project** | |
708| | |
709+--------------------------------------+--------------------------------------------------------+
710| **Docker images** | onap/cps-and-ncmp:3.2.3 |
711| | |
712+--------------------------------------+--------------------------------------------------------+
713| **Release designation** | 3.2.3 London |
714| | |
715+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000716| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000717| | |
718+--------------------------------------+--------------------------------------------------------+
719
720Bug Fixes
721---------
7223.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000723 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000724
725Features
726--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000727 - `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
728 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000729
seanbeirnef8e980a2023-01-27 18:09:33 +0000730Version: 3.2.2
731==============
732
733Release Data
734------------
735
736+--------------------------------------+--------------------------------------------------------+
737| **CPS Project** | |
738| | |
739+--------------------------------------+--------------------------------------------------------+
740| **Docker images** | onap/cps-and-ncmp:3.2.2 |
741| | |
742+--------------------------------------+--------------------------------------------------------+
743| **Release designation** | 3.2.2 London |
744| | |
745+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000746| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000747| | |
748+--------------------------------------+--------------------------------------------------------+
749
750Bug Fixes
751---------
mpriyank0b5950d2023-02-07 17:55:10 +00007523.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000753 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000754
755Features
756--------
757 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000758
leventecsanyi37d72852022-10-26 10:44:08 +0200759Version: 3.2.1
760==============
mpriyank4bd450e2022-10-05 09:50:59 +0100761
762Release Data
763------------
764
765+--------------------------------------+--------------------------------------------------------+
766| **CPS Project** | |
767| | |
768+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000769| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100770| | |
771+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200772| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100773| | |
774+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000775| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100776| | |
777+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100778
lukegleeson3be99242022-10-11 14:34:56 +0100779Features
780--------
leventecsanyi37d72852022-10-26 10:44:08 +02007813.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000782 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
783 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
784 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000785 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
786 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000787 - `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 +0000788 - `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 +0000789 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000790 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000791 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000792 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
793 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
794 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100795
796Bug Fixes
797---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00007983.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000799 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
800 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
801 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
802 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
803 - `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 +0100804 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000805 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000806 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000807 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
808 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
809 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
810 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
811 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
812 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000813
leventecsanyi37d72852022-10-26 10:44:08 +02008143.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000815 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100816
lukegleeson3be99242022-10-11 14:34:56 +0100817Known Limitations, Issues and Workarounds
818-----------------------------------------
819
820*System Limitations*
821
seanbeirne72c267e2022-10-18 12:39:22 +0100822For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
823This 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 +0100824
arpitsingh2b4c4882023-03-03 21:38:57 +0530825CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
826a 400 Bad Request is sent as response. This is part of commit CPS-1526.
827
seanbeirnedba2b102022-10-27 09:59:17 +0100828.. ====================
829.. * * * KOHN * * *
830.. ====================
831
mpriyankfe775312022-09-30 14:16:51 +0100832Version: 3.1.4
833==============
834
835Release Data
836------------
837
838+--------------------------------------+--------------------------------------------------------+
839| **CPS Project** | |
840| | |
841+--------------------------------------+--------------------------------------------------------+
842| **Docker images** | onap/cps-and-ncmp:3.1.4 |
843| | |
844+--------------------------------------+--------------------------------------------------------+
845| **Release designation** | 3.1.4 Kohn |
846| | |
847+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100848| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100849| | |
850+--------------------------------------+--------------------------------------------------------+
851
852Bug Fixes
853---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100854 - `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 +0100855 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100856
mpriyank06736cb2022-09-29 14:29:40 +0100857Version: 3.1.3
858==============
859
860Release Data
861------------
862
863+--------------------------------------+--------------------------------------------------------+
864| **CPS Project** | |
865| | |
866+--------------------------------------+--------------------------------------------------------+
867| **Docker images** | onap/cps-and-ncmp:3.1.3 |
868| | |
869+--------------------------------------+--------------------------------------------------------+
870| **Release designation** | 3.1.3 Kohn |
871| | |
872+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100873| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100874| | |
875+--------------------------------------+--------------------------------------------------------+
876
877Bug Fixes
878---------
879 - None
880
mpriyankef0ddfc2022-09-28 12:19:34 +0100881Version: 3.1.2
882==============
883
884Release Data
885------------
886
887+--------------------------------------+--------------------------------------------------------+
888| **CPS Project** | |
889| | |
890+--------------------------------------+--------------------------------------------------------+
891| **Docker images** | onap/cps-and-ncmp:3.1.2 |
892| | |
893+--------------------------------------+--------------------------------------------------------+
894| **Release designation** | 3.1.2 Kohn |
895| | |
896+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100897| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100898| | |
899+--------------------------------------+--------------------------------------------------------+
900
901Bug Fixes
902---------
903 - None
904
mpriyanka3f43502022-09-26 14:57:01 +0100905Version: 3.1.1
906==============
907
908Release Data
909------------
910
911+--------------------------------------+--------------------------------------------------------+
912| **CPS Project** | |
913| | |
914+--------------------------------------+--------------------------------------------------------+
915| **Docker images** | onap/cps-and-ncmp:3.1.1 |
916| | |
917+--------------------------------------+--------------------------------------------------------+
918| **Release designation** | 3.1.1 Kohn |
919| | |
920+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100921| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100922| | |
923+--------------------------------------+--------------------------------------------------------+
924
925Bug Fixes
926---------
927 - None
928
lukegleesonc9ec9152022-09-07 14:21:36 +0100929Security Notes
930--------------
931
932*Fixed Security Issues*
933
934 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
935
lukegleeson4a34fa52022-09-19 15:31:59 +0100936Version: 3.1.0
937==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400938
939Release Data
940------------
941
DylanB95ESTb130fd32022-04-04 13:09:22 +0100942+--------------------------------------+--------------------------------------------------------+
943| **CPS Project** | |
944| | |
945+--------------------------------------+--------------------------------------------------------+
946| **Docker images** | onap/cps-and-ncmp:3.1.0 |
947| | |
948+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400949| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100950| | |
951+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100952| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100953| | |
954+--------------------------------------+--------------------------------------------------------+
955
956Features
957--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100958 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
959 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
960 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
961 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
962 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
963 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
964 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
965 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
966 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
967 - `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'
968 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
969 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
970 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
971 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
972 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
973 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
974 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
975 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
976 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
977 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
978 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
979 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
980 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
981 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
982
emacleeafb17362022-09-02 14:40:17 +0100983
984Bug Fixes
985---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100986 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
987 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
988 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
989 - `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 +0100990 - `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 +0100991 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
992 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
993 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
994 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
995 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
996 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
997 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
998 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
999 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +01001000
1001Known Limitations, Issues and Workarounds
1002-----------------------------------------
1003
1004*System Limitations*
1005
1006Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
1007Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +01001008
lukegleeson4a34fa52022-09-19 15:31:59 +01001009*Known Vulnerabilities*
1010
1011None
1012
1013*Workarounds*
1014
1015None
1016
1017Security Notes
1018--------------
1019
1020*Fixed Security Issues*
1021
1022 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
1023
1024*Known Security Issues*
1025
1026None
1027
Bruno Sakoto9c3541e2022-06-15 07:57:42 -04001028.. ========================
1029.. * * * JAKARTA * * *
1030.. ========================
1031
1032Version: 3.0.1
1033==============
1034
1035Release Data
1036------------
1037
1038+--------------------------------------+--------------------------------------------------------+
1039| **CPS Project** | |
1040| | |
1041+--------------------------------------+--------------------------------------------------------+
1042| **Docker images** | onap/cps-and-ncmp:3.0.1 |
1043| | |
1044+--------------------------------------+--------------------------------------------------------+
1045| **Release designation** | 3.0.1 Jakarta |
1046| | |
1047+--------------------------------------+--------------------------------------------------------+
1048| **Release date** | 2022 April 28 |
1049| | |
1050+--------------------------------------+--------------------------------------------------------+
1051
1052Bug Fixes
1053---------
1054 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
1055
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001056Version: 3.0.0
1057==============
niamhcoref7b414e2021-11-17 11:02:07 +00001058
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001059Release Data
1060------------
1061
1062+--------------------------------------+--------------------------------------------------------+
1063| **CPS Project** | |
1064| | |
1065+--------------------------------------+--------------------------------------------------------+
1066| **Docker images** | onap/cps-and-ncmp:3.0.0 |
1067| | |
1068+--------------------------------------+--------------------------------------------------------+
1069| **Release designation** | 3.0.0 Jakarta |
1070| | |
1071+--------------------------------------+--------------------------------------------------------+
1072| **Release date** | 2022 March 15 |
1073| | |
1074+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +00001075
1076Features
1077--------
puthuparambil.adityad0007332021-12-08 18:53:39 +00001078 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +00001079 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
1080 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +00001081 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +00001082 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +00001083 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +00001084 - `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 -04001085 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
1086 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +00001087 - `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 +05301088 - `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 +00001089
1090Bug Fixes
1091---------
1092
1093 - `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 +00001094 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +00001095 - `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 +00001096 - `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 +00001097 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +00001098 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +00001099 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +00001100 - `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 +05301101 - `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 +01001102 - `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 +00001103
1104Known Limitations, Issues and Workarounds
1105-----------------------------------------
1106
1107*System Limitations*
1108
DylanB95ESTe5573382022-01-27 17:12:52 +00001109Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
1110`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
1111of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +00001112
Lathishb3550f12022-03-15 12:03:53 +00001113The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
1114for more information.
1115
niamhcoref7b414e2021-11-17 11:02:07 +00001116*Known Vulnerabilities*
1117
1118None
1119
1120*Workarounds*
1121
DylanB95ESTe5573382022-01-27 17:12:52 +00001122Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
1123pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +00001124
1125Security Notes
1126--------------
1127
1128*Fixed Security Issues*
1129
1130None
1131
1132*Known Security Issues*
1133
1134None
1135
1136.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +01001137.. * * * ISTANBUL * * *
1138.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001139
Bruno Sakoto0eaf3342022-02-11 15:05:29 -05001140Version: 2.0.4
1141==============
1142
1143Release Data
1144------------
1145
1146+--------------------------------------+--------------------------------------------------------+
1147| **CPS Project** | |
1148| | |
1149+--------------------------------------+--------------------------------------------------------+
1150| **Docker images** | onap/cps-and-ncmp:2.0.4 |
1151| | |
1152+--------------------------------------+--------------------------------------------------------+
1153| **Release designation** | 2.0.4 Istanbul |
1154| | |
1155+--------------------------------------+--------------------------------------------------------+
1156| **Release date** | 2022 Feb 09 |
1157| | |
1158+--------------------------------------+--------------------------------------------------------+
1159
1160Bug Fixes
1161---------
1162
1163 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
1164 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
1165
1166Version: 2.0.3
1167==============
1168
1169Release Data
1170------------
1171
1172+--------------------------------------+--------------------------------------------------------+
1173| **CPS Project** | |
1174| | |
1175+--------------------------------------+--------------------------------------------------------+
1176| **Docker images** | onap/cps-and-ncmp:2.0.3 |
1177| | |
1178+--------------------------------------+--------------------------------------------------------+
1179| **Release designation** | 2.0.3 Istanbul |
1180| | |
1181+--------------------------------------+--------------------------------------------------------+
1182| **Release date** | 2022-07-01 |
1183| | |
1184+--------------------------------------+--------------------------------------------------------+
1185
1186Bug Fixes
1187---------
1188
1189 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
1190
1191Version: 2.0.2
1192==============
1193
1194Release Data
1195------------
1196
1197+--------------------------------------+--------------------------------------------------------+
1198| **CPS Project** | |
1199| | |
1200+--------------------------------------+--------------------------------------------------------+
1201| **Docker images** | onap/cps-and-ncmp:2.0.2 |
1202| | |
1203+--------------------------------------+--------------------------------------------------------+
1204| **Release designation** | 2.0.2 Istanbul |
1205| | |
1206+--------------------------------------+--------------------------------------------------------+
1207| **Release date** | 2021-16-12 |
1208| | |
1209+--------------------------------------+--------------------------------------------------------+
1210
1211Bug Fixes
1212---------
1213
1214 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
1215
lukegleeson9c583712021-09-30 17:21:11 +01001216Version: 2.0.1
1217==============
1218
1219Release Data
1220------------
1221
1222+--------------------------------------+--------------------------------------------------------+
1223| **CPS Project** | |
1224| | |
1225+--------------------------------------+--------------------------------------------------------+
1226| **Docker images** | onap/cps-and-ncmp:2.0.1 |
1227| | |
1228+--------------------------------------+--------------------------------------------------------+
1229| **Release designation** | 2.0.1 Istanbul |
1230| | |
1231+--------------------------------------+--------------------------------------------------------+
1232| **Release date** | 2021-14-10 |
1233| | |
1234+--------------------------------------+--------------------------------------------------------+
1235
1236Bug Fixes
1237---------
1238
1239 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1240 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1241 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1242 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1243
1244Known Limitations, Issues and Workarounds
1245-----------------------------------------
1246
1247*System Limitations*
1248
1249Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1250
1251*Known Vulnerabilities*
1252
1253 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1254
1255*Workarounds*
1256
1257Add recursive method to save list node data to loop through all corresponding child nodes.
1258
1259Security Notes
1260--------------
1261
1262*Fixed Security Issues*
1263
1264 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1265
1266*Known Security Issues*
1267
1268None
1269
shivasubedi44beaa32021-09-13 15:16:30 +01001270Version: 2.0.0
1271==============
1272
1273Abstract
1274--------
1275
1276This document provides the release notes for Istanbul release.
1277
1278Release Data
1279------------
1280
1281+--------------------------------------+--------------------------------------------------------+
1282| **CPS Project** | |
1283| | |
1284+--------------------------------------+--------------------------------------------------------+
1285| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1286| | |
1287+--------------------------------------+--------------------------------------------------------+
1288| **Release designation** | 2.0.0 Istanbul |
1289| | |
1290+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +01001291| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +01001292| | |
1293+--------------------------------------+--------------------------------------------------------+
1294
1295Features
1296--------
DylanB95EST3fcf8692021-10-11 16:29:16 +01001297* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +01001298* Update, Create and Remove CM Handles.
1299* Add support for retrieving and writing CM Handle data through NCMP datastores.
1300* Automatic retrieval and caching of model information for CM Handles within NCMP.
1301
shivasubedi44beaa32021-09-13 15:16:30 +01001302Deliverables
1303------------
1304
1305Software Deliverables
1306
1307.. csv-table::
1308 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1309 :widths: auto
1310
1311 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1312
1313Bug Fixes
1314---------
1315
lukegleeson9c583712021-09-30 17:21:11 +01001316 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001317 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1318 - `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 +01001319 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1320 - `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 +01001321 - `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 +01001322 - `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 +01001323 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1324 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001325 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1326 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1327 - `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 +01001328 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1329 - `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 +01001330 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001331 - `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 +01001332 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1333 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1334 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001335 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1336 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1337 - `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 -05001338 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001339 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1340 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1341 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001342
1343This document provides the release notes for Istanbul release.
1344
1345Summary
1346-------
1347
1348Following CPS components are available with default ONAP/CPS installation.
1349
1350
1351 * Platform components
1352
1353 - CPS (Helm charts)
1354
1355 * Service components
1356
DylanB95EST3fcf8692021-10-11 16:29:16 +01001357 - CPS-NCMP
DylanB95EST3fcf8692021-10-11 16:29:16 +01001358 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001359
1360 * Additional resources that CPS utilizes deployed using ONAP common charts
1361
1362 - Postgres Database
1363
1364
1365Below service components (mS) are available to be deployed on-demand.
1366 - CPS-TBDMT
1367
1368
1369Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1370
1371Known Limitations, Issues and Workarounds
1372-----------------------------------------
1373
shivasubedi44beaa32021-09-13 15:16:30 +01001374*System Limitations*
1375
1376Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1377
1378*Known Vulnerabilities*
1379
lukegleeson9c583712021-09-30 17:21:11 +01001380 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1381 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1382 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001383
1384*Workarounds*
1385
1386Add recursive method to save list node data to loop through all corresponding child nodes.
1387
1388Security Notes
1389--------------
1390
1391*Fixed Security Issues*
1392
1393 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001394
1395*Known Security Issues*
1396
lukegleeson9c583712021-09-30 17:21:11 +01001397 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1398
shivasubedi44beaa32021-09-13 15:16:30 +01001399Test Results
1400------------
1401 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001402
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001403.. ========================
1404.. * * * HONOLULU * * *
1405.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001406
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001407Version: 1.0.1
1408==============
1409
1410Release Data
1411------------
1412
1413+--------------------------------------+--------------------------------------------------------+
1414| **CPS Project** | |
1415| | |
1416+--------------------------------------+--------------------------------------------------------+
1417| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1418| | |
1419+--------------------------------------+--------------------------------------------------------+
1420| **Release designation** | 1.0.1 Honolulu |
1421| | |
1422+--------------------------------------+--------------------------------------------------------+
1423| **Release date** | 2021-04-09 |
1424| | |
1425+--------------------------------------+--------------------------------------------------------+
1426
1427Bug Fixes
1428---------
1429
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001430 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001431 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1432 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1433 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1434 - `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
1435 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1436 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1437 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1438
1439Security Notes
1440--------------
1441
1442*Fixed Security Issues*
1443
1444 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001445
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001446*Known Security Issues*
1447
1448 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1449
Rishi.Chail4359d282021-03-03 16:36:26 +00001450Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001451==============
1452
1453
1454Abstract
1455--------
1456
1457This document provides the release notes for Honolulu release.
1458
1459Summary
1460-------
1461
1462Following CPS components are available with default ONAP/CPS installation.
1463
1464
Rishi.Chail4359d282021-03-03 16:36:26 +00001465 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001466
Rishi.Chail4359d282021-03-03 16:36:26 +00001467 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001468
Rishi.Chail4359d282021-03-03 16:36:26 +00001469 * Service components
1470
1471 - CPS Core
1472
1473 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001474
1475 - Postgres Database
1476
1477
Rishi.Chail4359d282021-03-03 16:36:26 +00001478Below service components (mS) are available to be deployed on-demand.
1479 - CPS-TBDMT
1480
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001481
1482Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1483
1484
1485Release Data
1486------------
1487
1488+--------------------------------------+--------------------------------------------------------+
1489| **CPS Project** | |
1490| | |
1491+--------------------------------------+--------------------------------------------------------+
1492| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1493| | |
1494+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001495| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001496| | |
1497+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001498| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001499| | |
1500+--------------------------------------+--------------------------------------------------------+
1501
1502
1503Features
1504--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001505Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1506CPS has been driven by the needs of the E2E Networking Slicing use case.
1507It currently supports basic (rw) persistence and simple queries.
1508It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001509
1510.. _honolulu_deliverable:
1511
1512Deliverables
1513------------
1514
1515Software Deliverables
1516
1517.. csv-table::
1518 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1519 :widths: auto
1520
Rishi.Chail4359d282021-03-03 16:36:26 +00001521 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001522
1523
1524Known Limitations, Issues and Workarounds
1525-----------------------------------------
1526
Rishi.Chail4359d282021-03-03 16:36:26 +00001527 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1528 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1529 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001530 - `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 +00001531
1532*System Limitations*
1533
1534None
1535
1536*Known Vulnerabilities*
1537
1538None
1539
1540*Workarounds*
1541
1542Documented under corresponding jira if applicable.
1543
1544Security Notes
1545--------------
1546
1547*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001548
1549* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001550 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001551 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001552 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001553
1554*Known Security Issues*
1555
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001556 * Weak Cryptography using md5
Rishi.Chail4359d282021-03-03 16:36:26 +00001557 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001558
1559*Known Vulnerabilities in Used Modules*
1560
Rishi.Chail4359d282021-03-03 16:36:26 +00001561 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001562
Rishi.Chail4359d282021-03-03 16:36:26 +00001563CPS 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 +00001564
1565Test Results
1566------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001567 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001568
1569References
1570----------
1571
ToineSiebelinkcac21862023-06-22 09:24:04 +01001572For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001573
1574#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001575#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001576#. `ONAP Documentation`_
1577#. `ONAP CPS Documentation`_
1578#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001579
1580
1581.. _`ONAP Home Page`: https://www.onap.org
1582.. _`ONAP Wiki Page`: https://wiki.onap.org
1583.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001584.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001585.. _`ONAP Release Downloads`: https://git.onap.org
1586
1587Quick Links:
1588
1589 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1590 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_