blob: cd7ea80505c9dae40eb3b7fae83cde30264f81de [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
danielhanrahanefc55772023-09-15 12:02:35 +010042 - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
leventecsanyid35ad5c2023-08-23 15:55:30 +020043
44Features
45--------
46
egernugbdac4402023-07-21 13:27:24 +010047Version: 3.3.6
48==============
49
50Release Data
51------------
52
53+--------------------------------------+--------------------------------------------------------+
54| **CPS Project** | |
55| | |
56+--------------------------------------+--------------------------------------------------------+
57| **Docker images** | onap/cps-and-ncmp:3.3.6 |
58| | |
59+--------------------------------------+--------------------------------------------------------+
60| **Release designation** | 3.3.6 Montreal |
61| | |
62+--------------------------------------+--------------------------------------------------------+
leventecsanyid35ad5c2023-08-23 15:55:30 +020063| **Release date** | 2023 August 23 |
egernugbdac4402023-07-21 13:27:24 +010064| | |
65+--------------------------------------+--------------------------------------------------------+
66
67Bug Fixes
68---------
693.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +010070 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
mpriyank41c7d002023-08-22 13:17:46 +010071 - `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 +010072
73Features
74--------
danielhanrahan92705462023-05-18 10:18:10 +010075 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +010076 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +010077
78
egernug6c9621a2023-07-19 11:05:00 +010079Version: 3.3.5
80==============
81
82Release Data
83------------
84
85+--------------------------------------+--------------------------------------------------------+
86| **CPS Project** | |
87| | |
88+--------------------------------------+--------------------------------------------------------+
89| **Docker images** | onap/cps-and-ncmp:3.3.5 |
90| | |
91+--------------------------------------+--------------------------------------------------------+
92| **Release designation** | 3.3.5 Montreal |
93| | |
94+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +010095| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +010096| | |
97+--------------------------------------+--------------------------------------------------------+
98
99Bug Fixes
100---------
1013.3.5
102
103Features
104--------
danielhanrahan74a47152023-06-28 12:55:20 +0100105 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +0100106
mpriyank8caa3422023-06-30 11:14:10 +0100107Version: 3.3.4
108==============
109
110Release Data
111------------
112
113+--------------------------------------+--------------------------------------------------------+
114| **CPS Project** | |
115| | |
116+--------------------------------------+--------------------------------------------------------+
117| **Docker images** | onap/cps-and-ncmp:3.3.4 |
118| | |
119+--------------------------------------+--------------------------------------------------------+
120| **Release designation** | 3.3.4 Montreal |
121| | |
122+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +0100123| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +0100124| | |
125+--------------------------------------+--------------------------------------------------------+
126
127Bug Fixes
128---------
1293.3.4
130
131Features
132--------
egernugdb62ffb2023-07-18 10:57:42 +0100133 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100134
danielhanrahan19f963b2023-06-15 13:52:34 +0100135Version: 3.3.3
136==============
137
138Release Data
139------------
140
141+--------------------------------------+--------------------------------------------------------+
142| **CPS Project** | |
143| | |
144+--------------------------------------+--------------------------------------------------------+
145| **Docker images** | onap/cps-and-ncmp:3.3.3 |
146| | |
147+--------------------------------------+--------------------------------------------------------+
148| **Release designation** | 3.3.3 Montreal |
149| | |
150+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100151| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100152| | |
153+--------------------------------------+--------------------------------------------------------+
154
155Bug Fixes
156---------
1573.3.3
158
159Features
160--------
mpriyank6da95412023-06-29 16:56:11 +0100161 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
162 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
163 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100164
mpriyank436b75b2023-05-03 11:10:08 +0100165Version: 3.3.2
166==============
167
168Release Data
169------------
170
171+--------------------------------------+--------------------------------------------------------+
172| **CPS Project** | |
173| | |
174+--------------------------------------+--------------------------------------------------------+
175| **Docker images** | onap/cps-and-ncmp:3.3.2 |
176| | |
177+--------------------------------------+--------------------------------------------------------+
178| **Release designation** | 3.3.2 Montreal |
179| | |
180+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100181| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100182| | |
183+--------------------------------------+--------------------------------------------------------+
184
185Bug Fixes
186---------
1873.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100188 - `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 +0100189
190Features
191--------
--globalc7e5a802023-04-05 17:08:08 +0530192 - `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 +0100193 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
194 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
195 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
196 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100197
lukegleesond7764c42023-04-20 14:11:20 +0100198Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000199==============
200
201Release Data
202------------
203
204+--------------------------------------+--------------------------------------------------------+
205| **CPS Project** | |
206| | |
207+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100208| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000209| | |
210+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100211| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000212| | |
213+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100214| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000215| | |
216+--------------------------------------+--------------------------------------------------------+
217
218Bug Fixes
219---------
lukegleesond7764c42023-04-20 14:11:20 +01002203.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000221 - None
222
223Features
224--------
mpriyank52c5e542023-05-02 15:58:55 +0100225 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
226 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
227 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
228 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
229 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000230
lukegleesond7764c42023-04-20 14:11:20 +0100231Version: 3.3.0
232==============
233
234Release Data
235------------
236
237+--------------------------------------+--------------------------------------------------------+
238| **CPS Project** | |
239| | |
240+--------------------------------------+--------------------------------------------------------+
241| **Docker images** | onap/cps-and-ncmp:3.3.0 |
242| | |
243+--------------------------------------+--------------------------------------------------------+
244| **Release designation** | 3.3.0 Montreal |
245| | |
246+--------------------------------------+--------------------------------------------------------+
247| **Release date** | 2023 April 20 |
248| | |
249+--------------------------------------+--------------------------------------------------------+
250
251Bug Fixes
252---------
2533.3.0
254 - None
255
256Features
257--------
258 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
259 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
260
261.. ======================
262.. * * * LONDON * * *
263.. ======================
264
mpriyank0fd4d192023-03-10 13:48:20 +0000265Version: 3.2.6
266==============
267
268Release Data
269------------
270
271+--------------------------------------+--------------------------------------------------------+
272| **CPS Project** | |
273| | |
274+--------------------------------------+--------------------------------------------------------+
275| **Docker images** | onap/cps-and-ncmp:3.2.6 |
276| | |
277+--------------------------------------+--------------------------------------------------------+
278| **Release designation** | 3.2.6 London |
279| | |
280+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000281| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000282| | |
283+--------------------------------------+--------------------------------------------------------+
284
285Bug Fixes
286---------
2873.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530288 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000289 - `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 +0000290
291Features
292--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000293 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000294
mpriyankade5a6e2023-03-09 17:58:31 +0000295Version: 3.2.5
296==============
297
298Release Data
299------------
300
301+--------------------------------------+--------------------------------------------------------+
302| **CPS Project** | |
303| | |
304+--------------------------------------+--------------------------------------------------------+
305| **Docker images** | onap/cps-and-ncmp:3.2.5 |
306| | |
307+--------------------------------------+--------------------------------------------------------+
308| **Release designation** | 3.2.5 London |
309| | |
310+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000311| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000312| | |
313+--------------------------------------+--------------------------------------------------------+
314
315Bug Fixes
316---------
3173.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000318 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000319
320Features
321--------
322 - None
323
seanbeirnef0f4fd82023-03-07 13:42:04 +0000324Version: 3.2.4
325==============
326
327Release Data
328------------
329
330+--------------------------------------+--------------------------------------------------------+
331| **CPS Project** | |
332| | |
333+--------------------------------------+--------------------------------------------------------+
334| **Docker images** | onap/cps-and-ncmp:3.2.4 |
335| | |
336+--------------------------------------+--------------------------------------------------------+
337| **Release designation** | 3.2.4 London |
338| | |
339+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000340| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000341| | |
342+--------------------------------------+--------------------------------------------------------+
343
344Bug Fixes
345---------
3463.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000347 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
348 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
349
350Features
351--------
352 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000353
mpriyankfd43dbe2023-02-08 11:21:08 +0000354Version: 3.2.3
355==============
356
357Release Data
358------------
359
360+--------------------------------------+--------------------------------------------------------+
361| **CPS Project** | |
362| | |
363+--------------------------------------+--------------------------------------------------------+
364| **Docker images** | onap/cps-and-ncmp:3.2.3 |
365| | |
366+--------------------------------------+--------------------------------------------------------+
367| **Release designation** | 3.2.3 London |
368| | |
369+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000370| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000371| | |
372+--------------------------------------+--------------------------------------------------------+
373
374Bug Fixes
375---------
3763.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000377 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000378
379Features
380--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000381 - `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
382 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000383
seanbeirnef8e980a2023-01-27 18:09:33 +0000384Version: 3.2.2
385==============
386
387Release Data
388------------
389
390+--------------------------------------+--------------------------------------------------------+
391| **CPS Project** | |
392| | |
393+--------------------------------------+--------------------------------------------------------+
394| **Docker images** | onap/cps-and-ncmp:3.2.2 |
395| | |
396+--------------------------------------+--------------------------------------------------------+
397| **Release designation** | 3.2.2 London |
398| | |
399+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000400| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000401| | |
402+--------------------------------------+--------------------------------------------------------+
403
404Bug Fixes
405---------
mpriyank0b5950d2023-02-07 17:55:10 +00004063.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000407 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000408
409Features
410--------
411 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000412
leventecsanyi37d72852022-10-26 10:44:08 +0200413Version: 3.2.1
414==============
mpriyank4bd450e2022-10-05 09:50:59 +0100415
416Release Data
417------------
418
419+--------------------------------------+--------------------------------------------------------+
420| **CPS Project** | |
421| | |
422+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000423| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100424| | |
425+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200426| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100427| | |
428+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000429| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100430| | |
431+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100432
lukegleeson3be99242022-10-11 14:34:56 +0100433Features
434--------
leventecsanyi37d72852022-10-26 10:44:08 +02004353.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000436 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
437 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
438 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000439 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
440 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000441 - `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 +0000442 - `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 +0000443 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000444 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000445 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000446 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
447 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
448 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100449
450Bug Fixes
451---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00004523.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000453 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
454 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
455 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
456 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
457 - `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 +0000458 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000459 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000460 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000461 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
462 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
463 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
464 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
465 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
466 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000467
leventecsanyi37d72852022-10-26 10:44:08 +02004683.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000469 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100470
lukegleeson3be99242022-10-11 14:34:56 +0100471Known Limitations, Issues and Workarounds
472-----------------------------------------
473
474*System Limitations*
475
seanbeirne72c267e2022-10-18 12:39:22 +0100476For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
477This 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 +0100478
arpitsingh2b4c4882023-03-03 21:38:57 +0530479CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
480a 400 Bad Request is sent as response. This is part of commit CPS-1526.
481
seanbeirnedba2b102022-10-27 09:59:17 +0100482.. ====================
483.. * * * KOHN * * *
484.. ====================
485
mpriyankfe775312022-09-30 14:16:51 +0100486Version: 3.1.4
487==============
488
489Release Data
490------------
491
492+--------------------------------------+--------------------------------------------------------+
493| **CPS Project** | |
494| | |
495+--------------------------------------+--------------------------------------------------------+
496| **Docker images** | onap/cps-and-ncmp:3.1.4 |
497| | |
498+--------------------------------------+--------------------------------------------------------+
499| **Release designation** | 3.1.4 Kohn |
500| | |
501+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100502| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100503| | |
504+--------------------------------------+--------------------------------------------------------+
505
506Bug Fixes
507---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100508 - `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 +0100509 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100510
mpriyank06736cb2022-09-29 14:29:40 +0100511Version: 3.1.3
512==============
513
514Release Data
515------------
516
517+--------------------------------------+--------------------------------------------------------+
518| **CPS Project** | |
519| | |
520+--------------------------------------+--------------------------------------------------------+
521| **Docker images** | onap/cps-and-ncmp:3.1.3 |
522| | |
523+--------------------------------------+--------------------------------------------------------+
524| **Release designation** | 3.1.3 Kohn |
525| | |
526+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100527| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100528| | |
529+--------------------------------------+--------------------------------------------------------+
530
531Bug Fixes
532---------
533 - None
534
mpriyankef0ddfc2022-09-28 12:19:34 +0100535Version: 3.1.2
536==============
537
538Release Data
539------------
540
541+--------------------------------------+--------------------------------------------------------+
542| **CPS Project** | |
543| | |
544+--------------------------------------+--------------------------------------------------------+
545| **Docker images** | onap/cps-and-ncmp:3.1.2 |
546| | |
547+--------------------------------------+--------------------------------------------------------+
548| **Release designation** | 3.1.2 Kohn |
549| | |
550+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100551| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100552| | |
553+--------------------------------------+--------------------------------------------------------+
554
555Bug Fixes
556---------
557 - None
558
mpriyanka3f43502022-09-26 14:57:01 +0100559Version: 3.1.1
560==============
561
562Release Data
563------------
564
565+--------------------------------------+--------------------------------------------------------+
566| **CPS Project** | |
567| | |
568+--------------------------------------+--------------------------------------------------------+
569| **Docker images** | onap/cps-and-ncmp:3.1.1 |
570| | |
571+--------------------------------------+--------------------------------------------------------+
572| **Release designation** | 3.1.1 Kohn |
573| | |
574+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100575| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100576| | |
577+--------------------------------------+--------------------------------------------------------+
578
579Bug Fixes
580---------
581 - None
582
lukegleesonc9ec9152022-09-07 14:21:36 +0100583Security Notes
584--------------
585
586*Fixed Security Issues*
587
588 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
589
lukegleeson4a34fa52022-09-19 15:31:59 +0100590Version: 3.1.0
591==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400592
593Release Data
594------------
595
DylanB95ESTb130fd32022-04-04 13:09:22 +0100596+--------------------------------------+--------------------------------------------------------+
597| **CPS Project** | |
598| | |
599+--------------------------------------+--------------------------------------------------------+
600| **Docker images** | onap/cps-and-ncmp:3.1.0 |
601| | |
602+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400603| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100604| | |
605+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100606| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100607| | |
608+--------------------------------------+--------------------------------------------------------+
609
610Features
611--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100612 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
613 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
614 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
615 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
616 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
617 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
618 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
619 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
620 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
621 - `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'
622 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
623 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
624 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
625 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
626 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
627 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
628 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
629 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
630 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
631 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
632 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
633 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
634 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
635 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
636
emacleeafb17362022-09-02 14:40:17 +0100637
638Bug Fixes
639---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100640 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
641 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
642 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
643 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
644 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
645 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
646 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
647 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
648 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
649 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
650 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
651 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
652 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
653 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100654
655Known Limitations, Issues and Workarounds
656-----------------------------------------
657
658*System Limitations*
659
660Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
661Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100662
lukegleeson4a34fa52022-09-19 15:31:59 +0100663*Known Vulnerabilities*
664
665None
666
667*Workarounds*
668
669None
670
671Security Notes
672--------------
673
674*Fixed Security Issues*
675
676 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
677
678*Known Security Issues*
679
680None
681
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400682.. ========================
683.. * * * JAKARTA * * *
684.. ========================
685
686Version: 3.0.1
687==============
688
689Release Data
690------------
691
692+--------------------------------------+--------------------------------------------------------+
693| **CPS Project** | |
694| | |
695+--------------------------------------+--------------------------------------------------------+
696| **Docker images** | onap/cps-and-ncmp:3.0.1 |
697| | |
698+--------------------------------------+--------------------------------------------------------+
699| **Release designation** | 3.0.1 Jakarta |
700| | |
701+--------------------------------------+--------------------------------------------------------+
702| **Release date** | 2022 April 28 |
703| | |
704+--------------------------------------+--------------------------------------------------------+
705
706Bug Fixes
707---------
708 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
709
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400710Version: 3.0.0
711==============
niamhcoref7b414e2021-11-17 11:02:07 +0000712
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400713Release Data
714------------
715
716+--------------------------------------+--------------------------------------------------------+
717| **CPS Project** | |
718| | |
719+--------------------------------------+--------------------------------------------------------+
720| **Docker images** | onap/cps-and-ncmp:3.0.0 |
721| | |
722+--------------------------------------+--------------------------------------------------------+
723| **Release designation** | 3.0.0 Jakarta |
724| | |
725+--------------------------------------+--------------------------------------------------------+
726| **Release date** | 2022 March 15 |
727| | |
728+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000729
730Features
731--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000732 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000733 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
734 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000735 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000736 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000737 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000738 - `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 -0400739 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
740 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000741 - `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 +0530742 - `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 +0000743
744Bug Fixes
745---------
746
747 - `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 +0000748 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000749 - `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 +0000750 - `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 +0000751 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000752 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000753 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000754 - `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 +0530755 - `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 +0000756 - `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 +0000757
758Known Limitations, Issues and Workarounds
759-----------------------------------------
760
761*System Limitations*
762
DylanB95ESTe5573382022-01-27 17:12:52 +0000763Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
764`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
765of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000766
Lathishb3550f12022-03-15 12:03:53 +0000767The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
768for more information.
769
niamhcoref7b414e2021-11-17 11:02:07 +0000770*Known Vulnerabilities*
771
772None
773
774*Workarounds*
775
DylanB95ESTe5573382022-01-27 17:12:52 +0000776Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
777pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000778
779Security Notes
780--------------
781
782*Fixed Security Issues*
783
784None
785
786*Known Security Issues*
787
788None
789
790.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100791.. * * * ISTANBUL * * *
792.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000793
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500794Version: 2.0.4
795==============
796
797Release Data
798------------
799
800+--------------------------------------+--------------------------------------------------------+
801| **CPS Project** | |
802| | |
803+--------------------------------------+--------------------------------------------------------+
804| **Docker images** | onap/cps-and-ncmp:2.0.4 |
805| | |
806+--------------------------------------+--------------------------------------------------------+
807| **Release designation** | 2.0.4 Istanbul |
808| | |
809+--------------------------------------+--------------------------------------------------------+
810| **Release date** | 2022 Feb 09 |
811| | |
812+--------------------------------------+--------------------------------------------------------+
813
814Bug Fixes
815---------
816
817 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
818 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
819
820Version: 2.0.3
821==============
822
823Release Data
824------------
825
826+--------------------------------------+--------------------------------------------------------+
827| **CPS Project** | |
828| | |
829+--------------------------------------+--------------------------------------------------------+
830| **Docker images** | onap/cps-and-ncmp:2.0.3 |
831| | |
832+--------------------------------------+--------------------------------------------------------+
833| **Release designation** | 2.0.3 Istanbul |
834| | |
835+--------------------------------------+--------------------------------------------------------+
836| **Release date** | 2022-07-01 |
837| | |
838+--------------------------------------+--------------------------------------------------------+
839
840Bug Fixes
841---------
842
843 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
844
845Version: 2.0.2
846==============
847
848Release Data
849------------
850
851+--------------------------------------+--------------------------------------------------------+
852| **CPS Project** | |
853| | |
854+--------------------------------------+--------------------------------------------------------+
855| **Docker images** | onap/cps-and-ncmp:2.0.2 |
856| | |
857+--------------------------------------+--------------------------------------------------------+
858| **Release designation** | 2.0.2 Istanbul |
859| | |
860+--------------------------------------+--------------------------------------------------------+
861| **Release date** | 2021-16-12 |
862| | |
863+--------------------------------------+--------------------------------------------------------+
864
865Bug Fixes
866---------
867
868 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
869
lukegleeson9c583712021-09-30 17:21:11 +0100870Version: 2.0.1
871==============
872
873Release Data
874------------
875
876+--------------------------------------+--------------------------------------------------------+
877| **CPS Project** | |
878| | |
879+--------------------------------------+--------------------------------------------------------+
880| **Docker images** | onap/cps-and-ncmp:2.0.1 |
881| | |
882+--------------------------------------+--------------------------------------------------------+
883| **Release designation** | 2.0.1 Istanbul |
884| | |
885+--------------------------------------+--------------------------------------------------------+
886| **Release date** | 2021-14-10 |
887| | |
888+--------------------------------------+--------------------------------------------------------+
889
890Bug Fixes
891---------
892
893 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
894 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
895 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
896 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
897
898Known Limitations, Issues and Workarounds
899-----------------------------------------
900
901*System Limitations*
902
903Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
904
905*Known Vulnerabilities*
906
907 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
908
909*Workarounds*
910
911Add recursive method to save list node data to loop through all corresponding child nodes.
912
913Security Notes
914--------------
915
916*Fixed Security Issues*
917
918 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
919
920*Known Security Issues*
921
922None
923
shivasubedi44beaa32021-09-13 15:16:30 +0100924Version: 2.0.0
925==============
926
927Abstract
928--------
929
930This document provides the release notes for Istanbul release.
931
932Release Data
933------------
934
935+--------------------------------------+--------------------------------------------------------+
936| **CPS Project** | |
937| | |
938+--------------------------------------+--------------------------------------------------------+
939| **Docker images** | onap/cps-and-ncmp:2.0.0 |
940| | |
941+--------------------------------------+--------------------------------------------------------+
942| **Release designation** | 2.0.0 Istanbul |
943| | |
944+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100945| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100946| | |
947+--------------------------------------+--------------------------------------------------------+
948
949Features
950--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100951* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100952* Update, Create and Remove CM Handles.
953* Add support for retrieving and writing CM Handle data through NCMP datastores.
954* Automatic retrieval and caching of model information for CM Handles within NCMP.
955
shivasubedi44beaa32021-09-13 15:16:30 +0100956Deliverables
957------------
958
959Software Deliverables
960
961.. csv-table::
962 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
963 :widths: auto
964
965 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
966
967Bug Fixes
968---------
969
lukegleeson9c583712021-09-30 17:21:11 +0100970 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100971 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
972 - `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 +0100973 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
974 - `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 +0100975 - `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 +0100976 - `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 +0100977 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
978 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100979 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
980 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
981 - `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 +0100982 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
983 - `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 +0100984 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100985 - `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 +0100986 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
987 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
988 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100989 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
990 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
991 - `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 -0500992 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100993 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
994 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
995 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100996
997This document provides the release notes for Istanbul release.
998
999Summary
1000-------
1001
1002Following CPS components are available with default ONAP/CPS installation.
1003
1004
1005 * Platform components
1006
1007 - CPS (Helm charts)
1008
1009 * Service components
1010
DylanB95EST3fcf8692021-10-11 16:29:16 +01001011 - CPS-NCMP
1012 - CPS-Temporal
1013 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +01001014
1015 * Additional resources that CPS utilizes deployed using ONAP common charts
1016
1017 - Postgres Database
1018
1019
1020Below service components (mS) are available to be deployed on-demand.
1021 - CPS-TBDMT
1022
1023
1024Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1025
1026Known Limitations, Issues and Workarounds
1027-----------------------------------------
1028
shivasubedi44beaa32021-09-13 15:16:30 +01001029*System Limitations*
1030
1031Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1032
1033*Known Vulnerabilities*
1034
lukegleeson9c583712021-09-30 17:21:11 +01001035 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1036 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1037 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001038
1039*Workarounds*
1040
1041Add recursive method to save list node data to loop through all corresponding child nodes.
1042
1043Security Notes
1044--------------
1045
1046*Fixed Security Issues*
1047
1048 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001049
1050*Known Security Issues*
1051
lukegleeson9c583712021-09-30 17:21:11 +01001052 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1053
shivasubedi44beaa32021-09-13 15:16:30 +01001054Test Results
1055------------
1056 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001057
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001058.. ========================
1059.. * * * HONOLULU * * *
1060.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001061
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001062Version: 1.0.1
1063==============
1064
1065Release Data
1066------------
1067
1068+--------------------------------------+--------------------------------------------------------+
1069| **CPS Project** | |
1070| | |
1071+--------------------------------------+--------------------------------------------------------+
1072| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1073| | |
1074+--------------------------------------+--------------------------------------------------------+
1075| **Release designation** | 1.0.1 Honolulu |
1076| | |
1077+--------------------------------------+--------------------------------------------------------+
1078| **Release date** | 2021-04-09 |
1079| | |
1080+--------------------------------------+--------------------------------------------------------+
1081
1082Bug Fixes
1083---------
1084
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001085 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001086 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1087 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1088 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1089 - `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
1090 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1091 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1092 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1093
1094Security Notes
1095--------------
1096
1097*Fixed Security Issues*
1098
1099 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001100
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001101*Known Security Issues*
1102
1103 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1104
Rishi.Chail4359d282021-03-03 16:36:26 +00001105Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001106==============
1107
1108
1109Abstract
1110--------
1111
1112This document provides the release notes for Honolulu release.
1113
1114Summary
1115-------
1116
1117Following CPS components are available with default ONAP/CPS installation.
1118
1119
Rishi.Chail4359d282021-03-03 16:36:26 +00001120 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001121
Rishi.Chail4359d282021-03-03 16:36:26 +00001122 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001123
Rishi.Chail4359d282021-03-03 16:36:26 +00001124 * Service components
1125
1126 - CPS Core
1127
1128 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001129
1130 - Postgres Database
1131
1132
Rishi.Chail4359d282021-03-03 16:36:26 +00001133Below service components (mS) are available to be deployed on-demand.
1134 - CPS-TBDMT
1135
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001136
1137Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1138
1139
1140Release Data
1141------------
1142
1143+--------------------------------------+--------------------------------------------------------+
1144| **CPS Project** | |
1145| | |
1146+--------------------------------------+--------------------------------------------------------+
1147| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1148| | |
1149+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001150| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001151| | |
1152+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001153| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001154| | |
1155+--------------------------------------+--------------------------------------------------------+
1156
1157
1158Features
1159--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001160Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1161CPS has been driven by the needs of the E2E Networking Slicing use case.
1162It currently supports basic (rw) persistence and simple queries.
1163It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001164
1165.. _honolulu_deliverable:
1166
1167Deliverables
1168------------
1169
1170Software Deliverables
1171
1172.. csv-table::
1173 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1174 :widths: auto
1175
Rishi.Chail4359d282021-03-03 16:36:26 +00001176 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001177
1178
1179Known Limitations, Issues and Workarounds
1180-----------------------------------------
1181
Rishi.Chail4359d282021-03-03 16:36:26 +00001182 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1183 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1184 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001185 - `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 +00001186
1187*System Limitations*
1188
1189None
1190
1191*Known Vulnerabilities*
1192
1193None
1194
1195*Workarounds*
1196
1197Documented under corresponding jira if applicable.
1198
1199Security Notes
1200--------------
1201
1202*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001203
1204* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001205 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001206 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001207 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001208
1209*Known Security Issues*
1210
Rishi.Chail4359d282021-03-03 16:36:26 +00001211 * Weak Crytography using md5
1212 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001213
1214*Known Vulnerabilities in Used Modules*
1215
Rishi.Chail4359d282021-03-03 16:36:26 +00001216 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001217
Rishi.Chail4359d282021-03-03 16:36:26 +00001218CPS 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 +00001219
1220Test Results
1221------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001222 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001223
1224References
1225----------
1226
ToineSiebelinkcac21862023-06-22 09:24:04 +01001227For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001228
1229#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001230#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001231#. `ONAP Documentation`_
1232#. `ONAP CPS Documentation`_
1233#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001234
1235
1236.. _`ONAP Home Page`: https://www.onap.org
1237.. _`ONAP Wiki Page`: https://wiki.onap.org
1238.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001239.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001240.. _`ONAP Release Downloads`: https://git.onap.org
1241
1242Quick Links:
1243
1244 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1245 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_