blob: a134d0d944142c30d73ec0e335d092051e67885a [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
danielhanrahan9e871802023-08-17 14:58:30 +01003.. Copyright (C) 2021-2024 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +00004
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00008CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -04009#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +000010
11.. contents::
12 :depth: 2
13..
14
mpriyank89e0fe22023-11-09 12:12:38 +000015.. =========================
16.. * * * NEW DELHI * * *
17.. =========================
niamhcoref7b414e2021-11-17 11:02:07 +000018
mpriyank22e1f432024-02-27 14:04:38 +000019Version: 3.4.6
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.4.6 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.4.6 New Delhi |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.4.6
42
43
44Features
45--------
46
danielhanrahanb8e677f2024-02-23 15:27:17 +000047Version: 3.4.5
48==============
49
50Release Data
51------------
52
53+--------------------------------------+--------------------------------------------------------+
54| **CPS Project** | |
55| | |
56+--------------------------------------+--------------------------------------------------------+
57| **Docker images** | onap/cps-and-ncmp:3.4.5 |
58| | |
59+--------------------------------------+--------------------------------------------------------+
60| **Release designation** | 3.4.5 New Delhi |
61| | |
62+--------------------------------------+--------------------------------------------------------+
mpriyank22e1f432024-02-27 14:04:38 +000063| **Release date** | 2024 February 27 |
danielhanrahanb8e677f2024-02-23 15:27:17 +000064| | |
65+--------------------------------------+--------------------------------------------------------+
66
67Bug Fixes
68---------
693.4.5
70
71
72Features
73--------
mpriyankcfac7192024-02-27 12:21:53 +000074 - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot version to 3.2.2
danielhanrahanb8e677f2024-02-23 15:27:17 +000075
76
danielhanrahan97bad452024-02-07 16:07:27 +000077Version: 3.4.4
78==============
79
80Release Data
81------------
82
83+--------------------------------------+--------------------------------------------------------+
84| **CPS Project** | |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Docker images** | onap/cps-and-ncmp:3.4.4 |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90| **Release designation** | 3.4.4 New Delhi |
91| | |
92+--------------------------------------+--------------------------------------------------------+
danielhanrahanb8e677f2024-02-23 15:27:17 +000093| **Release date** | 2024 February 23 |
danielhanrahan97bad452024-02-07 16:07:27 +000094| | |
95+--------------------------------------+--------------------------------------------------------+
96
97Bug Fixes
98---------
993.4.4
danielhanrahan8c37c032024-02-23 13:27:37 +0000100 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Upgrade Yang modules using module set tag functionalities fix
danielhanrahan97bad452024-02-07 16:07:27 +0000101
102Features
103--------
danielhanrahan8c37c032024-02-23 13:27:37 +0000104 - `CPS-2057 <https://jira.onap.org/browse/CPS-2057>`_ Leaf lists are sorted by default if Yang model does not specify order.
105 - `CPS-2087 <https://jira.onap.org/browse/CPS-2087>`_ Performance improvement of CPS Path Queries.
danielhanrahan97bad452024-02-07 16:07:27 +0000106
107
danielhanrahan345f40f2024-01-11 15:25:18 +0000108Version: 3.4.3
109==============
110
111Release Data
112------------
113
114+--------------------------------------+--------------------------------------------------------+
115| **CPS Project** | |
116| | |
117+--------------------------------------+--------------------------------------------------------+
118| **Docker images** | onap/cps-and-ncmp:3.4.3 |
119| | |
120+--------------------------------------+--------------------------------------------------------+
121| **Release designation** | 3.4.3 New Delhi |
122| | |
123+--------------------------------------+--------------------------------------------------------+
danielhanrahan97bad452024-02-07 16:07:27 +0000124| **Release date** | 2024 February 07 |
danielhanrahan345f40f2024-01-11 15:25:18 +0000125| | |
126+--------------------------------------+--------------------------------------------------------+
127
128Bug Fixes
129---------
1303.4.3
danielhanrahan7ce495b2024-02-07 14:21:58 +0000131 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed.
132 - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag.
133 - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer.
danielhanrahan345f40f2024-01-11 15:25:18 +0000134
135Features
136--------
Arpit Singh1322b0f2024-01-19 13:46:03 +0530137 - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors.
danielhanrahan81f61b52024-02-02 12:25:47 +0000138 - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR.
halil.cakalc1b09262024-02-08 12:15:48 +0000139 - `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 +0000140
141Notes
142-----
143The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a
144*-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename
145of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*.
danielhanrahan345f40f2024-01-11 15:25:18 +0000146
danielhanrahan9437af62023-12-20 15:12:47 +0000147Version: 3.4.2
148==============
149
150Release Data
151------------
152
153+--------------------------------------+--------------------------------------------------------+
154| **CPS Project** | |
155| | |
156+--------------------------------------+--------------------------------------------------------+
157| **Docker images** | onap/cps-and-ncmp:3.4.2 |
158| | |
159+--------------------------------------+--------------------------------------------------------+
160| **Release designation** | 3.4.2 New Delhi |
161| | |
162+--------------------------------------+--------------------------------------------------------+
danielhanrahan345f40f2024-01-11 15:25:18 +0000163| **Release date** | 2024 January 11 |
danielhanrahan9437af62023-12-20 15:12:47 +0000164| | |
165+--------------------------------------+--------------------------------------------------------+
166
167Bug Fixes
168---------
1693.4.2
170
171
172Features
173--------
halil.cakal37c6d4d2024-01-11 11:10:17 +0000174 - `CPS-1638 <https://jira.onap.org/browse/CPS-1638>`_ Introduce trust level for CM handle.
danielhanrahan36b81b22023-08-17 14:58:30 +0100175 - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
danielhanrahan9e871802023-08-17 14:58:30 +0100176 - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
danielhanrahan926d4082023-08-04 11:22:43 +0100177 - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
178
179Notes
180-----
181 - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
danielhanrahan9437af62023-12-20 15:12:47 +0000182
danielhanrahan36b81b22023-08-17 14:58:30 +0100183Known Limitations, Issues and Workarounds
184-----------------------------------------
185
186*System Limitations*
187
188For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
189(`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
190As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
191NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
192Other operations (read, update, delete) are not impacted.
193
danielhanrahan9437af62023-12-20 15:12:47 +0000194
mpriyank1d9dae02023-11-09 14:11:26 +0000195Version: 3.4.1
196==============
197
198Release Data
199------------
200
201+--------------------------------------+--------------------------------------------------------+
202| **CPS Project** | |
203| | |
204+--------------------------------------+--------------------------------------------------------+
205| **Docker images** | onap/cps-and-ncmp:3.4.1 |
206| | |
207+--------------------------------------+--------------------------------------------------------+
208| **Release designation** | 3.4.1 New Delhi |
209| | |
210+--------------------------------------+--------------------------------------------------------+
danielhanrahan9437af62023-12-20 15:12:47 +0000211| **Release date** | 2023 December 20 |
mpriyank1d9dae02023-11-09 14:11:26 +0000212| | |
213+--------------------------------------+--------------------------------------------------------+
214
215Bug Fixes
216---------
danielhanrahan3e14d392023-12-20 13:31:07 +00002173.4.1
mpriyank41727e52023-12-04 18:01:07 +0000218 - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
mpriyank1d9dae02023-11-09 14:11:26 +0000219
ToineSiebelink8ee94852023-11-27 14:52:19 +0000220Features
221--------
222 - CPS-Temporal is no longer supported and any related documentation has been removed.
danielhanrahan3e14d392023-12-20 13:31:07 +0000223 - `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 +0000224 - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
waqas.ikram60bbcb92023-12-20 10:40:29 +0000225 - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
mpriyankdb6b8f82023-12-14 13:27:01 +0000226 - `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 +0000227
danielhanrahan3e14d392023-12-20 13:31:07 +0000228Known Issues
229------------
230 - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
231
ToineSiebelink8ee94852023-11-27 14:52:19 +0000232
mpriyank89e0fe22023-11-09 12:12:38 +0000233Version: 3.4.0
234==============
mpriyank2c4535d2023-11-06 17:06:15 +0000235
236Release Data
237------------
238
239+--------------------------------------+--------------------------------------------------------+
240| **CPS Project** | |
241| | |
242+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000243| **Docker images** | onap/cps-and-ncmp:3.4.0 |
mpriyank2c4535d2023-11-06 17:06:15 +0000244| | |
245+--------------------------------------+--------------------------------------------------------+
mpriyank89e0fe22023-11-09 12:12:38 +0000246| **Release designation** | 3.4.0 New Delhi |
mpriyank2c4535d2023-11-06 17:06:15 +0000247| | |
248+--------------------------------------+--------------------------------------------------------+
mpriyank1d9dae02023-11-09 14:11:26 +0000249| **Release date** | 2023 November 09 |
mpriyank2c4535d2023-11-06 17:06:15 +0000250| | |
251+--------------------------------------+--------------------------------------------------------+
252
253Bug Fixes
254---------
mpriyank89e0fe22023-11-09 12:12:38 +00002553.4.0
256 - `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 +0000257
mpriyank89e0fe22023-11-09 12:12:38 +0000258.. ========================
259.. * * * MONTREAL * * *
260.. ========================
mpriyank2c4535d2023-11-06 17:06:15 +0000261
egernugd91a7072023-09-29 12:12:36 +0100262Version: 3.3.9
263==============
264
265Release Data
266------------
267
268+--------------------------------------+--------------------------------------------------------+
269| **CPS Project** | |
270| | |
271+--------------------------------------+--------------------------------------------------------+
272| **Docker images** | onap/cps-and-ncmp:3.3.9 |
273| | |
274+--------------------------------------+--------------------------------------------------------+
275| **Release designation** | 3.3.9 Montreal |
276| | |
277+--------------------------------------+--------------------------------------------------------+
mpriyank2c4535d2023-11-06 17:06:15 +0000278| **Release date** | 2023 November 06 |
egernugd91a7072023-09-29 12:12:36 +0100279| | |
280+--------------------------------------+--------------------------------------------------------+
281
282Bug Fixes
283---------
2843.3.9
mpriyank02b2d2a2023-10-25 12:23:10 +0100285 - `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 +0000286 - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
egernugd91a7072023-09-29 12:12:36 +0100287
288Features
289--------
290
danielhanrahan56384d12023-09-20 17:10:40 +0100291Version: 3.3.8
292==============
293
294Release Data
295------------
296
297+--------------------------------------+--------------------------------------------------------+
298| **CPS Project** | |
299| | |
300+--------------------------------------+--------------------------------------------------------+
301| **Docker images** | onap/cps-and-ncmp:3.3.8 |
302| | |
303+--------------------------------------+--------------------------------------------------------+
304| **Release designation** | 3.3.8 Montreal |
305| | |
306+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +0100307| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +0100308| | |
309+--------------------------------------+--------------------------------------------------------+
310
311Bug Fixes
312---------
3133.3.8
314
315Features
316--------
egernugcb9d1502023-09-28 09:57:44 +0100317 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +0100318
leventecsanyid35ad5c2023-08-23 15:55:30 +0200319Version: 3.3.7
320==============
321
322Release Data
323------------
324
325+--------------------------------------+--------------------------------------------------------+
326| **CPS Project** | |
327| | |
328+--------------------------------------+--------------------------------------------------------+
329| **Docker images** | onap/cps-and-ncmp:3.3.7 |
330| | |
331+--------------------------------------+--------------------------------------------------------+
332| **Release designation** | 3.3.7 Montreal |
333| | |
334+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +0100335| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +0200336| | |
337+--------------------------------------+--------------------------------------------------------+
338
339Bug Fixes
340---------
3413.3.7
danielhanrahanefc55772023-09-15 12:02:35 +0100342 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +0200343
344Features
345--------
egernugcb9d1502023-09-28 09:57:44 +0100346 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100347
348Note
349----
350Migrating 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 +0200351
egernugbdac4402023-07-21 13:27:24 +0100352Version: 3.3.6
353==============
354
355Release Data
356------------
357
358+--------------------------------------+--------------------------------------------------------+
359| **CPS Project** | |
360| | |
361+--------------------------------------+--------------------------------------------------------+
362| **Docker images** | onap/cps-and-ncmp:3.3.6 |
363| | |
364+--------------------------------------+--------------------------------------------------------+
365| **Release designation** | 3.3.6 Montreal |
366| | |
367+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200368| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100369| | |
370+--------------------------------------+--------------------------------------------------------+
371
372Bug Fixes
373---------
3743.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100375 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100376 - `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 +0100377
378Features
379--------
danielhanrahan92705462023-05-18 10:18:10 +0100380 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100381 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100382
383
egernug6c9621a2023-07-19 11:05:00 +0100384Version: 3.3.5
385==============
386
387Release Data
388------------
389
390+--------------------------------------+--------------------------------------------------------+
391| **CPS Project** | |
392| | |
393+--------------------------------------+--------------------------------------------------------+
394| **Docker images** | onap/cps-and-ncmp:3.3.5 |
395| | |
396+--------------------------------------+--------------------------------------------------------+
397| **Release designation** | 3.3.5 Montreal |
398| | |
399+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100400| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100401| | |
402+--------------------------------------+--------------------------------------------------------+
403
404Bug Fixes
405---------
4063.3.5
407
408Features
409--------
danielhanrahan74a47152023-06-28 12:55:20 +0100410 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100411
mpriyank8caa3422023-06-30 11:14:10 +0100412Version: 3.3.4
413==============
414
415Release Data
416------------
417
418+--------------------------------------+--------------------------------------------------------+
419| **CPS Project** | |
420| | |
421+--------------------------------------+--------------------------------------------------------+
422| **Docker images** | onap/cps-and-ncmp:3.3.4 |
423| | |
424+--------------------------------------+--------------------------------------------------------+
425| **Release designation** | 3.3.4 Montreal |
426| | |
427+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100428| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100429| | |
430+--------------------------------------+--------------------------------------------------------+
431
432Bug Fixes
433---------
4343.3.4
435
436Features
437--------
egernugdb62ffb2023-07-18 10:57:42 +0100438 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100439
danielhanrahan19f963b2023-06-15 13:52:34 +0100440Version: 3.3.3
441==============
442
443Release Data
444------------
445
446+--------------------------------------+--------------------------------------------------------+
447| **CPS Project** | |
448| | |
449+--------------------------------------+--------------------------------------------------------+
450| **Docker images** | onap/cps-and-ncmp:3.3.3 |
451| | |
452+--------------------------------------+--------------------------------------------------------+
453| **Release designation** | 3.3.3 Montreal |
454| | |
455+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100456| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100457| | |
458+--------------------------------------+--------------------------------------------------------+
459
460Bug Fixes
461---------
4623.3.3
463
464Features
465--------
mpriyank6da95412023-06-29 16:56:11 +0100466 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
467 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
468 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100469
mpriyank436b75b2023-05-03 11:10:08 +0100470Version: 3.3.2
471==============
472
473Release Data
474------------
475
476+--------------------------------------+--------------------------------------------------------+
477| **CPS Project** | |
478| | |
479+--------------------------------------+--------------------------------------------------------+
480| **Docker images** | onap/cps-and-ncmp:3.3.2 |
481| | |
482+--------------------------------------+--------------------------------------------------------+
483| **Release designation** | 3.3.2 Montreal |
484| | |
485+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100486| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100487| | |
488+--------------------------------------+--------------------------------------------------------+
489
490Bug Fixes
491---------
4923.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100493 - `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 +0100494
495Features
496--------
--globalc7e5a802023-04-05 17:08:08 +0530497 - `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 +0100498 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
499 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
500 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
501 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100502
lukegleesond7764c42023-04-20 14:11:20 +0100503Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000504==============
505
506Release Data
507------------
508
509+--------------------------------------+--------------------------------------------------------+
510| **CPS Project** | |
511| | |
512+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100513| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000514| | |
515+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100516| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000517| | |
518+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100519| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000520| | |
521+--------------------------------------+--------------------------------------------------------+
522
523Bug Fixes
524---------
lukegleesond7764c42023-04-20 14:11:20 +01005253.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000526 - None
527
528Features
529--------
mpriyank52c5e542023-05-02 15:58:55 +0100530 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
531 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
532 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
533 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
534 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000535
lukegleesond7764c42023-04-20 14:11:20 +0100536Version: 3.3.0
537==============
538
539Release Data
540------------
541
542+--------------------------------------+--------------------------------------------------------+
543| **CPS Project** | |
544| | |
545+--------------------------------------+--------------------------------------------------------+
546| **Docker images** | onap/cps-and-ncmp:3.3.0 |
547| | |
548+--------------------------------------+--------------------------------------------------------+
549| **Release designation** | 3.3.0 Montreal |
550| | |
551+--------------------------------------+--------------------------------------------------------+
552| **Release date** | 2023 April 20 |
553| | |
554+--------------------------------------+--------------------------------------------------------+
555
556Bug Fixes
557---------
5583.3.0
559 - None
560
561Features
562--------
563 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
564 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
565
566.. ======================
567.. * * * LONDON * * *
568.. ======================
569
mpriyank0fd4d192023-03-10 13:48:20 +0000570Version: 3.2.6
571==============
572
573Release Data
574------------
575
576+--------------------------------------+--------------------------------------------------------+
577| **CPS Project** | |
578| | |
579+--------------------------------------+--------------------------------------------------------+
580| **Docker images** | onap/cps-and-ncmp:3.2.6 |
581| | |
582+--------------------------------------+--------------------------------------------------------+
583| **Release designation** | 3.2.6 London |
584| | |
585+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000586| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000587| | |
588+--------------------------------------+--------------------------------------------------------+
589
590Bug Fixes
591---------
5923.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530593 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000594 - `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 +0000595
596Features
597--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000598 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000599
mpriyankade5a6e2023-03-09 17:58:31 +0000600Version: 3.2.5
601==============
602
603Release Data
604------------
605
606+--------------------------------------+--------------------------------------------------------+
607| **CPS Project** | |
608| | |
609+--------------------------------------+--------------------------------------------------------+
610| **Docker images** | onap/cps-and-ncmp:3.2.5 |
611| | |
612+--------------------------------------+--------------------------------------------------------+
613| **Release designation** | 3.2.5 London |
614| | |
615+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000616| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000617| | |
618+--------------------------------------+--------------------------------------------------------+
619
620Bug Fixes
621---------
6223.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000623 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000624
625Features
626--------
627 - None
628
seanbeirnef0f4fd82023-03-07 13:42:04 +0000629Version: 3.2.4
630==============
631
632Release Data
633------------
634
635+--------------------------------------+--------------------------------------------------------+
636| **CPS Project** | |
637| | |
638+--------------------------------------+--------------------------------------------------------+
639| **Docker images** | onap/cps-and-ncmp:3.2.4 |
640| | |
641+--------------------------------------+--------------------------------------------------------+
642| **Release designation** | 3.2.4 London |
643| | |
644+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000645| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000646| | |
647+--------------------------------------+--------------------------------------------------------+
648
649Bug Fixes
650---------
6513.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000652 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
653 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
654
655Features
656--------
657 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000658
mpriyankfd43dbe2023-02-08 11:21:08 +0000659Version: 3.2.3
660==============
661
662Release Data
663------------
664
665+--------------------------------------+--------------------------------------------------------+
666| **CPS Project** | |
667| | |
668+--------------------------------------+--------------------------------------------------------+
669| **Docker images** | onap/cps-and-ncmp:3.2.3 |
670| | |
671+--------------------------------------+--------------------------------------------------------+
672| **Release designation** | 3.2.3 London |
673| | |
674+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000675| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000676| | |
677+--------------------------------------+--------------------------------------------------------+
678
679Bug Fixes
680---------
6813.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000682 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000683
684Features
685--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000686 - `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
687 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000688
seanbeirnef8e980a2023-01-27 18:09:33 +0000689Version: 3.2.2
690==============
691
692Release Data
693------------
694
695+--------------------------------------+--------------------------------------------------------+
696| **CPS Project** | |
697| | |
698+--------------------------------------+--------------------------------------------------------+
699| **Docker images** | onap/cps-and-ncmp:3.2.2 |
700| | |
701+--------------------------------------+--------------------------------------------------------+
702| **Release designation** | 3.2.2 London |
703| | |
704+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000705| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000706| | |
707+--------------------------------------+--------------------------------------------------------+
708
709Bug Fixes
710---------
mpriyank0b5950d2023-02-07 17:55:10 +00007113.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000712 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000713
714Features
715--------
716 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000717
leventecsanyi37d72852022-10-26 10:44:08 +0200718Version: 3.2.1
719==============
mpriyank4bd450e2022-10-05 09:50:59 +0100720
721Release Data
722------------
723
724+--------------------------------------+--------------------------------------------------------+
725| **CPS Project** | |
726| | |
727+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000728| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100729| | |
730+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200731| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100732| | |
733+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000734| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100735| | |
736+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100737
lukegleeson3be99242022-10-11 14:34:56 +0100738Features
739--------
leventecsanyi37d72852022-10-26 10:44:08 +02007403.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000741 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
742 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
743 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000744 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
745 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000746 - `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 +0000747 - `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 +0000748 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000749 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000750 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000751 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
752 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
753 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100754
755Bug Fixes
756---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00007573.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000758 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
759 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
760 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
761 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
762 - `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 +0100763 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000764 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000765 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000766 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
767 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
768 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
769 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
770 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
771 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000772
leventecsanyi37d72852022-10-26 10:44:08 +02007733.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000774 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100775
lukegleeson3be99242022-10-11 14:34:56 +0100776Known Limitations, Issues and Workarounds
777-----------------------------------------
778
779*System Limitations*
780
seanbeirne72c267e2022-10-18 12:39:22 +0100781For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
782This 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 +0100783
arpitsingh2b4c4882023-03-03 21:38:57 +0530784CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
785a 400 Bad Request is sent as response. This is part of commit CPS-1526.
786
seanbeirnedba2b102022-10-27 09:59:17 +0100787.. ====================
788.. * * * KOHN * * *
789.. ====================
790
mpriyankfe775312022-09-30 14:16:51 +0100791Version: 3.1.4
792==============
793
794Release Data
795------------
796
797+--------------------------------------+--------------------------------------------------------+
798| **CPS Project** | |
799| | |
800+--------------------------------------+--------------------------------------------------------+
801| **Docker images** | onap/cps-and-ncmp:3.1.4 |
802| | |
803+--------------------------------------+--------------------------------------------------------+
804| **Release designation** | 3.1.4 Kohn |
805| | |
806+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100807| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100808| | |
809+--------------------------------------+--------------------------------------------------------+
810
811Bug Fixes
812---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100813 - `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 +0100814 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100815
mpriyank06736cb2022-09-29 14:29:40 +0100816Version: 3.1.3
817==============
818
819Release Data
820------------
821
822+--------------------------------------+--------------------------------------------------------+
823| **CPS Project** | |
824| | |
825+--------------------------------------+--------------------------------------------------------+
826| **Docker images** | onap/cps-and-ncmp:3.1.3 |
827| | |
828+--------------------------------------+--------------------------------------------------------+
829| **Release designation** | 3.1.3 Kohn |
830| | |
831+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100832| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100833| | |
834+--------------------------------------+--------------------------------------------------------+
835
836Bug Fixes
837---------
838 - None
839
mpriyankef0ddfc2022-09-28 12:19:34 +0100840Version: 3.1.2
841==============
842
843Release Data
844------------
845
846+--------------------------------------+--------------------------------------------------------+
847| **CPS Project** | |
848| | |
849+--------------------------------------+--------------------------------------------------------+
850| **Docker images** | onap/cps-and-ncmp:3.1.2 |
851| | |
852+--------------------------------------+--------------------------------------------------------+
853| **Release designation** | 3.1.2 Kohn |
854| | |
855+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100856| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100857| | |
858+--------------------------------------+--------------------------------------------------------+
859
860Bug Fixes
861---------
862 - None
863
mpriyanka3f43502022-09-26 14:57:01 +0100864Version: 3.1.1
865==============
866
867Release Data
868------------
869
870+--------------------------------------+--------------------------------------------------------+
871| **CPS Project** | |
872| | |
873+--------------------------------------+--------------------------------------------------------+
874| **Docker images** | onap/cps-and-ncmp:3.1.1 |
875| | |
876+--------------------------------------+--------------------------------------------------------+
877| **Release designation** | 3.1.1 Kohn |
878| | |
879+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100880| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100881| | |
882+--------------------------------------+--------------------------------------------------------+
883
884Bug Fixes
885---------
886 - None
887
lukegleesonc9ec9152022-09-07 14:21:36 +0100888Security Notes
889--------------
890
891*Fixed Security Issues*
892
893 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
894
lukegleeson4a34fa52022-09-19 15:31:59 +0100895Version: 3.1.0
896==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400897
898Release Data
899------------
900
DylanB95ESTb130fd32022-04-04 13:09:22 +0100901+--------------------------------------+--------------------------------------------------------+
902| **CPS Project** | |
903| | |
904+--------------------------------------+--------------------------------------------------------+
905| **Docker images** | onap/cps-and-ncmp:3.1.0 |
906| | |
907+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400908| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100909| | |
910+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100911| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100912| | |
913+--------------------------------------+--------------------------------------------------------+
914
915Features
916--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100917 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
918 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
919 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
920 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
921 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
922 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
923 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
924 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
925 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
926 - `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'
927 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
928 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
929 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
930 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
931 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
932 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
933 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
934 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
935 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
936 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
937 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
938 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
939 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
940 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
941
emacleeafb17362022-09-02 14:40:17 +0100942
943Bug Fixes
944---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100945 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
946 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
947 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
948 - `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 +0100949 - `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 +0100950 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
951 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
952 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
953 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
954 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
955 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
956 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
957 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
958 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100959
960Known Limitations, Issues and Workarounds
961-----------------------------------------
962
963*System Limitations*
964
965Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
966Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100967
lukegleeson4a34fa52022-09-19 15:31:59 +0100968*Known Vulnerabilities*
969
970None
971
972*Workarounds*
973
974None
975
976Security Notes
977--------------
978
979*Fixed Security Issues*
980
981 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
982
983*Known Security Issues*
984
985None
986
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400987.. ========================
988.. * * * JAKARTA * * *
989.. ========================
990
991Version: 3.0.1
992==============
993
994Release Data
995------------
996
997+--------------------------------------+--------------------------------------------------------+
998| **CPS Project** | |
999| | |
1000+--------------------------------------+--------------------------------------------------------+
1001| **Docker images** | onap/cps-and-ncmp:3.0.1 |
1002| | |
1003+--------------------------------------+--------------------------------------------------------+
1004| **Release designation** | 3.0.1 Jakarta |
1005| | |
1006+--------------------------------------+--------------------------------------------------------+
1007| **Release date** | 2022 April 28 |
1008| | |
1009+--------------------------------------+--------------------------------------------------------+
1010
1011Bug Fixes
1012---------
1013 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
1014
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001015Version: 3.0.0
1016==============
niamhcoref7b414e2021-11-17 11:02:07 +00001017
Bruno Sakotoa1129b62022-03-15 08:09:07 -04001018Release Data
1019------------
1020
1021+--------------------------------------+--------------------------------------------------------+
1022| **CPS Project** | |
1023| | |
1024+--------------------------------------+--------------------------------------------------------+
1025| **Docker images** | onap/cps-and-ncmp:3.0.0 |
1026| | |
1027+--------------------------------------+--------------------------------------------------------+
1028| **Release designation** | 3.0.0 Jakarta |
1029| | |
1030+--------------------------------------+--------------------------------------------------------+
1031| **Release date** | 2022 March 15 |
1032| | |
1033+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +00001034
1035Features
1036--------
puthuparambil.adityad0007332021-12-08 18:53:39 +00001037 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +00001038 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
1039 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +00001040 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +00001041 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +00001042 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +00001043 - `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 -04001044 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
1045 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +00001046 - `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 +05301047 - `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 +00001048
1049Bug Fixes
1050---------
1051
1052 - `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 +00001053 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +00001054 - `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 +00001055 - `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 +00001056 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +00001057 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +00001058 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +00001059 - `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 +05301060 - `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 +01001061 - `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 +00001062
1063Known Limitations, Issues and Workarounds
1064-----------------------------------------
1065
1066*System Limitations*
1067
DylanB95ESTe5573382022-01-27 17:12:52 +00001068Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
1069`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
1070of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +00001071
Lathishb3550f12022-03-15 12:03:53 +00001072The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
1073for more information.
1074
niamhcoref7b414e2021-11-17 11:02:07 +00001075*Known Vulnerabilities*
1076
1077None
1078
1079*Workarounds*
1080
DylanB95ESTe5573382022-01-27 17:12:52 +00001081Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
1082pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +00001083
1084Security Notes
1085--------------
1086
1087*Fixed Security Issues*
1088
1089None
1090
1091*Known Security Issues*
1092
1093None
1094
1095.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +01001096.. * * * ISTANBUL * * *
1097.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001098
Bruno Sakoto0eaf3342022-02-11 15:05:29 -05001099Version: 2.0.4
1100==============
1101
1102Release Data
1103------------
1104
1105+--------------------------------------+--------------------------------------------------------+
1106| **CPS Project** | |
1107| | |
1108+--------------------------------------+--------------------------------------------------------+
1109| **Docker images** | onap/cps-and-ncmp:2.0.4 |
1110| | |
1111+--------------------------------------+--------------------------------------------------------+
1112| **Release designation** | 2.0.4 Istanbul |
1113| | |
1114+--------------------------------------+--------------------------------------------------------+
1115| **Release date** | 2022 Feb 09 |
1116| | |
1117+--------------------------------------+--------------------------------------------------------+
1118
1119Bug Fixes
1120---------
1121
1122 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
1123 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
1124
1125Version: 2.0.3
1126==============
1127
1128Release Data
1129------------
1130
1131+--------------------------------------+--------------------------------------------------------+
1132| **CPS Project** | |
1133| | |
1134+--------------------------------------+--------------------------------------------------------+
1135| **Docker images** | onap/cps-and-ncmp:2.0.3 |
1136| | |
1137+--------------------------------------+--------------------------------------------------------+
1138| **Release designation** | 2.0.3 Istanbul |
1139| | |
1140+--------------------------------------+--------------------------------------------------------+
1141| **Release date** | 2022-07-01 |
1142| | |
1143+--------------------------------------+--------------------------------------------------------+
1144
1145Bug Fixes
1146---------
1147
1148 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
1149
1150Version: 2.0.2
1151==============
1152
1153Release Data
1154------------
1155
1156+--------------------------------------+--------------------------------------------------------+
1157| **CPS Project** | |
1158| | |
1159+--------------------------------------+--------------------------------------------------------+
1160| **Docker images** | onap/cps-and-ncmp:2.0.2 |
1161| | |
1162+--------------------------------------+--------------------------------------------------------+
1163| **Release designation** | 2.0.2 Istanbul |
1164| | |
1165+--------------------------------------+--------------------------------------------------------+
1166| **Release date** | 2021-16-12 |
1167| | |
1168+--------------------------------------+--------------------------------------------------------+
1169
1170Bug Fixes
1171---------
1172
1173 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
1174
lukegleeson9c583712021-09-30 17:21:11 +01001175Version: 2.0.1
1176==============
1177
1178Release Data
1179------------
1180
1181+--------------------------------------+--------------------------------------------------------+
1182| **CPS Project** | |
1183| | |
1184+--------------------------------------+--------------------------------------------------------+
1185| **Docker images** | onap/cps-and-ncmp:2.0.1 |
1186| | |
1187+--------------------------------------+--------------------------------------------------------+
1188| **Release designation** | 2.0.1 Istanbul |
1189| | |
1190+--------------------------------------+--------------------------------------------------------+
1191| **Release date** | 2021-14-10 |
1192| | |
1193+--------------------------------------+--------------------------------------------------------+
1194
1195Bug Fixes
1196---------
1197
1198 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1199 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1200 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1201 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1202
1203Known Limitations, Issues and Workarounds
1204-----------------------------------------
1205
1206*System Limitations*
1207
1208Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1209
1210*Known Vulnerabilities*
1211
1212 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1213
1214*Workarounds*
1215
1216Add recursive method to save list node data to loop through all corresponding child nodes.
1217
1218Security Notes
1219--------------
1220
1221*Fixed Security Issues*
1222
1223 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1224
1225*Known Security Issues*
1226
1227None
1228
shivasubedi44beaa32021-09-13 15:16:30 +01001229Version: 2.0.0
1230==============
1231
1232Abstract
1233--------
1234
1235This document provides the release notes for Istanbul release.
1236
1237Release Data
1238------------
1239
1240+--------------------------------------+--------------------------------------------------------+
1241| **CPS Project** | |
1242| | |
1243+--------------------------------------+--------------------------------------------------------+
1244| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1245| | |
1246+--------------------------------------+--------------------------------------------------------+
1247| **Release designation** | 2.0.0 Istanbul |
1248| | |
1249+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +01001250| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +01001251| | |
1252+--------------------------------------+--------------------------------------------------------+
1253
1254Features
1255--------
DylanB95EST3fcf8692021-10-11 16:29:16 +01001256* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +01001257* Update, Create and Remove CM Handles.
1258* Add support for retrieving and writing CM Handle data through NCMP datastores.
1259* Automatic retrieval and caching of model information for CM Handles within NCMP.
1260
shivasubedi44beaa32021-09-13 15:16:30 +01001261Deliverables
1262------------
1263
1264Software Deliverables
1265
1266.. csv-table::
1267 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1268 :widths: auto
1269
1270 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1271
1272Bug Fixes
1273---------
1274
lukegleeson9c583712021-09-30 17:21:11 +01001275 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001276 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1277 - `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 +01001278 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1279 - `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 +01001280 - `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 +01001281 - `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 +01001282 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1283 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001284 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1285 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1286 - `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 +01001287 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1288 - `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 +01001289 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001290 - `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 +01001291 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1292 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1293 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001294 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1295 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1296 - `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 -05001297 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001298 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1299 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1300 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001301
1302This document provides the release notes for Istanbul release.
1303
1304Summary
1305-------
1306
1307Following CPS components are available with default ONAP/CPS installation.
1308
1309
1310 * Platform components
1311
1312 - CPS (Helm charts)
1313
1314 * Service components
1315
DylanB95EST3fcf8692021-10-11 16:29:16 +01001316 - CPS-NCMP
DylanB95EST3fcf8692021-10-11 16:29:16 +01001317 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001318
1319 * Additional resources that CPS utilizes deployed using ONAP common charts
1320
1321 - Postgres Database
1322
1323
1324Below service components (mS) are available to be deployed on-demand.
1325 - CPS-TBDMT
1326
1327
1328Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1329
1330Known Limitations, Issues and Workarounds
1331-----------------------------------------
1332
shivasubedi44beaa32021-09-13 15:16:30 +01001333*System Limitations*
1334
1335Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1336
1337*Known Vulnerabilities*
1338
lukegleeson9c583712021-09-30 17:21:11 +01001339 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1340 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1341 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001342
1343*Workarounds*
1344
1345Add recursive method to save list node data to loop through all corresponding child nodes.
1346
1347Security Notes
1348--------------
1349
1350*Fixed Security Issues*
1351
1352 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001353
1354*Known Security Issues*
1355
lukegleeson9c583712021-09-30 17:21:11 +01001356 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1357
shivasubedi44beaa32021-09-13 15:16:30 +01001358Test Results
1359------------
1360 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001361
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001362.. ========================
1363.. * * * HONOLULU * * *
1364.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001365
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001366Version: 1.0.1
1367==============
1368
1369Release Data
1370------------
1371
1372+--------------------------------------+--------------------------------------------------------+
1373| **CPS Project** | |
1374| | |
1375+--------------------------------------+--------------------------------------------------------+
1376| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1377| | |
1378+--------------------------------------+--------------------------------------------------------+
1379| **Release designation** | 1.0.1 Honolulu |
1380| | |
1381+--------------------------------------+--------------------------------------------------------+
1382| **Release date** | 2021-04-09 |
1383| | |
1384+--------------------------------------+--------------------------------------------------------+
1385
1386Bug Fixes
1387---------
1388
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001389 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001390 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1391 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1392 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1393 - `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
1394 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1395 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1396 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1397
1398Security Notes
1399--------------
1400
1401*Fixed Security Issues*
1402
1403 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001404
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001405*Known Security Issues*
1406
1407 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1408
Rishi.Chail4359d282021-03-03 16:36:26 +00001409Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001410==============
1411
1412
1413Abstract
1414--------
1415
1416This document provides the release notes for Honolulu release.
1417
1418Summary
1419-------
1420
1421Following CPS components are available with default ONAP/CPS installation.
1422
1423
Rishi.Chail4359d282021-03-03 16:36:26 +00001424 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001425
Rishi.Chail4359d282021-03-03 16:36:26 +00001426 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001427
Rishi.Chail4359d282021-03-03 16:36:26 +00001428 * Service components
1429
1430 - CPS Core
1431
1432 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001433
1434 - Postgres Database
1435
1436
Rishi.Chail4359d282021-03-03 16:36:26 +00001437Below service components (mS) are available to be deployed on-demand.
1438 - CPS-TBDMT
1439
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001440
1441Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1442
1443
1444Release Data
1445------------
1446
1447+--------------------------------------+--------------------------------------------------------+
1448| **CPS Project** | |
1449| | |
1450+--------------------------------------+--------------------------------------------------------+
1451| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1452| | |
1453+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001454| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001455| | |
1456+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001457| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001458| | |
1459+--------------------------------------+--------------------------------------------------------+
1460
1461
1462Features
1463--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001464Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1465CPS has been driven by the needs of the E2E Networking Slicing use case.
1466It currently supports basic (rw) persistence and simple queries.
1467It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001468
1469.. _honolulu_deliverable:
1470
1471Deliverables
1472------------
1473
1474Software Deliverables
1475
1476.. csv-table::
1477 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1478 :widths: auto
1479
Rishi.Chail4359d282021-03-03 16:36:26 +00001480 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001481
1482
1483Known Limitations, Issues and Workarounds
1484-----------------------------------------
1485
Rishi.Chail4359d282021-03-03 16:36:26 +00001486 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1487 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1488 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001489 - `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 +00001490
1491*System Limitations*
1492
1493None
1494
1495*Known Vulnerabilities*
1496
1497None
1498
1499*Workarounds*
1500
1501Documented under corresponding jira if applicable.
1502
1503Security Notes
1504--------------
1505
1506*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001507
1508* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001509 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001510 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001511 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001512
1513*Known Security Issues*
1514
ToineSiebelink74eed2c2023-08-31 17:38:52 +01001515 * Weak Cryptography using md5
Rishi.Chail4359d282021-03-03 16:36:26 +00001516 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001517
1518*Known Vulnerabilities in Used Modules*
1519
Rishi.Chail4359d282021-03-03 16:36:26 +00001520 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001521
Rishi.Chail4359d282021-03-03 16:36:26 +00001522CPS 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 +00001523
1524Test Results
1525------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001526 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001527
1528References
1529----------
1530
ToineSiebelinkcac21862023-06-22 09:24:04 +01001531For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001532
1533#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001534#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001535#. `ONAP Documentation`_
1536#. `ONAP CPS Documentation`_
1537#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001538
1539
1540.. _`ONAP Home Page`: https://www.onap.org
1541.. _`ONAP Wiki Page`: https://wiki.onap.org
1542.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001543.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001544.. _`ONAP Release Downloads`: https://git.onap.org
1545
1546Quick Links:
1547
1548 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1549 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_