blob: 013617a815cc5bcfcc08a54066dfde61040c867c [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
leventecsanyid35ad5c2023-08-23 15:55:30 +020019Version: 3.3.7
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.7 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.7 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.7
42
43Features
44--------
45
egernugbdac4402023-07-21 13:27:24 +010046Version: 3.3.6
47==============
48
49Release Data
50------------
51
52+--------------------------------------+--------------------------------------------------------+
53| **CPS Project** | |
54| | |
55+--------------------------------------+--------------------------------------------------------+
56| **Docker images** | onap/cps-and-ncmp:3.3.6 |
57| | |
58+--------------------------------------+--------------------------------------------------------+
59| **Release designation** | 3.3.6 Montreal |
60| | |
61+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +020062| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +010063| | |
64+--------------------------------------+--------------------------------------------------------+
65
66Bug Fixes
67---------
683.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +010069 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +010070 - `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 +010071
72Features
73--------
danielhanrahan92705462023-05-18 10:18:10 +010074 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +010075 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +010076
77
egernug6c9621a2023-07-19 11:05:00 +010078Version: 3.3.5
79==============
80
81Release Data
82------------
83
84+--------------------------------------+--------------------------------------------------------+
85| **CPS Project** | |
86| | |
87+--------------------------------------+--------------------------------------------------------+
88| **Docker images** | onap/cps-and-ncmp:3.3.5 |
89| | |
90+--------------------------------------+--------------------------------------------------------+
91| **Release designation** | 3.3.5 Montreal |
92| | |
93+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +010094| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +010095| | |
96+--------------------------------------+--------------------------------------------------------+
97
98Bug Fixes
99---------
1003.3.5
101
102Features
103--------
danielhanrahan74a47152023-06-28 12:55:20 +0100104 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100105
mpriyank8caa3422023-06-30 11:14:10 +0100106Version: 3.3.4
107==============
108
109Release Data
110------------
111
112+--------------------------------------+--------------------------------------------------------+
113| **CPS Project** | |
114| | |
115+--------------------------------------+--------------------------------------------------------+
116| **Docker images** | onap/cps-and-ncmp:3.3.4 |
117| | |
118+--------------------------------------+--------------------------------------------------------+
119| **Release designation** | 3.3.4 Montreal |
120| | |
121+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100122| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100123| | |
124+--------------------------------------+--------------------------------------------------------+
125
126Bug Fixes
127---------
1283.3.4
129
130Features
131--------
egernugdb62ffb2023-07-18 10:57:42 +0100132 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100133
danielhanrahan19f963b2023-06-15 13:52:34 +0100134Version: 3.3.3
135==============
136
137Release Data
138------------
139
140+--------------------------------------+--------------------------------------------------------+
141| **CPS Project** | |
142| | |
143+--------------------------------------+--------------------------------------------------------+
144| **Docker images** | onap/cps-and-ncmp:3.3.3 |
145| | |
146+--------------------------------------+--------------------------------------------------------+
147| **Release designation** | 3.3.3 Montreal |
148| | |
149+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100150| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100151| | |
152+--------------------------------------+--------------------------------------------------------+
153
154Bug Fixes
155---------
1563.3.3
157
158Features
159--------
mpriyank6da95412023-06-29 16:56:11 +0100160 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
161 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
162 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100163
mpriyank436b75b2023-05-03 11:10:08 +0100164Version: 3.3.2
165==============
166
167Release Data
168------------
169
170+--------------------------------------+--------------------------------------------------------+
171| **CPS Project** | |
172| | |
173+--------------------------------------+--------------------------------------------------------+
174| **Docker images** | onap/cps-and-ncmp:3.3.2 |
175| | |
176+--------------------------------------+--------------------------------------------------------+
177| **Release designation** | 3.3.2 Montreal |
178| | |
179+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100180| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100181| | |
182+--------------------------------------+--------------------------------------------------------+
183
184Bug Fixes
185---------
1863.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100187 - `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 +0100188
189Features
190--------
--globalc7e5a802023-04-05 17:08:08 +0530191 - `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 +0100192 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
193 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
194 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
195 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100196
lukegleesond7764c42023-04-20 14:11:20 +0100197Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000198==============
199
200Release Data
201------------
202
203+--------------------------------------+--------------------------------------------------------+
204| **CPS Project** | |
205| | |
206+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100207| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000208| | |
209+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100210| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000211| | |
212+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100213| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000214| | |
215+--------------------------------------+--------------------------------------------------------+
216
217Bug Fixes
218---------
lukegleesond7764c42023-04-20 14:11:20 +01002193.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000220 - None
221
222Features
223--------
mpriyank52c5e542023-05-02 15:58:55 +0100224 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
225 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
226 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
227 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
228 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000229
lukegleesond7764c42023-04-20 14:11:20 +0100230Version: 3.3.0
231==============
232
233Release Data
234------------
235
236+--------------------------------------+--------------------------------------------------------+
237| **CPS Project** | |
238| | |
239+--------------------------------------+--------------------------------------------------------+
240| **Docker images** | onap/cps-and-ncmp:3.3.0 |
241| | |
242+--------------------------------------+--------------------------------------------------------+
243| **Release designation** | 3.3.0 Montreal |
244| | |
245+--------------------------------------+--------------------------------------------------------+
246| **Release date** | 2023 April 20 |
247| | |
248+--------------------------------------+--------------------------------------------------------+
249
250Bug Fixes
251---------
2523.3.0
253 - None
254
255Features
256--------
257 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
258 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
259
260.. ======================
261.. * * * LONDON * * *
262.. ======================
263
mpriyank0fd4d192023-03-10 13:48:20 +0000264Version: 3.2.6
265==============
266
267Release Data
268------------
269
270+--------------------------------------+--------------------------------------------------------+
271| **CPS Project** | |
272| | |
273+--------------------------------------+--------------------------------------------------------+
274| **Docker images** | onap/cps-and-ncmp:3.2.6 |
275| | |
276+--------------------------------------+--------------------------------------------------------+
277| **Release designation** | 3.2.6 London |
278| | |
279+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000280| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000281| | |
282+--------------------------------------+--------------------------------------------------------+
283
284Bug Fixes
285---------
2863.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530287 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000288 - `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 +0000289
290Features
291--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000292 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000293
mpriyankade5a6e2023-03-09 17:58:31 +0000294Version: 3.2.5
295==============
296
297Release Data
298------------
299
300+--------------------------------------+--------------------------------------------------------+
301| **CPS Project** | |
302| | |
303+--------------------------------------+--------------------------------------------------------+
304| **Docker images** | onap/cps-and-ncmp:3.2.5 |
305| | |
306+--------------------------------------+--------------------------------------------------------+
307| **Release designation** | 3.2.5 London |
308| | |
309+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000310| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000311| | |
312+--------------------------------------+--------------------------------------------------------+
313
314Bug Fixes
315---------
3163.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000317 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000318
319Features
320--------
321 - None
322
seanbeirnef0f4fd82023-03-07 13:42:04 +0000323Version: 3.2.4
324==============
325
326Release Data
327------------
328
329+--------------------------------------+--------------------------------------------------------+
330| **CPS Project** | |
331| | |
332+--------------------------------------+--------------------------------------------------------+
333| **Docker images** | onap/cps-and-ncmp:3.2.4 |
334| | |
335+--------------------------------------+--------------------------------------------------------+
336| **Release designation** | 3.2.4 London |
337| | |
338+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000339| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000340| | |
341+--------------------------------------+--------------------------------------------------------+
342
343Bug Fixes
344---------
3453.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000346 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
347 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
348
349Features
350--------
351 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000352
mpriyankfd43dbe2023-02-08 11:21:08 +0000353Version: 3.2.3
354==============
355
356Release Data
357------------
358
359+--------------------------------------+--------------------------------------------------------+
360| **CPS Project** | |
361| | |
362+--------------------------------------+--------------------------------------------------------+
363| **Docker images** | onap/cps-and-ncmp:3.2.3 |
364| | |
365+--------------------------------------+--------------------------------------------------------+
366| **Release designation** | 3.2.3 London |
367| | |
368+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000369| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000370| | |
371+--------------------------------------+--------------------------------------------------------+
372
373Bug Fixes
374---------
3753.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000376 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000377
378Features
379--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000380 - `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
381 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000382
seanbeirnef8e980a2023-01-27 18:09:33 +0000383Version: 3.2.2
384==============
385
386Release Data
387------------
388
389+--------------------------------------+--------------------------------------------------------+
390| **CPS Project** | |
391| | |
392+--------------------------------------+--------------------------------------------------------+
393| **Docker images** | onap/cps-and-ncmp:3.2.2 |
394| | |
395+--------------------------------------+--------------------------------------------------------+
396| **Release designation** | 3.2.2 London |
397| | |
398+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000399| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000400| | |
401+--------------------------------------+--------------------------------------------------------+
402
403Bug Fixes
404---------
mpriyank0b5950d2023-02-07 17:55:10 +00004053.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000406 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000407
408Features
409--------
410 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000411
leventecsanyi37d72852022-10-26 10:44:08 +0200412Version: 3.2.1
413==============
mpriyank4bd450e2022-10-05 09:50:59 +0100414
415Release Data
416------------
417
418+--------------------------------------+--------------------------------------------------------+
419| **CPS Project** | |
420| | |
421+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000422| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100423| | |
424+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200425| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100426| | |
427+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000428| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100429| | |
430+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100431
lukegleeson3be99242022-10-11 14:34:56 +0100432Features
433--------
leventecsanyi37d72852022-10-26 10:44:08 +02004343.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000435 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
436 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
437 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000438 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
439 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000440 - `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 +0000441 - `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 +0000442 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000443 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000444 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000445 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
446 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
447 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100448
449Bug Fixes
450---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00004513.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000452 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
453 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
454 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
455 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
456 - `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 +0000457 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000458 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000459 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000460 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
461 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
462 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
463 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
464 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
465 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000466
leventecsanyi37d72852022-10-26 10:44:08 +02004673.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000468 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100469
lukegleeson3be99242022-10-11 14:34:56 +0100470Known Limitations, Issues and Workarounds
471-----------------------------------------
472
473*System Limitations*
474
seanbeirne72c267e2022-10-18 12:39:22 +0100475For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
476This 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 +0100477
arpitsingh2b4c4882023-03-03 21:38:57 +0530478CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
479a 400 Bad Request is sent as response. This is part of commit CPS-1526.
480
seanbeirnedba2b102022-10-27 09:59:17 +0100481.. ====================
482.. * * * KOHN * * *
483.. ====================
484
mpriyankfe775312022-09-30 14:16:51 +0100485Version: 3.1.4
486==============
487
488Release Data
489------------
490
491+--------------------------------------+--------------------------------------------------------+
492| **CPS Project** | |
493| | |
494+--------------------------------------+--------------------------------------------------------+
495| **Docker images** | onap/cps-and-ncmp:3.1.4 |
496| | |
497+--------------------------------------+--------------------------------------------------------+
498| **Release designation** | 3.1.4 Kohn |
499| | |
500+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100501| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100502| | |
503+--------------------------------------+--------------------------------------------------------+
504
505Bug Fixes
506---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100507 - `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 +0100508 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100509
mpriyank06736cb2022-09-29 14:29:40 +0100510Version: 3.1.3
511==============
512
513Release Data
514------------
515
516+--------------------------------------+--------------------------------------------------------+
517| **CPS Project** | |
518| | |
519+--------------------------------------+--------------------------------------------------------+
520| **Docker images** | onap/cps-and-ncmp:3.1.3 |
521| | |
522+--------------------------------------+--------------------------------------------------------+
523| **Release designation** | 3.1.3 Kohn |
524| | |
525+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100526| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100527| | |
528+--------------------------------------+--------------------------------------------------------+
529
530Bug Fixes
531---------
532 - None
533
mpriyankef0ddfc2022-09-28 12:19:34 +0100534Version: 3.1.2
535==============
536
537Release Data
538------------
539
540+--------------------------------------+--------------------------------------------------------+
541| **CPS Project** | |
542| | |
543+--------------------------------------+--------------------------------------------------------+
544| **Docker images** | onap/cps-and-ncmp:3.1.2 |
545| | |
546+--------------------------------------+--------------------------------------------------------+
547| **Release designation** | 3.1.2 Kohn |
548| | |
549+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100550| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100551| | |
552+--------------------------------------+--------------------------------------------------------+
553
554Bug Fixes
555---------
556 - None
557
mpriyanka3f43502022-09-26 14:57:01 +0100558Version: 3.1.1
559==============
560
561Release Data
562------------
563
564+--------------------------------------+--------------------------------------------------------+
565| **CPS Project** | |
566| | |
567+--------------------------------------+--------------------------------------------------------+
568| **Docker images** | onap/cps-and-ncmp:3.1.1 |
569| | |
570+--------------------------------------+--------------------------------------------------------+
571| **Release designation** | 3.1.1 Kohn |
572| | |
573+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100574| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100575| | |
576+--------------------------------------+--------------------------------------------------------+
577
578Bug Fixes
579---------
580 - None
581
lukegleesonc9ec9152022-09-07 14:21:36 +0100582Security Notes
583--------------
584
585*Fixed Security Issues*
586
587 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
588
lukegleeson4a34fa52022-09-19 15:31:59 +0100589Version: 3.1.0
590==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400591
592Release Data
593------------
594
DylanB95ESTb130fd32022-04-04 13:09:22 +0100595+--------------------------------------+--------------------------------------------------------+
596| **CPS Project** | |
597| | |
598+--------------------------------------+--------------------------------------------------------+
599| **Docker images** | onap/cps-and-ncmp:3.1.0 |
600| | |
601+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400602| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100603| | |
604+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100605| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100606| | |
607+--------------------------------------+--------------------------------------------------------+
608
609Features
610--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100611 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
612 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
613 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
614 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
615 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
616 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
617 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
618 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
619 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
620 - `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'
621 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
622 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
623 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
624 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
625 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
626 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
627 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
628 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
629 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
630 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
631 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
632 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
633 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
634 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
635
emacleeafb17362022-09-02 14:40:17 +0100636
637Bug Fixes
638---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100639 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
640 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
641 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
642 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
643 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
644 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
645 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
646 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
647 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
648 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
649 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
650 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
651 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
652 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100653
654Known Limitations, Issues and Workarounds
655-----------------------------------------
656
657*System Limitations*
658
659Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
660Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100661
lukegleeson4a34fa52022-09-19 15:31:59 +0100662*Known Vulnerabilities*
663
664None
665
666*Workarounds*
667
668None
669
670Security Notes
671--------------
672
673*Fixed Security Issues*
674
675 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
676
677*Known Security Issues*
678
679None
680
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400681.. ========================
682.. * * * JAKARTA * * *
683.. ========================
684
685Version: 3.0.1
686==============
687
688Release Data
689------------
690
691+--------------------------------------+--------------------------------------------------------+
692| **CPS Project** | |
693| | |
694+--------------------------------------+--------------------------------------------------------+
695| **Docker images** | onap/cps-and-ncmp:3.0.1 |
696| | |
697+--------------------------------------+--------------------------------------------------------+
698| **Release designation** | 3.0.1 Jakarta |
699| | |
700+--------------------------------------+--------------------------------------------------------+
701| **Release date** | 2022 April 28 |
702| | |
703+--------------------------------------+--------------------------------------------------------+
704
705Bug Fixes
706---------
707 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
708
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400709Version: 3.0.0
710==============
niamhcoref7b414e2021-11-17 11:02:07 +0000711
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400712Release Data
713------------
714
715+--------------------------------------+--------------------------------------------------------+
716| **CPS Project** | |
717| | |
718+--------------------------------------+--------------------------------------------------------+
719| **Docker images** | onap/cps-and-ncmp:3.0.0 |
720| | |
721+--------------------------------------+--------------------------------------------------------+
722| **Release designation** | 3.0.0 Jakarta |
723| | |
724+--------------------------------------+--------------------------------------------------------+
725| **Release date** | 2022 March 15 |
726| | |
727+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000728
729Features
730--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000731 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000732 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
733 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000734 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000735 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000736 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000737 - `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 -0400738 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
739 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000740 - `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 +0530741 - `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 +0000742
743Bug Fixes
744---------
745
746 - `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 +0000747 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000748 - `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 +0000749 - `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 +0000750 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000751 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000752 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000753 - `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 +0530754 - `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 +0000755 - `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 +0000756
757Known Limitations, Issues and Workarounds
758-----------------------------------------
759
760*System Limitations*
761
DylanB95ESTe5573382022-01-27 17:12:52 +0000762Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
763`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
764of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000765
Lathishb3550f12022-03-15 12:03:53 +0000766The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
767for more information.
768
niamhcoref7b414e2021-11-17 11:02:07 +0000769*Known Vulnerabilities*
770
771None
772
773*Workarounds*
774
DylanB95ESTe5573382022-01-27 17:12:52 +0000775Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
776pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000777
778Security Notes
779--------------
780
781*Fixed Security Issues*
782
783None
784
785*Known Security Issues*
786
787None
788
789.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100790.. * * * ISTANBUL * * *
791.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000792
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500793Version: 2.0.4
794==============
795
796Release Data
797------------
798
799+--------------------------------------+--------------------------------------------------------+
800| **CPS Project** | |
801| | |
802+--------------------------------------+--------------------------------------------------------+
803| **Docker images** | onap/cps-and-ncmp:2.0.4 |
804| | |
805+--------------------------------------+--------------------------------------------------------+
806| **Release designation** | 2.0.4 Istanbul |
807| | |
808+--------------------------------------+--------------------------------------------------------+
809| **Release date** | 2022 Feb 09 |
810| | |
811+--------------------------------------+--------------------------------------------------------+
812
813Bug Fixes
814---------
815
816 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
817 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
818
819Version: 2.0.3
820==============
821
822Release Data
823------------
824
825+--------------------------------------+--------------------------------------------------------+
826| **CPS Project** | |
827| | |
828+--------------------------------------+--------------------------------------------------------+
829| **Docker images** | onap/cps-and-ncmp:2.0.3 |
830| | |
831+--------------------------------------+--------------------------------------------------------+
832| **Release designation** | 2.0.3 Istanbul |
833| | |
834+--------------------------------------+--------------------------------------------------------+
835| **Release date** | 2022-07-01 |
836| | |
837+--------------------------------------+--------------------------------------------------------+
838
839Bug Fixes
840---------
841
842 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
843
844Version: 2.0.2
845==============
846
847Release Data
848------------
849
850+--------------------------------------+--------------------------------------------------------+
851| **CPS Project** | |
852| | |
853+--------------------------------------+--------------------------------------------------------+
854| **Docker images** | onap/cps-and-ncmp:2.0.2 |
855| | |
856+--------------------------------------+--------------------------------------------------------+
857| **Release designation** | 2.0.2 Istanbul |
858| | |
859+--------------------------------------+--------------------------------------------------------+
860| **Release date** | 2021-16-12 |
861| | |
862+--------------------------------------+--------------------------------------------------------+
863
864Bug Fixes
865---------
866
867 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
868
lukegleeson9c583712021-09-30 17:21:11 +0100869Version: 2.0.1
870==============
871
872Release Data
873------------
874
875+--------------------------------------+--------------------------------------------------------+
876| **CPS Project** | |
877| | |
878+--------------------------------------+--------------------------------------------------------+
879| **Docker images** | onap/cps-and-ncmp:2.0.1 |
880| | |
881+--------------------------------------+--------------------------------------------------------+
882| **Release designation** | 2.0.1 Istanbul |
883| | |
884+--------------------------------------+--------------------------------------------------------+
885| **Release date** | 2021-14-10 |
886| | |
887+--------------------------------------+--------------------------------------------------------+
888
889Bug Fixes
890---------
891
892 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
893 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
894 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
895 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
896
897Known Limitations, Issues and Workarounds
898-----------------------------------------
899
900*System Limitations*
901
902Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
903
904*Known Vulnerabilities*
905
906 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
907
908*Workarounds*
909
910Add recursive method to save list node data to loop through all corresponding child nodes.
911
912Security Notes
913--------------
914
915*Fixed Security Issues*
916
917 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
918
919*Known Security Issues*
920
921None
922
shivasubedi44beaa32021-09-13 15:16:30 +0100923Version: 2.0.0
924==============
925
926Abstract
927--------
928
929This document provides the release notes for Istanbul release.
930
931Release Data
932------------
933
934+--------------------------------------+--------------------------------------------------------+
935| **CPS Project** | |
936| | |
937+--------------------------------------+--------------------------------------------------------+
938| **Docker images** | onap/cps-and-ncmp:2.0.0 |
939| | |
940+--------------------------------------+--------------------------------------------------------+
941| **Release designation** | 2.0.0 Istanbul |
942| | |
943+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100944| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100945| | |
946+--------------------------------------+--------------------------------------------------------+
947
948Features
949--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100950* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100951* Update, Create and Remove CM Handles.
952* Add support for retrieving and writing CM Handle data through NCMP datastores.
953* Automatic retrieval and caching of model information for CM Handles within NCMP.
954
shivasubedi44beaa32021-09-13 15:16:30 +0100955Deliverables
956------------
957
958Software Deliverables
959
960.. csv-table::
961 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
962 :widths: auto
963
964 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
965
966Bug Fixes
967---------
968
lukegleeson9c583712021-09-30 17:21:11 +0100969 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100970 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
971 - `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 +0100972 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
973 - `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 +0100974 - `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 +0100975 - `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 +0100976 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
977 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100978 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
979 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
980 - `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 +0100981 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
982 - `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 +0100983 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100984 - `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 +0100985 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
986 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
987 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100988 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
989 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
990 - `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 -0500991 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100992 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
993 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
994 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100995
996This document provides the release notes for Istanbul release.
997
998Summary
999-------
1000
1001Following CPS components are available with default ONAP/CPS installation.
1002
1003
1004 * Platform components
1005
1006 - CPS (Helm charts)
1007
1008 * Service components
1009
DylanB95EST3fcf8692021-10-11 16:29:16 +01001010 - CPS-NCMP
1011 - CPS-Temporal
1012 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001013
1014 * Additional resources that CPS utilizes deployed using ONAP common charts
1015
1016 - Postgres Database
1017
1018
1019Below service components (mS) are available to be deployed on-demand.
1020 - CPS-TBDMT
1021
1022
1023Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1024
1025Known Limitations, Issues and Workarounds
1026-----------------------------------------
1027
shivasubedi44beaa32021-09-13 15:16:30 +01001028*System Limitations*
1029
1030Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1031
1032*Known Vulnerabilities*
1033
lukegleeson9c583712021-09-30 17:21:11 +01001034 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1035 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1036 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001037
1038*Workarounds*
1039
1040Add recursive method to save list node data to loop through all corresponding child nodes.
1041
1042Security Notes
1043--------------
1044
1045*Fixed Security Issues*
1046
1047 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001048
1049*Known Security Issues*
1050
lukegleeson9c583712021-09-30 17:21:11 +01001051 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1052
shivasubedi44beaa32021-09-13 15:16:30 +01001053Test Results
1054------------
1055 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001056
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001057.. ========================
1058.. * * * HONOLULU * * *
1059.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001060
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001061Version: 1.0.1
1062==============
1063
1064Release Data
1065------------
1066
1067+--------------------------------------+--------------------------------------------------------+
1068| **CPS Project** | |
1069| | |
1070+--------------------------------------+--------------------------------------------------------+
1071| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1072| | |
1073+--------------------------------------+--------------------------------------------------------+
1074| **Release designation** | 1.0.1 Honolulu |
1075| | |
1076+--------------------------------------+--------------------------------------------------------+
1077| **Release date** | 2021-04-09 |
1078| | |
1079+--------------------------------------+--------------------------------------------------------+
1080
1081Bug Fixes
1082---------
1083
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001084 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001085 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1086 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1087 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1088 - `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
1089 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1090 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1091 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1092
1093Security Notes
1094--------------
1095
1096*Fixed Security Issues*
1097
1098 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001099
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001100*Known Security Issues*
1101
1102 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1103
Rishi.Chail4359d282021-03-03 16:36:26 +00001104Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001105==============
1106
1107
1108Abstract
1109--------
1110
1111This document provides the release notes for Honolulu release.
1112
1113Summary
1114-------
1115
1116Following CPS components are available with default ONAP/CPS installation.
1117
1118
Rishi.Chail4359d282021-03-03 16:36:26 +00001119 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001120
Rishi.Chail4359d282021-03-03 16:36:26 +00001121 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001122
Rishi.Chail4359d282021-03-03 16:36:26 +00001123 * Service components
1124
1125 - CPS Core
1126
1127 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001128
1129 - Postgres Database
1130
1131
Rishi.Chail4359d282021-03-03 16:36:26 +00001132Below service components (mS) are available to be deployed on-demand.
1133 - CPS-TBDMT
1134
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001135
1136Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1137
1138
1139Release Data
1140------------
1141
1142+--------------------------------------+--------------------------------------------------------+
1143| **CPS Project** | |
1144| | |
1145+--------------------------------------+--------------------------------------------------------+
1146| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1147| | |
1148+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001149| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001150| | |
1151+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001152| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001153| | |
1154+--------------------------------------+--------------------------------------------------------+
1155
1156
1157Features
1158--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001159Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1160CPS has been driven by the needs of the E2E Networking Slicing use case.
1161It currently supports basic (rw) persistence and simple queries.
1162It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001163
1164.. _honolulu_deliverable:
1165
1166Deliverables
1167------------
1168
1169Software Deliverables
1170
1171.. csv-table::
1172 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1173 :widths: auto
1174
Rishi.Chail4359d282021-03-03 16:36:26 +00001175 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001176
1177
1178Known Limitations, Issues and Workarounds
1179-----------------------------------------
1180
Rishi.Chail4359d282021-03-03 16:36:26 +00001181 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1182 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1183 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001184 - `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 +00001185
1186*System Limitations*
1187
1188None
1189
1190*Known Vulnerabilities*
1191
1192None
1193
1194*Workarounds*
1195
1196Documented under corresponding jira if applicable.
1197
1198Security Notes
1199--------------
1200
1201*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001202
1203* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001204 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001205 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001206 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001207
1208*Known Security Issues*
1209
Rishi.Chail4359d282021-03-03 16:36:26 +00001210 * Weak Crytography using md5
1211 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001212
1213*Known Vulnerabilities in Used Modules*
1214
Rishi.Chail4359d282021-03-03 16:36:26 +00001215 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001216
Rishi.Chail4359d282021-03-03 16:36:26 +00001217CPS 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 +00001218
1219Test Results
1220------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001221 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001222
1223References
1224----------
1225
ToineSiebelinkcac21862023-06-22 09:24:04 +01001226For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001227
1228#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001229#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001230#. `ONAP Documentation`_
1231#. `ONAP CPS Documentation`_
1232#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001233
1234
1235.. _`ONAP Home Page`: https://www.onap.org
1236.. _`ONAP Wiki Page`: https://wiki.onap.org
1237.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001238.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001239.. _`ONAP Release Downloads`: https://git.onap.org
1240
1241Quick Links:
1242
1243 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1244 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_