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