blob: 3f672ad626143a1da828ed7d33f2e14cbddafa0e [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
egernugbdac4402023-07-21 13:27:24 +010019Version: 3.3.6
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.6 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.6 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.6
danielhanrahan996d0c22023-08-17 15:43:34 +010042 - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
egernugbdac4402023-07-21 13:27:24 +010043
44Features
45--------
danielhanrahan92705462023-05-18 10:18:10 +010046 - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
mpriyank612fb572023-08-01 15:36:27 +010047 - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
egernugbdac4402023-07-21 13:27:24 +010048
49
egernug6c9621a2023-07-19 11:05:00 +010050Version: 3.3.5
51==============
52
53Release Data
54------------
55
56+--------------------------------------+--------------------------------------------------------+
57| **CPS Project** | |
58| | |
59+--------------------------------------+--------------------------------------------------------+
60| **Docker images** | onap/cps-and-ncmp:3.3.5 |
61| | |
62+--------------------------------------+--------------------------------------------------------+
63| **Release designation** | 3.3.5 Montreal |
64| | |
65+--------------------------------------+--------------------------------------------------------+
egernugbdac4402023-07-21 13:27:24 +010066| **Release date** | 2023 July 21 |
egernug6c9621a2023-07-19 11:05:00 +010067| | |
68+--------------------------------------+--------------------------------------------------------+
69
70Bug Fixes
71---------
723.3.5
73
74Features
75--------
danielhanrahan74a47152023-06-28 12:55:20 +010076 - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
egernug6c9621a2023-07-19 11:05:00 +010077
mpriyank8caa3422023-06-30 11:14:10 +010078Version: 3.3.4
79==============
80
81Release Data
82------------
83
84+--------------------------------------+--------------------------------------------------------+
85| **CPS Project** | |
86| | |
87+--------------------------------------+--------------------------------------------------------+
88| **Docker images** | onap/cps-and-ncmp:3.3.4 |
89| | |
90+--------------------------------------+--------------------------------------------------------+
91| **Release designation** | 3.3.4 Montreal |
92| | |
93+--------------------------------------+--------------------------------------------------------+
egernug6c9621a2023-07-19 11:05:00 +010094| **Release date** | 2023 July 19 |
mpriyank8caa3422023-06-30 11:14:10 +010095| | |
96+--------------------------------------+--------------------------------------------------------+
97
98Bug Fixes
99---------
1003.3.4
101
102Features
103--------
egernugdb62ffb2023-07-18 10:57:42 +0100104 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100105
danielhanrahan19f963b2023-06-15 13:52:34 +0100106Version: 3.3.3
107==============
108
109Release Data
110------------
111
112+--------------------------------------+--------------------------------------------------------+
113| **CPS Project** | |
114| | |
115+--------------------------------------+--------------------------------------------------------+
116| **Docker images** | onap/cps-and-ncmp:3.3.3 |
117| | |
118+--------------------------------------+--------------------------------------------------------+
119| **Release designation** | 3.3.3 Montreal |
120| | |
121+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100122| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100123| | |
124+--------------------------------------+--------------------------------------------------------+
125
126Bug Fixes
127---------
1283.3.3
129
130Features
131--------
mpriyank6da95412023-06-29 16:56:11 +0100132 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
133 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
134 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100135
mpriyank436b75b2023-05-03 11:10:08 +0100136Version: 3.3.2
137==============
138
139Release Data
140------------
141
142+--------------------------------------+--------------------------------------------------------+
143| **CPS Project** | |
144| | |
145+--------------------------------------+--------------------------------------------------------+
146| **Docker images** | onap/cps-and-ncmp:3.3.2 |
147| | |
148+--------------------------------------+--------------------------------------------------------+
149| **Release designation** | 3.3.2 Montreal |
150| | |
151+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100152| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100153| | |
154+--------------------------------------+--------------------------------------------------------+
155
156Bug Fixes
157---------
1583.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100159 - `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 +0100160
161Features
162--------
--globalc7e5a802023-04-05 17:08:08 +0530163 - `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 +0100164 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
165 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
166 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
167 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100168
lukegleesond7764c42023-04-20 14:11:20 +0100169Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000170==============
171
172Release Data
173------------
174
175+--------------------------------------+--------------------------------------------------------+
176| **CPS Project** | |
177| | |
178+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100179| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000180| | |
181+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100182| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000183| | |
184+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100185| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000186| | |
187+--------------------------------------+--------------------------------------------------------+
188
189Bug Fixes
190---------
lukegleesond7764c42023-04-20 14:11:20 +01001913.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000192 - None
193
194Features
195--------
mpriyank52c5e542023-05-02 15:58:55 +0100196 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
197 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
198 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
199 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
200 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000201
lukegleesond7764c42023-04-20 14:11:20 +0100202Version: 3.3.0
203==============
204
205Release Data
206------------
207
208+--------------------------------------+--------------------------------------------------------+
209| **CPS Project** | |
210| | |
211+--------------------------------------+--------------------------------------------------------+
212| **Docker images** | onap/cps-and-ncmp:3.3.0 |
213| | |
214+--------------------------------------+--------------------------------------------------------+
215| **Release designation** | 3.3.0 Montreal |
216| | |
217+--------------------------------------+--------------------------------------------------------+
218| **Release date** | 2023 April 20 |
219| | |
220+--------------------------------------+--------------------------------------------------------+
221
222Bug Fixes
223---------
2243.3.0
225 - None
226
227Features
228--------
229 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
230 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
231
232.. ======================
233.. * * * LONDON * * *
234.. ======================
235
mpriyank0fd4d192023-03-10 13:48:20 +0000236Version: 3.2.6
237==============
238
239Release Data
240------------
241
242+--------------------------------------+--------------------------------------------------------+
243| **CPS Project** | |
244| | |
245+--------------------------------------+--------------------------------------------------------+
246| **Docker images** | onap/cps-and-ncmp:3.2.6 |
247| | |
248+--------------------------------------+--------------------------------------------------------+
249| **Release designation** | 3.2.6 London |
250| | |
251+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000252| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000253| | |
254+--------------------------------------+--------------------------------------------------------+
255
256Bug Fixes
257---------
2583.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530259 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000260 - `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 +0000261
262Features
263--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000264 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000265
mpriyankade5a6e2023-03-09 17:58:31 +0000266Version: 3.2.5
267==============
268
269Release Data
270------------
271
272+--------------------------------------+--------------------------------------------------------+
273| **CPS Project** | |
274| | |
275+--------------------------------------+--------------------------------------------------------+
276| **Docker images** | onap/cps-and-ncmp:3.2.5 |
277| | |
278+--------------------------------------+--------------------------------------------------------+
279| **Release designation** | 3.2.5 London |
280| | |
281+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000282| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000283| | |
284+--------------------------------------+--------------------------------------------------------+
285
286Bug Fixes
287---------
2883.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000289 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000290
291Features
292--------
293 - None
294
seanbeirnef0f4fd82023-03-07 13:42:04 +0000295Version: 3.2.4
296==============
297
298Release Data
299------------
300
301+--------------------------------------+--------------------------------------------------------+
302| **CPS Project** | |
303| | |
304+--------------------------------------+--------------------------------------------------------+
305| **Docker images** | onap/cps-and-ncmp:3.2.4 |
306| | |
307+--------------------------------------+--------------------------------------------------------+
308| **Release designation** | 3.2.4 London |
309| | |
310+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000311| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000312| | |
313+--------------------------------------+--------------------------------------------------------+
314
315Bug Fixes
316---------
3173.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000318 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
319 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
320
321Features
322--------
323 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000324
mpriyankfd43dbe2023-02-08 11:21:08 +0000325Version: 3.2.3
326==============
327
328Release Data
329------------
330
331+--------------------------------------+--------------------------------------------------------+
332| **CPS Project** | |
333| | |
334+--------------------------------------+--------------------------------------------------------+
335| **Docker images** | onap/cps-and-ncmp:3.2.3 |
336| | |
337+--------------------------------------+--------------------------------------------------------+
338| **Release designation** | 3.2.3 London |
339| | |
340+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000341| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000342| | |
343+--------------------------------------+--------------------------------------------------------+
344
345Bug Fixes
346---------
3473.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000348 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000349
350Features
351--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000352 - `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
353 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000354
seanbeirnef8e980a2023-01-27 18:09:33 +0000355Version: 3.2.2
356==============
357
358Release Data
359------------
360
361+--------------------------------------+--------------------------------------------------------+
362| **CPS Project** | |
363| | |
364+--------------------------------------+--------------------------------------------------------+
365| **Docker images** | onap/cps-and-ncmp:3.2.2 |
366| | |
367+--------------------------------------+--------------------------------------------------------+
368| **Release designation** | 3.2.2 London |
369| | |
370+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000371| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000372| | |
373+--------------------------------------+--------------------------------------------------------+
374
375Bug Fixes
376---------
mpriyank0b5950d2023-02-07 17:55:10 +00003773.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000378 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000379
380Features
381--------
382 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000383
leventecsanyi37d72852022-10-26 10:44:08 +0200384Version: 3.2.1
385==============
mpriyank4bd450e2022-10-05 09:50:59 +0100386
387Release Data
388------------
389
390+--------------------------------------+--------------------------------------------------------+
391| **CPS Project** | |
392| | |
393+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000394| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100395| | |
396+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200397| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100398| | |
399+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000400| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100401| | |
402+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100403
lukegleeson3be99242022-10-11 14:34:56 +0100404Features
405--------
leventecsanyi37d72852022-10-26 10:44:08 +02004063.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000407 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
408 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
409 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000410 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
411 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000412 - `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 +0000413 - `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 +0000414 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000415 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000416 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000417 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
418 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
419 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100420
421Bug Fixes
422---------
ToineSiebelink294bcb52022-12-23 11:07:42 +00004233.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000424 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
425 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
426 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
427 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
428 - `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 +0000429 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000430 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000431 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000432 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
433 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
434 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
435 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
436 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
437 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000438
leventecsanyi37d72852022-10-26 10:44:08 +02004393.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000440 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100441
lukegleeson3be99242022-10-11 14:34:56 +0100442Known Limitations, Issues and Workarounds
443-----------------------------------------
444
445*System Limitations*
446
seanbeirne72c267e2022-10-18 12:39:22 +0100447For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
448This 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 +0100449
arpitsingh2b4c4882023-03-03 21:38:57 +0530450CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
451a 400 Bad Request is sent as response. This is part of commit CPS-1526.
452
seanbeirnedba2b102022-10-27 09:59:17 +0100453.. ====================
454.. * * * KOHN * * *
455.. ====================
456
mpriyankfe775312022-09-30 14:16:51 +0100457Version: 3.1.4
458==============
459
460Release Data
461------------
462
463+--------------------------------------+--------------------------------------------------------+
464| **CPS Project** | |
465| | |
466+--------------------------------------+--------------------------------------------------------+
467| **Docker images** | onap/cps-and-ncmp:3.1.4 |
468| | |
469+--------------------------------------+--------------------------------------------------------+
470| **Release designation** | 3.1.4 Kohn |
471| | |
472+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100473| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100474| | |
475+--------------------------------------+--------------------------------------------------------+
476
477Bug Fixes
478---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100479 - `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 +0100480 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100481
mpriyank06736cb2022-09-29 14:29:40 +0100482Version: 3.1.3
483==============
484
485Release Data
486------------
487
488+--------------------------------------+--------------------------------------------------------+
489| **CPS Project** | |
490| | |
491+--------------------------------------+--------------------------------------------------------+
492| **Docker images** | onap/cps-and-ncmp:3.1.3 |
493| | |
494+--------------------------------------+--------------------------------------------------------+
495| **Release designation** | 3.1.3 Kohn |
496| | |
497+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100498| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100499| | |
500+--------------------------------------+--------------------------------------------------------+
501
502Bug Fixes
503---------
504 - None
505
mpriyankef0ddfc2022-09-28 12:19:34 +0100506Version: 3.1.2
507==============
508
509Release Data
510------------
511
512+--------------------------------------+--------------------------------------------------------+
513| **CPS Project** | |
514| | |
515+--------------------------------------+--------------------------------------------------------+
516| **Docker images** | onap/cps-and-ncmp:3.1.2 |
517| | |
518+--------------------------------------+--------------------------------------------------------+
519| **Release designation** | 3.1.2 Kohn |
520| | |
521+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100522| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100523| | |
524+--------------------------------------+--------------------------------------------------------+
525
526Bug Fixes
527---------
528 - None
529
mpriyanka3f43502022-09-26 14:57:01 +0100530Version: 3.1.1
531==============
532
533Release Data
534------------
535
536+--------------------------------------+--------------------------------------------------------+
537| **CPS Project** | |
538| | |
539+--------------------------------------+--------------------------------------------------------+
540| **Docker images** | onap/cps-and-ncmp:3.1.1 |
541| | |
542+--------------------------------------+--------------------------------------------------------+
543| **Release designation** | 3.1.1 Kohn |
544| | |
545+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100546| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100547| | |
548+--------------------------------------+--------------------------------------------------------+
549
550Bug Fixes
551---------
552 - None
553
lukegleesonc9ec9152022-09-07 14:21:36 +0100554Security Notes
555--------------
556
557*Fixed Security Issues*
558
559 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
560
lukegleeson4a34fa52022-09-19 15:31:59 +0100561Version: 3.1.0
562==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400563
564Release Data
565------------
566
DylanB95ESTb130fd32022-04-04 13:09:22 +0100567+--------------------------------------+--------------------------------------------------------+
568| **CPS Project** | |
569| | |
570+--------------------------------------+--------------------------------------------------------+
571| **Docker images** | onap/cps-and-ncmp:3.1.0 |
572| | |
573+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400574| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100575| | |
576+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100577| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100578| | |
579+--------------------------------------+--------------------------------------------------------+
580
581Features
582--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100583 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
584 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
585 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
586 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
587 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
588 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
589 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
590 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
591 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
592 - `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'
593 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
594 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
595 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
596 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
597 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
598 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
599 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
600 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
601 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
602 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
603 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
604 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
605 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
606 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
607
emacleeafb17362022-09-02 14:40:17 +0100608
609Bug Fixes
610---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100611 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
612 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
613 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
614 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
615 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
616 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
617 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
618 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
619 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
620 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
621 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
622 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
623 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
624 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100625
626Known Limitations, Issues and Workarounds
627-----------------------------------------
628
629*System Limitations*
630
631Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
632Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100633
lukegleeson4a34fa52022-09-19 15:31:59 +0100634*Known Vulnerabilities*
635
636None
637
638*Workarounds*
639
640None
641
642Security Notes
643--------------
644
645*Fixed Security Issues*
646
647 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
648
649*Known Security Issues*
650
651None
652
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400653.. ========================
654.. * * * JAKARTA * * *
655.. ========================
656
657Version: 3.0.1
658==============
659
660Release Data
661------------
662
663+--------------------------------------+--------------------------------------------------------+
664| **CPS Project** | |
665| | |
666+--------------------------------------+--------------------------------------------------------+
667| **Docker images** | onap/cps-and-ncmp:3.0.1 |
668| | |
669+--------------------------------------+--------------------------------------------------------+
670| **Release designation** | 3.0.1 Jakarta |
671| | |
672+--------------------------------------+--------------------------------------------------------+
673| **Release date** | 2022 April 28 |
674| | |
675+--------------------------------------+--------------------------------------------------------+
676
677Bug Fixes
678---------
679 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
680
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400681Version: 3.0.0
682==============
niamhcoref7b414e2021-11-17 11:02:07 +0000683
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400684Release Data
685------------
686
687+--------------------------------------+--------------------------------------------------------+
688| **CPS Project** | |
689| | |
690+--------------------------------------+--------------------------------------------------------+
691| **Docker images** | onap/cps-and-ncmp:3.0.0 |
692| | |
693+--------------------------------------+--------------------------------------------------------+
694| **Release designation** | 3.0.0 Jakarta |
695| | |
696+--------------------------------------+--------------------------------------------------------+
697| **Release date** | 2022 March 15 |
698| | |
699+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000700
701Features
702--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000703 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000704 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
705 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000706 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000707 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000708 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000709 - `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 -0400710 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
711 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000712 - `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 +0530713 - `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 +0000714
715Bug Fixes
716---------
717
718 - `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 +0000719 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000720 - `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 +0000721 - `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 +0000722 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000723 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000724 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000725 - `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 +0530726 - `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 +0000727 - `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 +0000728
729Known Limitations, Issues and Workarounds
730-----------------------------------------
731
732*System Limitations*
733
DylanB95ESTe5573382022-01-27 17:12:52 +0000734Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
735`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
736of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000737
Lathishb3550f12022-03-15 12:03:53 +0000738The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
739for more information.
740
niamhcoref7b414e2021-11-17 11:02:07 +0000741*Known Vulnerabilities*
742
743None
744
745*Workarounds*
746
DylanB95ESTe5573382022-01-27 17:12:52 +0000747Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
748pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000749
750Security Notes
751--------------
752
753*Fixed Security Issues*
754
755None
756
757*Known Security Issues*
758
759None
760
761.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100762.. * * * ISTANBUL * * *
763.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000764
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500765Version: 2.0.4
766==============
767
768Release Data
769------------
770
771+--------------------------------------+--------------------------------------------------------+
772| **CPS Project** | |
773| | |
774+--------------------------------------+--------------------------------------------------------+
775| **Docker images** | onap/cps-and-ncmp:2.0.4 |
776| | |
777+--------------------------------------+--------------------------------------------------------+
778| **Release designation** | 2.0.4 Istanbul |
779| | |
780+--------------------------------------+--------------------------------------------------------+
781| **Release date** | 2022 Feb 09 |
782| | |
783+--------------------------------------+--------------------------------------------------------+
784
785Bug Fixes
786---------
787
788 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
789 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
790
791Version: 2.0.3
792==============
793
794Release Data
795------------
796
797+--------------------------------------+--------------------------------------------------------+
798| **CPS Project** | |
799| | |
800+--------------------------------------+--------------------------------------------------------+
801| **Docker images** | onap/cps-and-ncmp:2.0.3 |
802| | |
803+--------------------------------------+--------------------------------------------------------+
804| **Release designation** | 2.0.3 Istanbul |
805| | |
806+--------------------------------------+--------------------------------------------------------+
807| **Release date** | 2022-07-01 |
808| | |
809+--------------------------------------+--------------------------------------------------------+
810
811Bug Fixes
812---------
813
814 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
815
816Version: 2.0.2
817==============
818
819Release Data
820------------
821
822+--------------------------------------+--------------------------------------------------------+
823| **CPS Project** | |
824| | |
825+--------------------------------------+--------------------------------------------------------+
826| **Docker images** | onap/cps-and-ncmp:2.0.2 |
827| | |
828+--------------------------------------+--------------------------------------------------------+
829| **Release designation** | 2.0.2 Istanbul |
830| | |
831+--------------------------------------+--------------------------------------------------------+
832| **Release date** | 2021-16-12 |
833| | |
834+--------------------------------------+--------------------------------------------------------+
835
836Bug Fixes
837---------
838
839 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
840
lukegleeson9c583712021-09-30 17:21:11 +0100841Version: 2.0.1
842==============
843
844Release Data
845------------
846
847+--------------------------------------+--------------------------------------------------------+
848| **CPS Project** | |
849| | |
850+--------------------------------------+--------------------------------------------------------+
851| **Docker images** | onap/cps-and-ncmp:2.0.1 |
852| | |
853+--------------------------------------+--------------------------------------------------------+
854| **Release designation** | 2.0.1 Istanbul |
855| | |
856+--------------------------------------+--------------------------------------------------------+
857| **Release date** | 2021-14-10 |
858| | |
859+--------------------------------------+--------------------------------------------------------+
860
861Bug Fixes
862---------
863
864 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
865 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
866 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
867 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
868
869Known Limitations, Issues and Workarounds
870-----------------------------------------
871
872*System Limitations*
873
874Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
875
876*Known Vulnerabilities*
877
878 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
879
880*Workarounds*
881
882Add recursive method to save list node data to loop through all corresponding child nodes.
883
884Security Notes
885--------------
886
887*Fixed Security Issues*
888
889 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
890
891*Known Security Issues*
892
893None
894
shivasubedi44beaa32021-09-13 15:16:30 +0100895Version: 2.0.0
896==============
897
898Abstract
899--------
900
901This document provides the release notes for Istanbul release.
902
903Release Data
904------------
905
906+--------------------------------------+--------------------------------------------------------+
907| **CPS Project** | |
908| | |
909+--------------------------------------+--------------------------------------------------------+
910| **Docker images** | onap/cps-and-ncmp:2.0.0 |
911| | |
912+--------------------------------------+--------------------------------------------------------+
913| **Release designation** | 2.0.0 Istanbul |
914| | |
915+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100916| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100917| | |
918+--------------------------------------+--------------------------------------------------------+
919
920Features
921--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100922* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100923* Update, Create and Remove CM Handles.
924* Add support for retrieving and writing CM Handle data through NCMP datastores.
925* Automatic retrieval and caching of model information for CM Handles within NCMP.
926
shivasubedi44beaa32021-09-13 15:16:30 +0100927Deliverables
928------------
929
930Software Deliverables
931
932.. csv-table::
933 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
934 :widths: auto
935
936 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
937
938Bug Fixes
939---------
940
lukegleeson9c583712021-09-30 17:21:11 +0100941 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100942 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
943 - `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 +0100944 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
945 - `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 +0100946 - `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 +0100947 - `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 +0100948 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
949 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100950 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
951 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
952 - `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 +0100953 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
954 - `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 +0100955 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100956 - `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 +0100957 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
958 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
959 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100960 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
961 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
962 - `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 -0500963 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100964 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
965 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
966 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100967
968This document provides the release notes for Istanbul release.
969
970Summary
971-------
972
973Following CPS components are available with default ONAP/CPS installation.
974
975
976 * Platform components
977
978 - CPS (Helm charts)
979
980 * Service components
981
DylanB95EST3fcf8692021-10-11 16:29:16 +0100982 - CPS-NCMP
983 - CPS-Temporal
984 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100985
986 * Additional resources that CPS utilizes deployed using ONAP common charts
987
988 - Postgres Database
989
990
991Below service components (mS) are available to be deployed on-demand.
992 - CPS-TBDMT
993
994
995Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
996
997Known Limitations, Issues and Workarounds
998-----------------------------------------
999
shivasubedi44beaa32021-09-13 15:16:30 +01001000*System Limitations*
1001
1002Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1003
1004*Known Vulnerabilities*
1005
lukegleeson9c583712021-09-30 17:21:11 +01001006 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1007 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1008 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +01001009
1010*Workarounds*
1011
1012Add recursive method to save list node data to loop through all corresponding child nodes.
1013
1014Security Notes
1015--------------
1016
1017*Fixed Security Issues*
1018
1019 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +01001020
1021*Known Security Issues*
1022
lukegleeson9c583712021-09-30 17:21:11 +01001023 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1024
shivasubedi44beaa32021-09-13 15:16:30 +01001025Test Results
1026------------
1027 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001028
ToineSiebelinkf0527c52021-07-06 13:03:03 +01001029.. ========================
1030.. * * * HONOLULU * * *
1031.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001032
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001033Version: 1.0.1
1034==============
1035
1036Release Data
1037------------
1038
1039+--------------------------------------+--------------------------------------------------------+
1040| **CPS Project** | |
1041| | |
1042+--------------------------------------+--------------------------------------------------------+
1043| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
1044| | |
1045+--------------------------------------+--------------------------------------------------------+
1046| **Release designation** | 1.0.1 Honolulu |
1047| | |
1048+--------------------------------------+--------------------------------------------------------+
1049| **Release date** | 2021-04-09 |
1050| | |
1051+--------------------------------------+--------------------------------------------------------+
1052
1053Bug Fixes
1054---------
1055
puthuparambil.aditya8b584332021-10-12 16:49:03 +01001056 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +01001057 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1058 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1059 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1060 - `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
1061 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1062 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1063 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1064
1065Security Notes
1066--------------
1067
1068*Fixed Security Issues*
1069
1070 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001071
ToineSiebelinka2d25b52021-04-13 15:10:47 +01001072*Known Security Issues*
1073
1074 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1075
Rishi.Chail4359d282021-03-03 16:36:26 +00001076Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001077==============
1078
1079
1080Abstract
1081--------
1082
1083This document provides the release notes for Honolulu release.
1084
1085Summary
1086-------
1087
1088Following CPS components are available with default ONAP/CPS installation.
1089
1090
Rishi.Chail4359d282021-03-03 16:36:26 +00001091 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001092
Rishi.Chail4359d282021-03-03 16:36:26 +00001093 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001094
Rishi.Chail4359d282021-03-03 16:36:26 +00001095 * Service components
1096
1097 - CPS Core
1098
1099 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001100
1101 - Postgres Database
1102
1103
Rishi.Chail4359d282021-03-03 16:36:26 +00001104Below service components (mS) are available to be deployed on-demand.
1105 - CPS-TBDMT
1106
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001107
1108Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1109
1110
1111Release Data
1112------------
1113
1114+--------------------------------------+--------------------------------------------------------+
1115| **CPS Project** | |
1116| | |
1117+--------------------------------------+--------------------------------------------------------+
1118| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1119| | |
1120+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001121| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001122| | |
1123+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +00001124| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001125| | |
1126+--------------------------------------+--------------------------------------------------------+
1127
1128
1129Features
1130--------
Rishi.Chail4359d282021-03-03 16:36:26 +00001131Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1132CPS has been driven by the needs of the E2E Networking Slicing use case.
1133It currently supports basic (rw) persistence and simple queries.
1134It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001135
1136.. _honolulu_deliverable:
1137
1138Deliverables
1139------------
1140
1141Software Deliverables
1142
1143.. csv-table::
1144 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1145 :widths: auto
1146
Rishi.Chail4359d282021-03-03 16:36:26 +00001147 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001148
1149
1150Known Limitations, Issues and Workarounds
1151-----------------------------------------
1152
Rishi.Chail4359d282021-03-03 16:36:26 +00001153 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1154 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1155 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +01001156 - `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 +00001157
1158*System Limitations*
1159
1160None
1161
1162*Known Vulnerabilities*
1163
1164None
1165
1166*Workarounds*
1167
1168Documented under corresponding jira if applicable.
1169
1170Security Notes
1171--------------
1172
1173*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +00001174
1175* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +00001176 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +00001177 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +00001178 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001179
1180*Known Security Issues*
1181
Rishi.Chail4359d282021-03-03 16:36:26 +00001182 * Weak Crytography using md5
1183 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001184
1185*Known Vulnerabilities in Used Modules*
1186
Rishi.Chail4359d282021-03-03 16:36:26 +00001187 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001188
Rishi.Chail4359d282021-03-03 16:36:26 +00001189CPS 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 +00001190
1191Test Results
1192------------
Rishi.Chail4359d282021-03-03 16:36:26 +00001193 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001194
1195References
1196----------
1197
ToineSiebelinkcac21862023-06-22 09:24:04 +01001198For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001199
1200#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001201#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +01001202#. `ONAP Documentation`_
1203#. `ONAP CPS Documentation`_
1204#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001205
1206
1207.. _`ONAP Home Page`: https://www.onap.org
1208.. _`ONAP Wiki Page`: https://wiki.onap.org
1209.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +01001210.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +00001211.. _`ONAP Release Downloads`: https://git.onap.org
1212
1213Quick Links:
1214
1215 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1216 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_