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