Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 33d583f85521eda86648a5fd4baeaa403c88c5e3 / . / docs / release-notes.rst
blob: 3bed58125943a7efca7a247fb6e8978dc3893b94 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1.. 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 +0100[diff] [blame]3.. Copyright (C) 2021-2024 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]4
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 +0000[diff] [blame]8CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]9#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]10
11.. contents::
12 :depth: 2
13..
14
mpriyank89e0fe22023-11-09 12:12:38 +0000[diff] [blame]15.. =========================
16.. * * * NEW DELHI * * *
17.. =========================
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]18
mpriyanka1703ea2024-02-29 17:47:47 +0000[diff] [blame]19Version: 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 +0000[diff] [blame]42 - `CPS-2150 <https://jira.onap.org/browse/CPS-2150>`_ Fix for Async task execution failed by TimeoutException.
mpriyanka1703ea2024-02-29 17:47:47 +0000[diff] [blame]43
44Features
45--------
david.mcweeney23378b52024-02-21 09:51:29 +0000[diff] [blame]463.4.7
47 - `CPS-2061 <https://jira.onap.org/browse/CPS-2061>`_ Liquibase Steps Condensing and Cleanup.
mpriyanka1703ea2024-02-29 17:47:47 +0000[diff] [blame]48
mpriyank22e1f432024-02-27 14:04:38 +0000[diff] [blame]49Version: 3.4.6
50==============
51
52Release Data
53------------
54
55+--------------------------------------+--------------------------------------------------------+
56| **CPS Project** | |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Docker images** | onap/cps-and-ncmp:3.4.6 |
60| | |
61+--------------------------------------+--------------------------------------------------------+
62| **Release designation** | 3.4.6 New Delhi |
63| | |
64+--------------------------------------+--------------------------------------------------------+
mpriyanka1703ea2024-02-29 17:47:47 +0000[diff] [blame]65| **Release date** | 2024 February 29 |
mpriyank22e1f432024-02-27 14:04:38 +0000[diff] [blame]66| | |
67+--------------------------------------+--------------------------------------------------------+
68
69Bug Fixes
70---------
713.4.6
mpriyank4a978d32024-02-29 14:39:00 +0000[diff] [blame]72 - `CPS-2126 <https://jira.onap.org/browse/CPS-2126>`_ Passing HTTP Authorization Bearer Token to DMI Plugins.
mpriyank22e1f432024-02-27 14:04:38 +0000[diff] [blame]73
74
75Features
76--------
mpriyank4a978d32024-02-29 14:39:00 +0000[diff] [blame]77 - `CPS-2133 <https://jira.onap.org/browse/CPS-2133>`_ Revert Uplift of Spring Boot version from 3.2.2 to 3.1.2
78
79Notes
80-----
81This release brings improvements to compatibility with Service Mesh and for that below measures are been taken.
82
83Basic 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).
84NCMP will propagate a bearer token to DMI conditionally.
85401 Unauthorized will not be returned. Best effort has been made to ensure backwards compatibility.
mpriyank22e1f432024-02-27 14:04:38 +0000[diff] [blame]86
danielhanrahanb8e677f2024-02-23 15:27:17 +0000[diff] [blame]87Version: 3.4.5
88==============
89
90Release Data
91------------
92
93+--------------------------------------+--------------------------------------------------------+
94| **CPS Project** | |
95| | |
96+--------------------------------------+--------------------------------------------------------+
97| **Docker images** | onap/cps-and-ncmp:3.4.5 |
98| | |
99+--------------------------------------+--------------------------------------------------------+
100| **Release designation** | 3.4.5 New Delhi |
101| | |
102+--------------------------------------+--------------------------------------------------------+
mpriyank22e1f432024-02-27 14:04:38 +0000[diff] [blame]103| **Release date** | 2024 February 27 |
danielhanrahanb8e677f2024-02-23 15:27:17 +0000[diff] [blame]104| | |
105+--------------------------------------+--------------------------------------------------------+
106
107Bug Fixes
108---------
1093.4.5
110
111
112Features
113--------
mpriyankcfac7192024-02-27 12:21:53 +0000[diff] [blame]114 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot version to 3.2.2
danielhanrahanb8e677f2024-02-23 15:27:17 +0000[diff] [blame]115
116
danielhanrahan97bad452024-02-07 16:07:27 +0000[diff] [blame]117Version: 3.4.4
118==============
119
120Release Data
121------------
122
123+--------------------------------------+--------------------------------------------------------+
124| **CPS Project** | |
125| | |
126+--------------------------------------+--------------------------------------------------------+
127| **Docker images** | onap/cps-and-ncmp:3.4.4 |
128| | |
129+--------------------------------------+--------------------------------------------------------+
130| **Release designation** | 3.4.4 New Delhi |
131| | |
132+--------------------------------------+--------------------------------------------------------+
danielhanrahanb8e677f2024-02-23 15:27:17 +0000[diff] [blame]133| **Release date** | 2024 February 23 |
danielhanrahan97bad452024-02-07 16:07:27 +0000[diff] [blame]134| | |
135+--------------------------------------+--------------------------------------------------------+
136
137Bug Fixes
138---------
1393.4.4
danielhanrahan8c37c032024-02-23 13:27:37 +0000[diff] [blame]140 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Upgrade Yang modules using module set tag functionalities fix
danielhanrahan97bad452024-02-07 16:07:27 +0000[diff] [blame]141
142Features
143--------
danielhanrahan8c37c032024-02-23 13:27:37 +0000[diff] [blame]144 - `CPS-2057 <https://jira.onap.org/browse/CPS-2057>`_ Leaf lists are sorted by default if Yang model does not specify order.
145 - `CPS-2087 <https://jira.onap.org/browse/CPS-2087>`_ Performance improvement of CPS Path Queries.
danielhanrahan97bad452024-02-07 16:07:27 +0000[diff] [blame]146
147
danielhanrahan345f40f2024-01-11 15:25:18 +0000[diff] [blame]148Version: 3.4.3
149==============
150
151Release Data
152------------
153
154+--------------------------------------+--------------------------------------------------------+
155| **CPS Project** | |
156| | |
157+--------------------------------------+--------------------------------------------------------+
158| **Docker images** | onap/cps-and-ncmp:3.4.3 |
159| | |
160+--------------------------------------+--------------------------------------------------------+
161| **Release designation** | 3.4.3 New Delhi |
162| | |
163+--------------------------------------+--------------------------------------------------------+
danielhanrahan97bad452024-02-07 16:07:27 +0000[diff] [blame]164| **Release date** | 2024 February 07 |
danielhanrahan345f40f2024-01-11 15:25:18 +0000[diff] [blame]165| | |
166+--------------------------------------+--------------------------------------------------------+
167
168Bug Fixes
169---------
1703.4.3
danielhanrahan7ce495b2024-02-07 14:21:58 +0000[diff] [blame]171 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed.
172 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag.
173 - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer.
danielhanrahan345f40f2024-01-11 15:25:18 +0000[diff] [blame]174
175Features
176--------
Arpit Singh1322b0f2024-01-19 13:46:03 +0530[diff] [blame]177 - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors.
danielhanrahan81f61b52024-02-02 12:25:47 +0000[diff] [blame]178 - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR.
halil.cakalc1b09262024-02-08 12:15:48 +0000[diff] [blame]179 - `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 +0000[diff] [blame]180
181Notes
182-----
183The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a
184*-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename
185of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*.
danielhanrahan345f40f2024-01-11 15:25:18 +0000[diff] [blame]186
danielhanrahan9437af62023-12-20 15:12:47 +0000[diff] [blame]187Version: 3.4.2
188==============
189
190Release Data
191------------
192
193+--------------------------------------+--------------------------------------------------------+
194| **CPS Project** | |
195| | |
196+--------------------------------------+--------------------------------------------------------+
197| **Docker images** | onap/cps-and-ncmp:3.4.2 |
198| | |
199+--------------------------------------+--------------------------------------------------------+
200| **Release designation** | 3.4.2 New Delhi |
201| | |
202+--------------------------------------+--------------------------------------------------------+
danielhanrahan345f40f2024-01-11 15:25:18 +0000[diff] [blame]203| **Release date** | 2024 January 11 |
danielhanrahan9437af62023-12-20 15:12:47 +0000[diff] [blame]204| | |
205+--------------------------------------+--------------------------------------------------------+
206
207Bug Fixes
208---------
2093.4.2
210
211
212Features
213--------
halil.cakal37c6d4d2024-01-11 11:10:17 +0000[diff] [blame]214 - `CPS-1638 <https://jira.onap.org/browse/CPS-1638>`_ Introduce trust level for CM handle.
danielhanrahan36b81b22023-08-17 14:58:30 +0100[diff] [blame]215 - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
danielhanrahan9e871802023-08-17 14:58:30 +0100[diff] [blame]216 - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
danielhanrahan926d4082023-08-04 11:22:43 +0100[diff] [blame]217 - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
218
219Notes
220-----
221 - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
danielhanrahan9437af62023-12-20 15:12:47 +0000[diff] [blame]222
danielhanrahan36b81b22023-08-17 14:58:30 +0100[diff] [blame]223Known Limitations, Issues and Workarounds
224-----------------------------------------
225
226*System Limitations*
227
228For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
229(`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
230As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
231NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
232Other operations (read, update, delete) are not impacted.
233
danielhanrahan9437af62023-12-20 15:12:47 +0000[diff] [blame]234
mpriyank1d9dae02023-11-09 14:11:26 +0000[diff] [blame]235Version: 3.4.1
236==============
237
238Release Data
239------------
240
241+--------------------------------------+--------------------------------------------------------+
242| **CPS Project** | |
243| | |
244+--------------------------------------+--------------------------------------------------------+
245| **Docker images** | onap/cps-and-ncmp:3.4.1 |
246| | |
247+--------------------------------------+--------------------------------------------------------+
248| **Release designation** | 3.4.1 New Delhi |
249| | |
250+--------------------------------------+--------------------------------------------------------+
danielhanrahan9437af62023-12-20 15:12:47 +0000[diff] [blame]251| **Release date** | 2023 December 20 |
mpriyank1d9dae02023-11-09 14:11:26 +0000[diff] [blame]252| | |
253+--------------------------------------+--------------------------------------------------------+
254
255Bug Fixes
256---------
danielhanrahan3e14d392023-12-20 13:31:07 +0000[diff] [blame]2573.4.1
mpriyank41727e52023-12-04 18:01:07 +0000[diff] [blame]258 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
mpriyank1d9dae02023-11-09 14:11:26 +0000[diff] [blame]259
ToineSiebelink8ee94852023-11-27 14:52:19 +0000[diff] [blame]260Features
261--------
262 - CPS-Temporal is no longer supported and any related documentation has been removed.
danielhanrahan3e14d392023-12-20 13:31:07 +0000[diff] [blame]263 - `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 +0000[diff] [blame]264 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
waqas.ikram60bbcb92023-12-20 10:40:29 +0000[diff] [blame]265 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
mpriyankdb6b8f82023-12-14 13:27:01 +0000[diff] [blame]266 - `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 +0000[diff] [blame]267
danielhanrahan3e14d392023-12-20 13:31:07 +0000[diff] [blame]268Known Issues
269------------
270 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
271
ToineSiebelink8ee94852023-11-27 14:52:19 +0000[diff] [blame]272
mpriyank89e0fe22023-11-09 12:12:38 +0000[diff] [blame]273Version: 3.4.0
274==============
mpriyank2c4535d2023-11-06 17:06:15 +0000[diff] [blame]275
276Release Data
277------------
278
279+--------------------------------------+--------------------------------------------------------+
280| **CPS Project** | |
281| | |
282+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000[diff] [blame]283| **Docker images** | onap/cps-and-ncmp:3.4.0 |
mpriyank2c4535d2023-11-06 17:06:15 +0000[diff] [blame]284| | |
285+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000[diff] [blame]286| **Release designation** | 3.4.0 New Delhi |
mpriyank2c4535d2023-11-06 17:06:15 +0000[diff] [blame]287| | |
288+--------------------------------------+--------------------------------------------------------+
mpriyank1d9dae02023-11-09 14:11:26 +0000[diff] [blame]289| **Release date** | 2023 November 09 |
mpriyank2c4535d2023-11-06 17:06:15 +0000[diff] [blame]290| | |
291+--------------------------------------+--------------------------------------------------------+
292
293Bug Fixes
294---------
mpriyank89e0fe22023-11-09 12:12:38 +0000[diff] [blame]2953.4.0
296 - `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 +0000[diff] [blame]297
mpriyank89e0fe22023-11-09 12:12:38 +0000[diff] [blame]298.. ========================
299.. * * * MONTREAL * * *
300.. ========================
mpriyank2c4535d2023-11-06 17:06:15 +0000[diff] [blame]301
egernugd91a7072023-09-29 12:12:36 +0100[diff] [blame]302Version: 3.3.9
303==============
304
305Release Data
306------------
307
308+--------------------------------------+--------------------------------------------------------+
309| **CPS Project** | |
310| | |
311+--------------------------------------+--------------------------------------------------------+
312| **Docker images** | onap/cps-and-ncmp:3.3.9 |
313| | |
314+--------------------------------------+--------------------------------------------------------+
315| **Release designation** | 3.3.9 Montreal |
316| | |
317+--------------------------------------+--------------------------------------------------------+
mpriyank2c4535d2023-11-06 17:06:15 +0000[diff] [blame]318| **Release date** | 2023 November 06 |
egernugd91a7072023-09-29 12:12:36 +0100[diff] [blame]319| | |
320+--------------------------------------+--------------------------------------------------------+
321
322Bug Fixes
323---------
3243.3.9
mpriyank02b2d2a2023-10-25 12:23:10 +0100[diff] [blame]325 - `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 +0000[diff] [blame]326 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
egernugd91a7072023-09-29 12:12:36 +0100[diff] [blame]327
328Features
329--------
330
danielhanrahan56384d12023-09-20 17:10:40 +0100[diff] [blame]331Version: 3.3.8
332==============
333
334Release Data
335------------
336
337+--------------------------------------+--------------------------------------------------------+
338| **CPS Project** | |
339| | |
340+--------------------------------------+--------------------------------------------------------+
341| **Docker images** | onap/cps-and-ncmp:3.3.8 |
342| | |
343+--------------------------------------+--------------------------------------------------------+
344| **Release designation** | 3.3.8 Montreal |
345| | |
346+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +0100[diff] [blame]347| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +0100[diff] [blame]348| | |
349+--------------------------------------+--------------------------------------------------------+
350
351Bug Fixes
352---------
3533.3.8
354
355Features
356--------
egernugcb9d1502023-09-28 09:57:44 +0100[diff] [blame]357 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +0100[diff] [blame]358
leventecsanyid35ad5c2023-08-23 15:55:30 +0200[diff] [blame]359Version: 3.3.7
360==============
361
362Release Data
363------------
364
365+--------------------------------------+--------------------------------------------------------+
366| **CPS Project** | |
367| | |
368+--------------------------------------+--------------------------------------------------------+
369| **Docker images** | onap/cps-and-ncmp:3.3.7 |
370| | |
371+--------------------------------------+--------------------------------------------------------+
372| **Release designation** | 3.3.7 Montreal |
373| | |
374+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +0100[diff] [blame]375| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +0200[diff] [blame]376| | |
377+--------------------------------------+--------------------------------------------------------+
378
379Bug Fixes
380---------
3813.3.7
danielhanrahanefc55772023-09-15 12:02:35 +0100[diff] [blame]382 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +0200[diff] [blame]383
384Features
385--------
egernugcb9d1502023-09-28 09:57:44 +0100[diff] [blame]386 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100[diff] [blame]387
388Note
389----
390Migrating 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 +0200[diff] [blame]391
egernugbdac4402023-07-21 13:27:24 +0100[diff] [blame]392Version: 3.3.6
393==============
394
395Release Data
396------------
397
398+--------------------------------------+--------------------------------------------------------+
399| **CPS Project** | |
400| | |
401+--------------------------------------+--------------------------------------------------------+
402| **Docker images** | onap/cps-and-ncmp:3.3.6 |
403| | |
404+--------------------------------------+--------------------------------------------------------+
405| **Release designation** | 3.3.6 Montreal |
406| | |
407+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200[diff] [blame]408| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100[diff] [blame]409| | |
410+--------------------------------------+--------------------------------------------------------+
411
412Bug Fixes
413---------
4143.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100[diff] [blame]415 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100[diff] [blame]416 - `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 +0100[diff] [blame]417
418Features
419--------
danielhanrahan92705462023-05-18 10:18:10 +0100[diff] [blame]420 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100[diff] [blame]421 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100[diff] [blame]422
423
egernug6c9621a2023-07-19 11:05:00 +0100[diff] [blame]424Version: 3.3.5
425==============
426
427Release Data
428------------
429
430+--------------------------------------+--------------------------------------------------------+
431| **CPS Project** | |
432| | |
433+--------------------------------------+--------------------------------------------------------+
434| **Docker images** | onap/cps-and-ncmp:3.3.5 |
435| | |
436+--------------------------------------+--------------------------------------------------------+
437| **Release designation** | 3.3.5 Montreal |
438| | |
439+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100[diff] [blame]440| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100[diff] [blame]441| | |
442+--------------------------------------+--------------------------------------------------------+
443
444Bug Fixes
445---------
4463.3.5
447
448Features
449--------
danielhanrahan74a47152023-06-28 12:55:20 +0100[diff] [blame]450 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100[diff] [blame]451
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]452Version: 3.3.4
453==============
454
455Release Data
456------------
457
458+--------------------------------------+--------------------------------------------------------+
459| **CPS Project** | |
460| | |
461+--------------------------------------+--------------------------------------------------------+
462| **Docker images** | onap/cps-and-ncmp:3.3.4 |
463| | |
464+--------------------------------------+--------------------------------------------------------+
465| **Release designation** | 3.3.4 Montreal |
466| | |
467+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100[diff] [blame]468| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]469| | |
470+--------------------------------------+--------------------------------------------------------+
471
472Bug Fixes
473---------
4743.3.4
475
476Features
477--------
egernugdb62ffb2023-07-18 10:57:42 +0100[diff] [blame]478 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]479
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]480Version: 3.3.3
481==============
482
483Release Data
484------------
485
486+--------------------------------------+--------------------------------------------------------+
487| **CPS Project** | |
488| | |
489+--------------------------------------+--------------------------------------------------------+
490| **Docker images** | onap/cps-and-ncmp:3.3.3 |
491| | |
492+--------------------------------------+--------------------------------------------------------+
493| **Release designation** | 3.3.3 Montreal |
494| | |
495+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]496| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]497| | |
498+--------------------------------------+--------------------------------------------------------+
499
500Bug Fixes
501---------
5023.3.3
503
504Features
505--------
mpriyank6da95412023-06-29 16:56:11 +0100[diff] [blame]506 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
507 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
508 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]509
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]510Version: 3.3.2
511==============
512
513Release Data
514------------
515
516+--------------------------------------+--------------------------------------------------------+
517| **CPS Project** | |
518| | |
519+--------------------------------------+--------------------------------------------------------+
520| **Docker images** | onap/cps-and-ncmp:3.3.2 |
521| | |
522+--------------------------------------+--------------------------------------------------------+
523| **Release designation** | 3.3.2 Montreal |
524| | |
525+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]526| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]527| | |
528+--------------------------------------+--------------------------------------------------------+
529
530Bug Fixes
531---------
5323.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100[diff] [blame]533 - `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 +0100[diff] [blame]534
535Features
536--------
--globalc7e5a802023-04-05 17:08:08 +0530[diff] [blame]537 - `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 +0100[diff] [blame]538 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
539 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
540 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
541 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]542
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]543Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]544==============
545
546Release Data
547------------
548
549+--------------------------------------+--------------------------------------------------------+
550| **CPS Project** | |
551| | |
552+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]553| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]554| | |
555+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]556| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]557| | |
558+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]559| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]560| | |
561+--------------------------------------+--------------------------------------------------------+
562
563Bug Fixes
564---------
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]5653.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]566 - None
567
568Features
569--------
mpriyank52c5e542023-05-02 15:58:55 +0100[diff] [blame]570 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
571 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
572 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
573 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
574 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]575
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]576Version: 3.3.0
577==============
578
579Release Data
580------------
581
582+--------------------------------------+--------------------------------------------------------+
583| **CPS Project** | |
584| | |
585+--------------------------------------+--------------------------------------------------------+
586| **Docker images** | onap/cps-and-ncmp:3.3.0 |
587| | |
588+--------------------------------------+--------------------------------------------------------+
589| **Release designation** | 3.3.0 Montreal |
590| | |
591+--------------------------------------+--------------------------------------------------------+
592| **Release date** | 2023 April 20 |
593| | |
594+--------------------------------------+--------------------------------------------------------+
595
596Bug Fixes
597---------
5983.3.0
599 - None
600
601Features
602--------
603 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
604 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
605
606.. ======================
607.. * * * LONDON * * *
608.. ======================
609
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]610Version: 3.2.6
611==============
612
613Release Data
614------------
615
616+--------------------------------------+--------------------------------------------------------+
617| **CPS Project** | |
618| | |
619+--------------------------------------+--------------------------------------------------------+
620| **Docker images** | onap/cps-and-ncmp:3.2.6 |
621| | |
622+--------------------------------------+--------------------------------------------------------+
623| **Release designation** | 3.2.6 London |
624| | |
625+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]626| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]627| | |
628+--------------------------------------+--------------------------------------------------------+
629
630Bug Fixes
631---------
6323.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]633 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]634 - `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 +0000[diff] [blame]635
636Features
637--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]638 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]639
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]640Version: 3.2.5
641==============
642
643Release Data
644------------
645
646+--------------------------------------+--------------------------------------------------------+
647| **CPS Project** | |
648| | |
649+--------------------------------------+--------------------------------------------------------+
650| **Docker images** | onap/cps-and-ncmp:3.2.5 |
651| | |
652+--------------------------------------+--------------------------------------------------------+
653| **Release designation** | 3.2.5 London |
654| | |
655+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000[diff] [blame]656| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]657| | |
658+--------------------------------------+--------------------------------------------------------+
659
660Bug Fixes
661---------
6623.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000[diff] [blame]663 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]664
665Features
666--------
667 - None
668
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]669Version: 3.2.4
670==============
671
672Release Data
673------------
674
675+--------------------------------------+--------------------------------------------------------+
676| **CPS Project** | |
677| | |
678+--------------------------------------+--------------------------------------------------------+
679| **Docker images** | onap/cps-and-ncmp:3.2.4 |
680| | |
681+--------------------------------------+--------------------------------------------------------+
682| **Release designation** | 3.2.4 London |
683| | |
684+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000[diff] [blame]685| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]686| | |
687+--------------------------------------+--------------------------------------------------------+
688
689Bug Fixes
690---------
6913.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000[diff] [blame]692 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
693 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
694
695Features
696--------
697 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]698
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]699Version: 3.2.3
700==============
701
702Release Data
703------------
704
705+--------------------------------------+--------------------------------------------------------+
706| **CPS Project** | |
707| | |
708+--------------------------------------+--------------------------------------------------------+
709| **Docker images** | onap/cps-and-ncmp:3.2.3 |
710| | |
711+--------------------------------------+--------------------------------------------------------+
712| **Release designation** | 3.2.3 London |
713| | |
714+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]715| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]716| | |
717+--------------------------------------+--------------------------------------------------------+
718
719Bug Fixes
720---------
7213.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]722 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]723
724Features
725--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]726 - `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
727 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]728
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]729Version: 3.2.2
730==============
731
732Release Data
733------------
734
735+--------------------------------------+--------------------------------------------------------+
736| **CPS Project** | |
737| | |
738+--------------------------------------+--------------------------------------------------------+
739| **Docker images** | onap/cps-and-ncmp:3.2.2 |
740| | |
741+--------------------------------------+--------------------------------------------------------+
742| **Release designation** | 3.2.2 London |
743| | |
744+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]745| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]746| | |
747+--------------------------------------+--------------------------------------------------------+
748
749Bug Fixes
750---------
mpriyank0b5950d2023-02-07 17:55:10 +0000[diff] [blame]7513.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]752 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000[diff] [blame]753
754Features
755--------
756 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]757
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]758Version: 3.2.1
759==============
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]760
761Release Data
762------------
763
764+--------------------------------------+--------------------------------------------------------+
765| **CPS Project** | |
766| | |
767+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]768| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]769| | |
770+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]771| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]772| | |
773+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]774| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]775| | |
776+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100[diff] [blame]777
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]778Features
779--------
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]7803.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]781 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
782 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
783 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]784 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
785 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000[diff] [blame]786 - `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 +0000[diff] [blame]787 - `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 +0000[diff] [blame]788 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]789 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]790 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]791 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
792 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
793 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]794
795Bug Fixes
796---------
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]7973.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]798 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
799 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
800 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
801 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
802 - `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 +0100[diff] [blame]803 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]804 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]805 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]806 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
807 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
808 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
809 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
810 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
811 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]812
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]8133.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]814 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]815
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]816Known Limitations, Issues and Workarounds
817-----------------------------------------
818
819*System Limitations*
820
seanbeirne72c267e2022-10-18 12:39:22 +0100[diff] [blame]821For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
822This 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 +0100[diff] [blame]823
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]824CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
825a 400 Bad Request is sent as response. This is part of commit CPS-1526.
826
seanbeirnedba2b102022-10-27 09:59:17 +0100[diff] [blame]827.. ====================
828.. * * * KOHN * * *
829.. ====================
830
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]831Version: 3.1.4
832==============
833
834Release Data
835------------
836
837+--------------------------------------+--------------------------------------------------------+
838| **CPS Project** | |
839| | |
840+--------------------------------------+--------------------------------------------------------+
841| **Docker images** | onap/cps-and-ncmp:3.1.4 |
842| | |
843+--------------------------------------+--------------------------------------------------------+
844| **Release designation** | 3.1.4 Kohn |
845| | |
846+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]847| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]848| | |
849+--------------------------------------+--------------------------------------------------------+
850
851Bug Fixes
852---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100[diff] [blame]853 - `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 +0100[diff] [blame]854 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]855
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]856Version: 3.1.3
857==============
858
859Release Data
860------------
861
862+--------------------------------------+--------------------------------------------------------+
863| **CPS Project** | |
864| | |
865+--------------------------------------+--------------------------------------------------------+
866| **Docker images** | onap/cps-and-ncmp:3.1.3 |
867| | |
868+--------------------------------------+--------------------------------------------------------+
869| **Release designation** | 3.1.3 Kohn |
870| | |
871+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]872| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]873| | |
874+--------------------------------------+--------------------------------------------------------+
875
876Bug Fixes
877---------
878 - None
879
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]880Version: 3.1.2
881==============
882
883Release Data
884------------
885
886+--------------------------------------+--------------------------------------------------------+
887| **CPS Project** | |
888| | |
889+--------------------------------------+--------------------------------------------------------+
890| **Docker images** | onap/cps-and-ncmp:3.1.2 |
891| | |
892+--------------------------------------+--------------------------------------------------------+
893| **Release designation** | 3.1.2 Kohn |
894| | |
895+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]896| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]897| | |
898+--------------------------------------+--------------------------------------------------------+
899
900Bug Fixes
901---------
902 - None
903
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]904Version: 3.1.1
905==============
906
907Release Data
908------------
909
910+--------------------------------------+--------------------------------------------------------+
911| **CPS Project** | |
912| | |
913+--------------------------------------+--------------------------------------------------------+
914| **Docker images** | onap/cps-and-ncmp:3.1.1 |
915| | |
916+--------------------------------------+--------------------------------------------------------+
917| **Release designation** | 3.1.1 Kohn |
918| | |
919+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]920| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]921| | |
922+--------------------------------------+--------------------------------------------------------+
923
924Bug Fixes
925---------
926 - None
927
lukegleesonc9ec9152022-09-07 14:21:36 +0100[diff] [blame]928Security Notes
929--------------
930
931*Fixed Security Issues*
932
933 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
934
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]935Version: 3.1.0
936==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]937
938Release Data
939------------
940
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]941+--------------------------------------+--------------------------------------------------------+
942| **CPS Project** | |
943| | |
944+--------------------------------------+--------------------------------------------------------+
945| **Docker images** | onap/cps-and-ncmp:3.1.0 |
946| | |
947+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]948| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]949| | |
950+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]951| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]952| | |
953+--------------------------------------+--------------------------------------------------------+
954
955Features
956--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]957 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
958 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
959 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
960 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
961 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
962 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
963 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
964 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
965 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
966 - `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'
967 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
968 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
969 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
970 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
971 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
972 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
973 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
974 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
975 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
976 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
977 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
978 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
979 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
980 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
981
emacleeafb17362022-09-02 14:40:17 +0100[diff] [blame]982
983Bug Fixes
984---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]985 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
986 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
987 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
988 - `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 +0100[diff] [blame]989 - `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 +0100[diff] [blame]990 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
991 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
992 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
993 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
994 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
995 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
996 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
997 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
998 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100[diff] [blame]999
1000Known Limitations, Issues and Workarounds
1001-----------------------------------------
1002
1003*System Limitations*
1004
1005Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
1006Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]1007
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]1008*Known Vulnerabilities*
1009
1010None
1011
1012*Workarounds*
1013
1014None
1015
1016Security Notes
1017--------------
1018
1019*Fixed Security Issues*
1020
1021 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
1022
1023*Known Security Issues*
1024
1025None
1026
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]1027.. ========================
1028.. * * * JAKARTA * * *
1029.. ========================
1030
1031Version: 3.0.1
1032==============
1033
1034Release Data
1035------------
1036
1037+--------------------------------------+--------------------------------------------------------+
1038| **CPS Project** | |
1039| | |
1040+--------------------------------------+--------------------------------------------------------+
1041| **Docker images** | onap/cps-and-ncmp:3.0.1 |
1042| | |
1043+--------------------------------------+--------------------------------------------------------+
1044| **Release designation** | 3.0.1 Jakarta |
1045| | |
1046+--------------------------------------+--------------------------------------------------------+
1047| **Release date** | 2022 April 28 |
1048| | |
1049+--------------------------------------+--------------------------------------------------------+
1050
1051Bug Fixes
1052---------
1053 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
1054
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]1055Version: 3.0.0
1056==============
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1057
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]1058Release Data
1059------------
1060
1061+--------------------------------------+--------------------------------------------------------+
1062| **CPS Project** | |
1063| | |
1064+--------------------------------------+--------------------------------------------------------+
1065| **Docker images** | onap/cps-and-ncmp:3.0.0 |
1066| | |
1067+--------------------------------------+--------------------------------------------------------+
1068| **Release designation** | 3.0.0 Jakarta |
1069| | |
1070+--------------------------------------+--------------------------------------------------------+
1071| **Release date** | 2022 March 15 |
1072| | |
1073+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1074
1075Features
1076--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]1077 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1078 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
1079 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]1080 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1081 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000[diff] [blame]1082 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]1083 - `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 -0400[diff] [blame]1084 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
1085 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]1086 - `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 +0530[diff] [blame]1087 - `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 +0000[diff] [blame]1088
1089Bug Fixes
1090---------
1091
1092 - `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 +0000[diff] [blame]1093 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000[diff] [blame]1094 - `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 +0000[diff] [blame]1095 - `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 +0000[diff] [blame]1096 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]1097 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]1098 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]1099 - `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 +0530[diff] [blame]1100 - `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 +0100[diff] [blame]1101 - `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 +0000[diff] [blame]1102
1103Known Limitations, Issues and Workarounds
1104-----------------------------------------
1105
1106*System Limitations*
1107
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]1108Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
1109`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
1110of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1111
Lathishb3550f12022-03-15 12:03:53 +0000[diff] [blame]1112The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
1113for more information.
1114
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1115*Known Vulnerabilities*
1116
1117None
1118
1119*Workarounds*
1120
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]1121Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
1122pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]1123
1124Security Notes
1125--------------
1126
1127*Fixed Security Issues*
1128
1129None
1130
1131*Known Security Issues*
1132
1133None
1134
1135.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1136.. * * * ISTANBUL * * *
1137.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1138
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]1139Version: 2.0.4
1140==============
1141
1142Release Data
1143------------
1144
1145+--------------------------------------+--------------------------------------------------------+
1146| **CPS Project** | |
1147| | |
1148+--------------------------------------+--------------------------------------------------------+
1149| **Docker images** | onap/cps-and-ncmp:2.0.4 |
1150| | |
1151+--------------------------------------+--------------------------------------------------------+
1152| **Release designation** | 2.0.4 Istanbul |
1153| | |
1154+--------------------------------------+--------------------------------------------------------+
1155| **Release date** | 2022 Feb 09 |
1156| | |
1157+--------------------------------------+--------------------------------------------------------+
1158
1159Bug Fixes
1160---------
1161
1162 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
1163 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
1164
1165Version: 2.0.3
1166==============
1167
1168Release Data
1169------------
1170
1171+--------------------------------------+--------------------------------------------------------+
1172| **CPS Project** | |
1173| | |
1174+--------------------------------------+--------------------------------------------------------+
1175| **Docker images** | onap/cps-and-ncmp:2.0.3 |
1176| | |
1177+--------------------------------------+--------------------------------------------------------+
1178| **Release designation** | 2.0.3 Istanbul |
1179| | |
1180+--------------------------------------+--------------------------------------------------------+
1181| **Release date** | 2022-07-01 |
1182| | |
1183+--------------------------------------+--------------------------------------------------------+
1184
1185Bug Fixes
1186---------
1187
1188 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
1189
1190Version: 2.0.2
1191==============
1192
1193Release Data
1194------------
1195
1196+--------------------------------------+--------------------------------------------------------+
1197| **CPS Project** | |
1198| | |
1199+--------------------------------------+--------------------------------------------------------+
1200| **Docker images** | onap/cps-and-ncmp:2.0.2 |
1201| | |
1202+--------------------------------------+--------------------------------------------------------+
1203| **Release designation** | 2.0.2 Istanbul |
1204| | |
1205+--------------------------------------+--------------------------------------------------------+
1206| **Release date** | 2021-16-12 |
1207| | |
1208+--------------------------------------+--------------------------------------------------------+
1209
1210Bug Fixes
1211---------
1212
1213 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
1214
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1215Version: 2.0.1
1216==============
1217
1218Release Data
1219------------
1220
1221+--------------------------------------+--------------------------------------------------------+
1222| **CPS Project** | |
1223| | |
1224+--------------------------------------+--------------------------------------------------------+
1225| **Docker images** | onap/cps-and-ncmp:2.0.1 |
1226| | |
1227+--------------------------------------+--------------------------------------------------------+
1228| **Release designation** | 2.0.1 Istanbul |
1229| | |
1230+--------------------------------------+--------------------------------------------------------+
1231| **Release date** | 2021-14-10 |
1232| | |
1233+--------------------------------------+--------------------------------------------------------+
1234
1235Bug Fixes
1236---------
1237
1238 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1239 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1240 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1241 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1242
1243Known Limitations, Issues and Workarounds
1244-----------------------------------------
1245
1246*System Limitations*
1247
1248Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1249
1250*Known Vulnerabilities*
1251
1252 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1253
1254*Workarounds*
1255
1256Add recursive method to save list node data to loop through all corresponding child nodes.
1257
1258Security Notes
1259--------------
1260
1261*Fixed Security Issues*
1262
1263 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1264
1265*Known Security Issues*
1266
1267None
1268
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1269Version: 2.0.0
1270==============
1271
1272Abstract
1273--------
1274
1275This document provides the release notes for Istanbul release.
1276
1277Release Data
1278------------
1279
1280+--------------------------------------+--------------------------------------------------------+
1281| **CPS Project** | |
1282| | |
1283+--------------------------------------+--------------------------------------------------------+
1284| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1285| | |
1286+--------------------------------------+--------------------------------------------------------+
1287| **Release designation** | 2.0.0 Istanbul |
1288| | |
1289+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1290| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1291| | |
1292+--------------------------------------+--------------------------------------------------------+
1293
1294Features
1295--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]1296* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1297* Update, Create and Remove CM Handles.
1298* Add support for retrieving and writing CM Handle data through NCMP datastores.
1299* Automatic retrieval and caching of model information for CM Handles within NCMP.
1300
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1301Deliverables
1302------------
1303
1304Software Deliverables
1305
1306.. csv-table::
1307 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1308 :widths: auto
1309
1310 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1311
1312Bug Fixes
1313---------
1314
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1315 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1316 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1317 - `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 +0100[diff] [blame]1318 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1319 - `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 +0100[diff] [blame]1320 - `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 +0100[diff] [blame]1321 - `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 +0100[diff] [blame]1322 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1323 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1324 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1325 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1326 - `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 +0100[diff] [blame]1327 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1328 - `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 +0100[diff] [blame]1329 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1330 - `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 +0100[diff] [blame]1331 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1332 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1333 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1334 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1335 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1336 - `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 -0500[diff] [blame]1337 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1338 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1339 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1340 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1341
1342This document provides the release notes for Istanbul release.
1343
1344Summary
1345-------
1346
1347Following CPS components are available with default ONAP/CPS installation.
1348
1349
1350 * Platform components
1351
1352 - CPS (Helm charts)
1353
1354 * Service components
1355
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]1356 - CPS-NCMP
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]1357 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1358
1359 * Additional resources that CPS utilizes deployed using ONAP common charts
1360
1361 - Postgres Database
1362
1363
1364Below service components (mS) are available to be deployed on-demand.
1365 - CPS-TBDMT
1366
1367
1368Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1369
1370Known Limitations, Issues and Workarounds
1371-----------------------------------------
1372
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1373*System Limitations*
1374
1375Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1376
1377*Known Vulnerabilities*
1378
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1379 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1380 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1381 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1382
1383*Workarounds*
1384
1385Add recursive method to save list node data to loop through all corresponding child nodes.
1386
1387Security Notes
1388--------------
1389
1390*Fixed Security Issues*
1391
1392 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1393
1394*Known Security Issues*
1395
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]1396 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1397
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]1398Test Results
1399------------
1400 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1401
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame]1402.. ========================
1403.. * * * HONOLULU * * *
1404.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1405
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]1406Version: 1.0.1
1407==============
1408
1409Release Data
1410------------
1411
1412+--------------------------------------+--------------------------------------------------------+
1413| **CPS Project** | |
1414| | |
1415+--------------------------------------+--------------------------------------------------------+
1416| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1417| | |
1418+--------------------------------------+--------------------------------------------------------+
1419| **Release designation** | 1.0.1 Honolulu |
1420| | |
1421+--------------------------------------+--------------------------------------------------------+
1422| **Release date** | 2021-04-09 |
1423| | |
1424+--------------------------------------+--------------------------------------------------------+
1425
1426Bug Fixes
1427---------
1428
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100[diff] [blame]1429 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]1430 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1431 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1432 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1433 - `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
1434 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1435 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1436 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1437
1438Security Notes
1439--------------
1440
1441*Fixed Security Issues*
1442
1443 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1444
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]1445*Known Security Issues*
1446
1447 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1448
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1449Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1450==============
1451
1452
1453Abstract
1454--------
1455
1456This document provides the release notes for Honolulu release.
1457
1458Summary
1459-------
1460
1461Following CPS components are available with default ONAP/CPS installation.
1462
1463
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1464 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1465
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1466 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1467
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1468 * Service components
1469
1470 - CPS Core
1471
1472 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1473
1474 - Postgres Database
1475
1476
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1477Below service components (mS) are available to be deployed on-demand.
1478 - CPS-TBDMT
1479
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1480
1481Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1482
1483
1484Release Data
1485------------
1486
1487+--------------------------------------+--------------------------------------------------------+
1488| **CPS Project** | |
1489| | |
1490+--------------------------------------+--------------------------------------------------------+
1491| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1492| | |
1493+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1494| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1495| | |
1496+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1497| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1498| | |
1499+--------------------------------------+--------------------------------------------------------+
1500
1501
1502Features
1503--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1504Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1505CPS has been driven by the needs of the E2E Networking Slicing use case.
1506It currently supports basic (rw) persistence and simple queries.
1507It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1508
1509.. _honolulu_deliverable:
1510
1511Deliverables
1512------------
1513
1514Software Deliverables
1515
1516.. csv-table::
1517 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1518 :widths: auto
1519
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1520 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1521
1522
1523Known Limitations, Issues and Workarounds
1524-----------------------------------------
1525
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1526 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1527 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1528 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]1529 - `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 +0000[diff] [blame]1530
1531*System Limitations*
1532
1533None
1534
1535*Known Vulnerabilities*
1536
1537None
1538
1539*Workarounds*
1540
1541Documented under corresponding jira if applicable.
1542
1543Security Notes
1544--------------
1545
1546*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]1547
1548* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1549 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]1550 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1551 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1552
1553*Known Security Issues*
1554
ToineSiebelink74eed2c2023-08-31 17:38:52 +0100[diff] [blame]1555 * Weak Cryptography using md5
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1556 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1557
1558*Known Vulnerabilities in Used Modules*
1559
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1560 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1561
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1562CPS 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 +0000[diff] [blame]1563
1564Test Results
1565------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1566 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1567
1568References
1569----------
1570
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1571For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1572
1573#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1574#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1575#. `ONAP Documentation`_
1576#. `ONAP CPS Documentation`_
1577#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1578
1579
1580.. _`ONAP Home Page`: https://www.onap.org
1581.. _`ONAP Wiki Page`: https://wiki.onap.org
1582.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1583.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1584.. _`ONAP Release Downloads`: https://git.onap.org
1585
1586Quick Links:
1587
1588 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1589 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_