blob: d891162c3265fad74958e265d316918c98af9e57 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
lukegleesone0154a62023-01-25 15:06:52 +00003.. Copyright (C) 2021-2023 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +00004
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00008CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -04009#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +000010
11.. contents::
12 :depth: 2
13..
14
lukegleesond7764c42023-04-20 14:11:20 +010015.. ========================
16.. * * * MONTREAL * * *
17.. ========================
niamhcoref7b414e2021-11-17 11:02:07 +000018
egernugd91a7072023-09-29 12:12:36 +010019Version: 3.3.9
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.9 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.9 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.9
42
43Features
44--------
45
danielhanrahan56384d12023-09-20 17:10:40 +010046Version: 3.3.8
47==============
48
49Release Data
50------------
51
52+--------------------------------------+--------------------------------------------------------+
53| **CPS Project** | |
54| | |
55+--------------------------------------+--------------------------------------------------------+
56| **Docker images** | onap/cps-and-ncmp:3.3.8 |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Release designation** | 3.3.8 Montreal |
60| | |
61+--------------------------------------+--------------------------------------------------------+
egernugd91a7072023-09-29 12:12:36 +010062| **Release date** | 2023 September 29 |
danielhanrahan56384d12023-09-20 17:10:40 +010063| | |
64+--------------------------------------+--------------------------------------------------------+
65
66Bug Fixes
67---------
683.3.8
69
70Features
71--------
egernugcb9d1502023-09-28 09:57:44 +010072 - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
danielhanrahan56384d12023-09-20 17:10:40 +010073
leventecsanyid35ad5c2023-08-23 15:55:30 +020074Version: 3.3.7
75==============
76
77Release Data
78------------
79
80+--------------------------------------+--------------------------------------------------------+
81| **CPS Project** | |
82| | |
83+--------------------------------------+--------------------------------------------------------+
84| **Docker images** | onap/cps-and-ncmp:3.3.7 |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Release designation** | 3.3.7 Montreal |
88| | |
89+--------------------------------------+--------------------------------------------------------+
danielhanrahan56384d12023-09-20 17:10:40 +010090| **Release date** | 2023 September 20 |
leventecsanyid35ad5c2023-08-23 15:55:30 +020091| | |
92+--------------------------------------+--------------------------------------------------------+
93
94Bug Fixes
95---------
963.3.7
danielhanrahanefc55772023-09-15 12:02:35 +010097 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +020098
99Features
100--------
egernugcb9d1502023-09-28 09:57:44 +0100101 - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
egernug60a780c2023-09-19 15:26:42 +0100102
103Note
104----
105Migrating 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 +0200106
egernugbdac4402023-07-21 13:27:24 +0100107Version: 3.3.6
108==============
109
110Release Data
111------------
112
113+--------------------------------------+--------------------------------------------------------+
114| **CPS Project** | |
115| | |
116+--------------------------------------+--------------------------------------------------------+
117| **Docker images** | onap/cps-and-ncmp:3.3.6 |
118| | |
119+--------------------------------------+--------------------------------------------------------+
120| **Release designation** | 3.3.6 Montreal |
121| | |
122+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +0200123| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +0100124| | |
125+--------------------------------------+--------------------------------------------------------+
126
127Bug Fixes
128---------
1293.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +0100130 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +0100131 - `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 +0100132
133Features
134--------
danielhanrahan92705462023-05-18 10:18:10 +0100135 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +0100136 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +0100137
138
egernug6c9621a2023-07-19 11:05:00 +0100139Version: 3.3.5
140==============
141
142Release Data
143------------
144
145+--------------------------------------+--------------------------------------------------------+
146| **CPS Project** | |
147| | |
148+--------------------------------------+--------------------------------------------------------+
149| **Docker images** | onap/cps-and-ncmp:3.3.5 |
150| | |
151+--------------------------------------+--------------------------------------------------------+
152| **Release designation** | 3.3.5 Montreal |
153| | |
154+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +0100155| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +0100156| | |
157+--------------------------------------+--------------------------------------------------------+
158
159Bug Fixes
160---------
1613.3.5
162
163Features
164--------
danielhanrahan74a47152023-06-28 12:55:20 +0100165 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100166
mpriyank8caa3422023-06-30 11:14:10 +0100167Version: 3.3.4
168==============
169
170Release Data
171------------
172
173+--------------------------------------+--------------------------------------------------------+
174| **CPS Project** | |
175| | |
176+--------------------------------------+--------------------------------------------------------+
177| **Docker images** | onap/cps-and-ncmp:3.3.4 |
178| | |
179+--------------------------------------+--------------------------------------------------------+
180| **Release designation** | 3.3.4 Montreal |
181| | |
182+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100183| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100184| | |
185+--------------------------------------+--------------------------------------------------------+
186
187Bug Fixes
188---------
1893.3.4
190
191Features
192--------
egernugdb62ffb2023-07-18 10:57:42 +0100193 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100194
danielhanrahan19f963b2023-06-15 13:52:34 +0100195Version: 3.3.3
196==============
197
198Release Data
199------------
200
201+--------------------------------------+--------------------------------------------------------+
202| **CPS Project** | |
203| | |
204+--------------------------------------+--------------------------------------------------------+
205| **Docker images** | onap/cps-and-ncmp:3.3.3 |
206| | |
207+--------------------------------------+--------------------------------------------------------+
208| **Release designation** | 3.3.3 Montreal |
209| | |
210+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100211| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100212| | |
213+--------------------------------------+--------------------------------------------------------+
214
215Bug Fixes
216---------
2173.3.3
218
219Features
220--------
mpriyank6da95412023-06-29 16:56:11 +0100221 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
222 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
223 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100224
mpriyank436b75b2023-05-03 11:10:08 +0100225Version: 3.3.2
226==============
227
228Release Data
229------------
230
231+--------------------------------------+--------------------------------------------------------+
232| **CPS Project** | |
233| | |
234+--------------------------------------+--------------------------------------------------------+
235| **Docker images** | onap/cps-and-ncmp:3.3.2 |
236| | |
237+--------------------------------------+--------------------------------------------------------+
238| **Release designation** | 3.3.2 Montreal |
239| | |
240+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100241| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100242| | |
243+--------------------------------------+--------------------------------------------------------+
244
245Bug Fixes
246---------
2473.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100248 - `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 +0100249
250Features
251--------
--globalc7e5a802023-04-05 17:08:08 +0530252 - `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 +0100253 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
254 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
255 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
256 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100257
lukegleesond7764c42023-04-20 14:11:20 +0100258Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000259==============
260
261Release Data
262------------
263
264+--------------------------------------+--------------------------------------------------------+
265| **CPS Project** | |
266| | |
267+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100268| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000269| | |
270+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100271| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000272| | |
273+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100274| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000275| | |
276+--------------------------------------+--------------------------------------------------------+
277
278Bug Fixes
279---------
lukegleesond7764c42023-04-20 14:11:20 +01002803.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000281 - None
282
283Features
284--------
mpriyank52c5e542023-05-02 15:58:55 +0100285 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
286 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
287 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
288 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
289 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000290
lukegleesond7764c42023-04-20 14:11:20 +0100291Version: 3.3.0
292==============
293
294Release Data
295------------
296
297+--------------------------------------+--------------------------------------------------------+
298| **CPS Project** | |
299| | |
300+--------------------------------------+--------------------------------------------------------+
301| **Docker images** | onap/cps-and-ncmp:3.3.0 |
302| | |
303+--------------------------------------+--------------------------------------------------------+
304| **Release designation** | 3.3.0 Montreal |
305| | |
306+--------------------------------------+--------------------------------------------------------+
307| **Release date** | 2023 April 20 |
308| | |
309+--------------------------------------+--------------------------------------------------------+
310
311Bug Fixes
312---------
3133.3.0
314 - None
315
316Features
317--------
318 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
319 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
320
321.. ======================
322.. * * * LONDON * * *
323.. ======================
324
mpriyank0fd4d192023-03-10 13:48:20 +0000325Version: 3.2.6
326==============
327
328Release Data
329------------
330
331+--------------------------------------+--------------------------------------------------------+
332| **CPS Project** | |
333| | |
334+--------------------------------------+--------------------------------------------------------+
335| **Docker images** | onap/cps-and-ncmp:3.2.6 |
336| | |
337+--------------------------------------+--------------------------------------------------------+
338| **Release designation** | 3.2.6 London |
339| | |
340+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000341| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000342| | |
343+--------------------------------------+--------------------------------------------------------+
344
345Bug Fixes
346---------
3473.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530348 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000349 - `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 +0000350
351Features
352--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000353 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000354
mpriyankade5a6e2023-03-09 17:58:31 +0000355Version: 3.2.5
356==============
357
358Release Data
359------------
360
361+--------------------------------------+--------------------------------------------------------+
362| **CPS Project** | |
363| | |
364+--------------------------------------+--------------------------------------------------------+
365| **Docker images** | onap/cps-and-ncmp:3.2.5 |
366| | |
367+--------------------------------------+--------------------------------------------------------+
368| **Release designation** | 3.2.5 London |
369| | |
370+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000371| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000372| | |
373+--------------------------------------+--------------------------------------------------------+
374
375Bug Fixes
376---------
3773.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000378 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000379
380Features
381--------
382 - None
383
seanbeirnef0f4fd82023-03-07 13:42:04 +0000384Version: 3.2.4
385==============
386
387Release Data
388------------
389
390+--------------------------------------+--------------------------------------------------------+
391| **CPS Project** | |
392| | |
393+--------------------------------------+--------------------------------------------------------+
394| **Docker images** | onap/cps-and-ncmp:3.2.4 |
395| | |
396+--------------------------------------+--------------------------------------------------------+
397| **Release designation** | 3.2.4 London |
398| | |
399+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000400| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000401| | |
402+--------------------------------------+--------------------------------------------------------+
403
404Bug Fixes
405---------
4063.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000407 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
408 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
409
410Features
411--------
412 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000413
mpriyankfd43dbe2023-02-08 11:21:08 +0000414Version: 3.2.3
415==============
416
417Release Data
418------------
419
420+--------------------------------------+--------------------------------------------------------+
421| **CPS Project** | |
422| | |
423+--------------------------------------+--------------------------------------------------------+
424| **Docker images** | onap/cps-and-ncmp:3.2.3 |
425| | |
426+--------------------------------------+--------------------------------------------------------+
427| **Release designation** | 3.2.3 London |
428| | |
429+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000430| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000431| | |
432+--------------------------------------+--------------------------------------------------------+
433
434Bug Fixes
435---------
4363.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000437 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000438
439Features
440--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000441 - `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
442 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000443
seanbeirnef8e980a2023-01-27 18:09:33 +0000444Version: 3.2.2
445==============
446
447Release Data
448------------
449
450+--------------------------------------+--------------------------------------------------------+
451| **CPS Project** | |
452| | |
453+--------------------------------------+--------------------------------------------------------+
454| **Docker images** | onap/cps-and-ncmp:3.2.2 |
455| | |
456+--------------------------------------+--------------------------------------------------------+
457| **Release designation** | 3.2.2 London |
458| | |
459+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000460| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000461| | |
462+--------------------------------------+--------------------------------------------------------+
463
464Bug Fixes
465---------
mpriyank0b5950d2023-02-07 17:55:10 +00004663.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000467 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000468
469Features
470--------
471 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000472
leventecsanyi37d72852022-10-26 10:44:08 +0200473Version: 3.2.1
474==============
mpriyank4bd450e2022-10-05 09:50:59 +0100475
476Release Data
477------------
478
479+--------------------------------------+--------------------------------------------------------+
480| **CPS Project** | |
481| | |
482+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000483| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100484| | |
485+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200486| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100487| | |
488+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000489| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100490| | |
491+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100492
lukegleeson3be99242022-10-11 14:34:56 +0100493Features
494--------
leventecsanyi37d72852022-10-26 10:44:08 +02004953.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000496 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
497 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
498 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000499 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
500 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000501 - `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 +0000502 - `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 +0000503 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000504 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000505 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000506 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
507 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
508 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100509
510Bug Fixes
511---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00005123.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000513 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
514 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
515 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
516 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
517 - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_ Top level container (prefix) is not always the first module
ToineSiebelink294bcb52022-12-23 11:07:42 +0000518 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000519 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000520 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000521 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
522 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
523 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
524 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
525 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
526 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000527
leventecsanyi37d72852022-10-26 10:44:08 +02005283.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000529 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100530
lukegleeson3be99242022-10-11 14:34:56 +0100531Known Limitations, Issues and Workarounds
532-----------------------------------------
533
534*System Limitations*
535
seanbeirne72c267e2022-10-18 12:39:22 +0100536For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
537This 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 +0100538
arpitsingh2b4c4882023-03-03 21:38:57 +0530539CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
540a 400 Bad Request is sent as response. This is part of commit CPS-1526.
541
seanbeirnedba2b102022-10-27 09:59:17 +0100542.. ====================
543.. * * * KOHN * * *
544.. ====================
545
mpriyankfe775312022-09-30 14:16:51 +0100546Version: 3.1.4
547==============
548
549Release Data
550------------
551
552+--------------------------------------+--------------------------------------------------------+
553| **CPS Project** | |
554| | |
555+--------------------------------------+--------------------------------------------------------+
556| **Docker images** | onap/cps-and-ncmp:3.1.4 |
557| | |
558+--------------------------------------+--------------------------------------------------------+
559| **Release designation** | 3.1.4 Kohn |
560| | |
561+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100562| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100563| | |
564+--------------------------------------+--------------------------------------------------------+
565
566Bug Fixes
567---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100568 - `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 +0100569 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100570
mpriyank06736cb2022-09-29 14:29:40 +0100571Version: 3.1.3
572==============
573
574Release Data
575------------
576
577+--------------------------------------+--------------------------------------------------------+
578| **CPS Project** | |
579| | |
580+--------------------------------------+--------------------------------------------------------+
581| **Docker images** | onap/cps-and-ncmp:3.1.3 |
582| | |
583+--------------------------------------+--------------------------------------------------------+
584| **Release designation** | 3.1.3 Kohn |
585| | |
586+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100587| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100588| | |
589+--------------------------------------+--------------------------------------------------------+
590
591Bug Fixes
592---------
593 - None
594
mpriyankef0ddfc2022-09-28 12:19:34 +0100595Version: 3.1.2
596==============
597
598Release Data
599------------
600
601+--------------------------------------+--------------------------------------------------------+
602| **CPS Project** | |
603| | |
604+--------------------------------------+--------------------------------------------------------+
605| **Docker images** | onap/cps-and-ncmp:3.1.2 |
606| | |
607+--------------------------------------+--------------------------------------------------------+
608| **Release designation** | 3.1.2 Kohn |
609| | |
610+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100611| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100612| | |
613+--------------------------------------+--------------------------------------------------------+
614
615Bug Fixes
616---------
617 - None
618
mpriyanka3f43502022-09-26 14:57:01 +0100619Version: 3.1.1
620==============
621
622Release Data
623------------
624
625+--------------------------------------+--------------------------------------------------------+
626| **CPS Project** | |
627| | |
628+--------------------------------------+--------------------------------------------------------+
629| **Docker images** | onap/cps-and-ncmp:3.1.1 |
630| | |
631+--------------------------------------+--------------------------------------------------------+
632| **Release designation** | 3.1.1 Kohn |
633| | |
634+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100635| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100636| | |
637+--------------------------------------+--------------------------------------------------------+
638
639Bug Fixes
640---------
641 - None
642
lukegleesonc9ec9152022-09-07 14:21:36 +0100643Security Notes
644--------------
645
646*Fixed Security Issues*
647
648 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
649
lukegleeson4a34fa52022-09-19 15:31:59 +0100650Version: 3.1.0
651==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400652
653Release Data
654------------
655
DylanB95ESTb130fd32022-04-04 13:09:22 +0100656+--------------------------------------+--------------------------------------------------------+
657| **CPS Project** | |
658| | |
659+--------------------------------------+--------------------------------------------------------+
660| **Docker images** | onap/cps-and-ncmp:3.1.0 |
661| | |
662+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400663| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100664| | |
665+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100666| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100667| | |
668+--------------------------------------+--------------------------------------------------------+
669
670Features
671--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100672 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
673 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
674 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
675 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
676 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
677 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
678 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
679 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
680 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
681 - `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'
682 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
683 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
684 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
685 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
686 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
687 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
688 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
689 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
690 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
691 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
692 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
693 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
694 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
695 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
696
emacleeafb17362022-09-02 14:40:17 +0100697
698Bug Fixes
699---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100700 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
701 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
702 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
703 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
704 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
705 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
706 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
707 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
708 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
709 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
710 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
711 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
712 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
713 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100714
715Known Limitations, Issues and Workarounds
716-----------------------------------------
717
718*System Limitations*
719
720Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
721Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100722
lukegleeson4a34fa52022-09-19 15:31:59 +0100723*Known Vulnerabilities*
724
725None
726
727*Workarounds*
728
729None
730
731Security Notes
732--------------
733
734*Fixed Security Issues*
735
736 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
737
738*Known Security Issues*
739
740None
741
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400742.. ========================
743.. * * * JAKARTA * * *
744.. ========================
745
746Version: 3.0.1
747==============
748
749Release Data
750------------
751
752+--------------------------------------+--------------------------------------------------------+
753| **CPS Project** | |
754| | |
755+--------------------------------------+--------------------------------------------------------+
756| **Docker images** | onap/cps-and-ncmp:3.0.1 |
757| | |
758+--------------------------------------+--------------------------------------------------------+
759| **Release designation** | 3.0.1 Jakarta |
760| | |
761+--------------------------------------+--------------------------------------------------------+
762| **Release date** | 2022 April 28 |
763| | |
764+--------------------------------------+--------------------------------------------------------+
765
766Bug Fixes
767---------
768 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
769
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400770Version: 3.0.0
771==============
niamhcoref7b414e2021-11-17 11:02:07 +0000772
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400773Release Data
774------------
775
776+--------------------------------------+--------------------------------------------------------+
777| **CPS Project** | |
778| | |
779+--------------------------------------+--------------------------------------------------------+
780| **Docker images** | onap/cps-and-ncmp:3.0.0 |
781| | |
782+--------------------------------------+--------------------------------------------------------+
783| **Release designation** | 3.0.0 Jakarta |
784| | |
785+--------------------------------------+--------------------------------------------------------+
786| **Release date** | 2022 March 15 |
787| | |
788+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000789
790Features
791--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000792 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000793 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
794 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000795 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000796 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000797 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000798 - `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 -0400799 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
800 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000801 - `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 +0530802 - `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 +0000803
804Bug Fixes
805---------
806
807 - `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 +0000808 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000809 - `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 +0000810 - `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 +0000811 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000812 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000813 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000814 - `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 +0530815 - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
DylanB95ESTe5573382022-01-27 17:12:52 +0000816 - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
niamhcoref7b414e2021-11-17 11:02:07 +0000817
818Known Limitations, Issues and Workarounds
819-----------------------------------------
820
821*System Limitations*
822
DylanB95ESTe5573382022-01-27 17:12:52 +0000823Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
824`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
825of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000826
Lathishb3550f12022-03-15 12:03:53 +0000827The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
828for more information.
829
niamhcoref7b414e2021-11-17 11:02:07 +0000830*Known Vulnerabilities*
831
832None
833
834*Workarounds*
835
DylanB95ESTe5573382022-01-27 17:12:52 +0000836Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
837pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000838
839Security Notes
840--------------
841
842*Fixed Security Issues*
843
844None
845
846*Known Security Issues*
847
848None
849
850.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100851.. * * * ISTANBUL * * *
852.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000853
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500854Version: 2.0.4
855==============
856
857Release Data
858------------
859
860+--------------------------------------+--------------------------------------------------------+
861| **CPS Project** | |
862| | |
863+--------------------------------------+--------------------------------------------------------+
864| **Docker images** | onap/cps-and-ncmp:2.0.4 |
865| | |
866+--------------------------------------+--------------------------------------------------------+
867| **Release designation** | 2.0.4 Istanbul |
868| | |
869+--------------------------------------+--------------------------------------------------------+
870| **Release date** | 2022 Feb 09 |
871| | |
872+--------------------------------------+--------------------------------------------------------+
873
874Bug Fixes
875---------
876
877 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
878 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
879
880Version: 2.0.3
881==============
882
883Release Data
884------------
885
886+--------------------------------------+--------------------------------------------------------+
887| **CPS Project** | |
888| | |
889+--------------------------------------+--------------------------------------------------------+
890| **Docker images** | onap/cps-and-ncmp:2.0.3 |
891| | |
892+--------------------------------------+--------------------------------------------------------+
893| **Release designation** | 2.0.3 Istanbul |
894| | |
895+--------------------------------------+--------------------------------------------------------+
896| **Release date** | 2022-07-01 |
897| | |
898+--------------------------------------+--------------------------------------------------------+
899
900Bug Fixes
901---------
902
903 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
904
905Version: 2.0.2
906==============
907
908Release Data
909------------
910
911+--------------------------------------+--------------------------------------------------------+
912| **CPS Project** | |
913| | |
914+--------------------------------------+--------------------------------------------------------+
915| **Docker images** | onap/cps-and-ncmp:2.0.2 |
916| | |
917+--------------------------------------+--------------------------------------------------------+
918| **Release designation** | 2.0.2 Istanbul |
919| | |
920+--------------------------------------+--------------------------------------------------------+
921| **Release date** | 2021-16-12 |
922| | |
923+--------------------------------------+--------------------------------------------------------+
924
925Bug Fixes
926---------
927
928 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
929
lukegleeson9c583712021-09-30 17:21:11 +0100930Version: 2.0.1
931==============
932
933Release Data
934------------
935
936+--------------------------------------+--------------------------------------------------------+
937| **CPS Project** | |
938| | |
939+--------------------------------------+--------------------------------------------------------+
940| **Docker images** | onap/cps-and-ncmp:2.0.1 |
941| | |
942+--------------------------------------+--------------------------------------------------------+
943| **Release designation** | 2.0.1 Istanbul |
944| | |
945+--------------------------------------+--------------------------------------------------------+
946| **Release date** | 2021-14-10 |
947| | |
948+--------------------------------------+--------------------------------------------------------+
949
950Bug Fixes
951---------
952
953 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
954 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
955 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
956 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
957
958Known Limitations, Issues and Workarounds
959-----------------------------------------
960
961*System Limitations*
962
963Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
964
965*Known Vulnerabilities*
966
967 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
968
969*Workarounds*
970
971Add recursive method to save list node data to loop through all corresponding child nodes.
972
973Security Notes
974--------------
975
976*Fixed Security Issues*
977
978 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
979
980*Known Security Issues*
981
982None
983
shivasubedi44beaa32021-09-13 15:16:30 +0100984Version: 2.0.0
985==============
986
987Abstract
988--------
989
990This document provides the release notes for Istanbul release.
991
992Release Data
993------------
994
995+--------------------------------------+--------------------------------------------------------+
996| **CPS Project** | |
997| | |
998+--------------------------------------+--------------------------------------------------------+
999| **Docker images** | onap/cps-and-ncmp:2.0.0 |
1000| | |
1001+--------------------------------------+--------------------------------------------------------+
1002| **Release designation** | 2.0.0 Istanbul |
1003| | |
1004+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +01001005| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +01001006| | |
1007+--------------------------------------+--------------------------------------------------------+
1008
1009Features
1010--------
DylanB95EST3fcf8692021-10-11 16:29:16 +01001011* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +01001012* Update, Create and Remove CM Handles.
1013* Add support for retrieving and writing CM Handle data through NCMP datastores.
1014* Automatic retrieval and caching of model information for CM Handles within NCMP.
1015
shivasubedi44beaa32021-09-13 15:16:30 +01001016Deliverables
1017------------
1018
1019Software Deliverables
1020
1021.. csv-table::
1022 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1023 :widths: auto
1024
1025 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1026
1027Bug Fixes
1028---------
1029
lukegleeson9c583712021-09-30 17:21:11 +01001030 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +01001031 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1032 - `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 +01001033 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1034 - `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 +01001035 - `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 +01001036 - `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 +01001037 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1038 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +01001039 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1040 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1041 - `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 +01001042 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1043 - `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 +01001044 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +01001045 - `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 +01001046 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1047 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1048 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +01001049 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1050 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1051 - `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 -05001052 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +01001053 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1054 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1055 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +01001056
1057This document provides the release notes for Istanbul release.
1058
1059Summary
1060-------
1061
1062Following CPS components are available with default ONAP/CPS installation.
1063
1064
1065 * Platform components
1066
1067 - CPS (Helm charts)
1068
1069 * Service components
1070
DylanB95EST3fcf8692021-10-11 16:29:16 +01001071 - CPS-NCMP
1072 - CPS-Temporal
1073 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001074
1075 * Additional resources that CPS utilizes deployed using ONAP common charts
1076
1077 - Postgres Database
1078
1079
1080Below service components (mS) are available to be deployed on-demand.
1081 - CPS-TBDMT
1082
1083
1084Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1085
1086Known Limitations, Issues and Workarounds
1087-----------------------------------------
1088
shivasubedi44beaa32021-09-13 15:16:30 +01001089*System Limitations*
1090
1091Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1092
1093*Known Vulnerabilities*
1094
lukegleeson9c583712021-09-30 17:21:11 +01001095 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1096 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1097 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001098
1099*Workarounds*
1100
1101Add recursive method to save list node data to loop through all corresponding child nodes.
1102
1103Security Notes
1104--------------
1105
1106*Fixed Security Issues*
1107
1108 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001109
1110*Known Security Issues*
1111
lukegleeson9c583712021-09-30 17:21:11 +01001112 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1113
shivasubedi44beaa32021-09-13 15:16:30 +01001114Test Results
1115------------
1116 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001117
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001118.. ========================
1119.. * * * HONOLULU * * *
1120.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001121
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001122Version: 1.0.1
1123==============
1124
1125Release Data
1126------------
1127
1128+--------------------------------------+--------------------------------------------------------+
1129| **CPS Project** | |
1130| | |
1131+--------------------------------------+--------------------------------------------------------+
1132| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1133| | |
1134+--------------------------------------+--------------------------------------------------------+
1135| **Release designation** | 1.0.1 Honolulu |
1136| | |
1137+--------------------------------------+--------------------------------------------------------+
1138| **Release date** | 2021-04-09 |
1139| | |
1140+--------------------------------------+--------------------------------------------------------+
1141
1142Bug Fixes
1143---------
1144
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001145 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001146 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1147 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1148 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1149 - `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
1150 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1151 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1152 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1153
1154Security Notes
1155--------------
1156
1157*Fixed Security Issues*
1158
1159 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001160
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001161*Known Security Issues*
1162
1163 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1164
Rishi.Chail4359d282021-03-03 16:36:26 +00001165Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001166==============
1167
1168
1169Abstract
1170--------
1171
1172This document provides the release notes for Honolulu release.
1173
1174Summary
1175-------
1176
1177Following CPS components are available with default ONAP/CPS installation.
1178
1179
Rishi.Chail4359d282021-03-03 16:36:26 +00001180 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001181
Rishi.Chail4359d282021-03-03 16:36:26 +00001182 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001183
Rishi.Chail4359d282021-03-03 16:36:26 +00001184 * Service components
1185
1186 - CPS Core
1187
1188 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001189
1190 - Postgres Database
1191
1192
Rishi.Chail4359d282021-03-03 16:36:26 +00001193Below service components (mS) are available to be deployed on-demand.
1194 - CPS-TBDMT
1195
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001196
1197Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1198
1199
1200Release Data
1201------------
1202
1203+--------------------------------------+--------------------------------------------------------+
1204| **CPS Project** | |
1205| | |
1206+--------------------------------------+--------------------------------------------------------+
1207| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1208| | |
1209+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001210| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001211| | |
1212+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001213| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001214| | |
1215+--------------------------------------+--------------------------------------------------------+
1216
1217
1218Features
1219--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001220Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1221CPS has been driven by the needs of the E2E Networking Slicing use case.
1222It currently supports basic (rw) persistence and simple queries.
1223It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001224
1225.. _honolulu_deliverable:
1226
1227Deliverables
1228------------
1229
1230Software Deliverables
1231
1232.. csv-table::
1233 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1234 :widths: auto
1235
Rishi.Chail4359d282021-03-03 16:36:26 +00001236 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001237
1238
1239Known Limitations, Issues and Workarounds
1240-----------------------------------------
1241
Rishi.Chail4359d282021-03-03 16:36:26 +00001242 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1243 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1244 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001245 - `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 +00001246
1247*System Limitations*
1248
1249None
1250
1251*Known Vulnerabilities*
1252
1253None
1254
1255*Workarounds*
1256
1257Documented under corresponding jira if applicable.
1258
1259Security Notes
1260--------------
1261
1262*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001263
1264* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001265 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001266 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001267 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001268
1269*Known Security Issues*
1270
Rishi.Chail4359d282021-03-03 16:36:26 +00001271 * Weak Crytography using md5
1272 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001273
1274*Known Vulnerabilities in Used Modules*
1275
Rishi.Chail4359d282021-03-03 16:36:26 +00001276 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001277
Rishi.Chail4359d282021-03-03 16:36:26 +00001278CPS 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 +00001279
1280Test Results
1281------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001282 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001283
1284References
1285----------
1286
ToineSiebelinkcac21862023-06-22 09:24:04 +01001287For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001288
1289#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001290#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001291#. `ONAP Documentation`_
1292#. `ONAP CPS Documentation`_
1293#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001294
1295
1296.. _`ONAP Home Page`: https://www.onap.org
1297.. _`ONAP Wiki Page`: https://wiki.onap.org
1298.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001299.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001300.. _`ONAP Release Downloads`: https://git.onap.org
1301
1302Quick Links:
1303
1304 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1305 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_