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