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