Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / db62ffb1a90608df4d3bd2150d86a9d5146be2c9 / . / docs / release-notes.rst
blob: e51f4e86d5552239228de0f5cb71f324f609c581 [file] [log] [blame]
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]3.. Copyright (C) 2021-2023 Nordix Foundation
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]4
5.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
6.. _release_notes:
7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]8CPS Release Notes
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]9#################
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]10
11.. contents::
12 :depth: 2
13..
14
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]15.. ========================
16.. * * * MONTREAL * * *
17.. ========================
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]18
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]19Version: 3.3.4
20==============
21
22Release Data
23------------
24
25+--------------------------------------+--------------------------------------------------------+
26| **CPS Project** | |
27| | |
28+--------------------------------------+--------------------------------------------------------+
29| **Docker images** | onap/cps-and-ncmp:3.3.4 |
30| | |
31+--------------------------------------+--------------------------------------------------------+
32| **Release designation** | 3.3.4 Montreal |
33| | |
34+--------------------------------------+--------------------------------------------------------+
35| **Release date** | Not yet released |
36| | |
37+--------------------------------------+--------------------------------------------------------+
38
39Bug Fixes
40---------
413.3.4
42
43Features
44--------
egernugdb62ffb2023-07-18 10:57:42 +0100[diff] [blame^]45 - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]46
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]47Version: 3.3.3
48==============
49
50Release Data
51------------
52
53+--------------------------------------+--------------------------------------------------------+
54| **CPS Project** | |
55| | |
56+--------------------------------------+--------------------------------------------------------+
57| **Docker images** | onap/cps-and-ncmp:3.3.3 |
58| | |
59+--------------------------------------+--------------------------------------------------------+
60| **Release designation** | 3.3.3 Montreal |
61| | |
62+--------------------------------------+--------------------------------------------------------+
mpriyank8caa3422023-06-30 11:14:10 +0100[diff] [blame]63| **Release date** | 2023 June 30 |
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]64| | |
65+--------------------------------------+--------------------------------------------------------+
66
67Bug Fixes
68---------
693.3.3
70
71Features
72--------
mpriyank6da95412023-06-29 16:56:11 +0100[diff] [blame]73 - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
74 - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
75 - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]76
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]77Version: 3.3.2
78==============
79
80Release Data
81------------
82
83+--------------------------------------+--------------------------------------------------------+
84| **CPS Project** | |
85| | |
86+--------------------------------------+--------------------------------------------------------+
87| **Docker images** | onap/cps-and-ncmp:3.3.2 |
88| | |
89+--------------------------------------+--------------------------------------------------------+
90| **Release designation** | 3.3.2 Montreal |
91| | |
92+--------------------------------------+--------------------------------------------------------+
danielhanrahan19f963b2023-06-15 13:52:34 +0100[diff] [blame]93| **Release date** | 2023 June 15 |
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]94| | |
95+--------------------------------------+--------------------------------------------------------+
96
97Bug Fixes
98---------
993.3.2
danielhanrahan5cec5322023-06-15 11:08:54 +0100[diff] [blame]100 - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]101
102Features
103--------
--globalc7e5a802023-04-05 17:08:08 +0530[diff] [blame]104 - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
danielhanrahan5cec5322023-06-15 11:08:54 +0100[diff] [blame]105 - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
106 - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
107 - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
108 - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]109
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]110Version: 3.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]111==============
112
113Release Data
114------------
115
116+--------------------------------------+--------------------------------------------------------+
117| **CPS Project** | |
118| | |
119+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]120| **Docker images** | onap/cps-and-ncmp:3.3.1 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]121| | |
122+--------------------------------------+--------------------------------------------------------+
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]123| **Release designation** | 3.3.1 Montreal |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]124| | |
125+--------------------------------------+--------------------------------------------------------+
mpriyank436b75b2023-05-03 11:10:08 +0100[diff] [blame]126| **Release date** | 2023 May 03 |
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]127| | |
128+--------------------------------------+--------------------------------------------------------+
129
130Bug Fixes
131---------
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]1323.3.1
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]133 - None
134
135Features
136--------
mpriyank52c5e542023-05-02 15:58:55 +0100[diff] [blame]137 - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
138 - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
139 - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
140 - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
141 - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
halil.cakal0b8d85d2023-03-23 12:44:27 +0000[diff] [blame]142
lukegleesond7764c42023-04-20 14:11:20 +0100[diff] [blame]143Version: 3.3.0
144==============
145
146Release Data
147------------
148
149+--------------------------------------+--------------------------------------------------------+
150| **CPS Project** | |
151| | |
152+--------------------------------------+--------------------------------------------------------+
153| **Docker images** | onap/cps-and-ncmp:3.3.0 |
154| | |
155+--------------------------------------+--------------------------------------------------------+
156| **Release designation** | 3.3.0 Montreal |
157| | |
158+--------------------------------------+--------------------------------------------------------+
159| **Release date** | 2023 April 20 |
160| | |
161+--------------------------------------+--------------------------------------------------------+
162
163Bug Fixes
164---------
1653.3.0
166 - None
167
168Features
169--------
170 - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
171 - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
172
173.. ======================
174.. * * * LONDON * * *
175.. ======================
176
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]177Version: 3.2.6
178==============
179
180Release Data
181------------
182
183+--------------------------------------+--------------------------------------------------------+
184| **CPS Project** | |
185| | |
186+--------------------------------------+--------------------------------------------------------+
187| **Docker images** | onap/cps-and-ncmp:3.2.6 |
188| | |
189+--------------------------------------+--------------------------------------------------------+
190| **Release designation** | 3.2.6 London |
191| | |
192+--------------------------------------+--------------------------------------------------------+
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]193| **Release date** | 2023 March 22 |
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]194| | |
195+--------------------------------------+--------------------------------------------------------+
196
197Bug Fixes
198---------
1993.2.6
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]200 - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]201 - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]202
203Features
204--------
seanbeirnef5a3a212023-03-06 09:12:49 +0000[diff] [blame]205 - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
mpriyank0fd4d192023-03-10 13:48:20 +0000[diff] [blame]206
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]207Version: 3.2.5
208==============
209
210Release Data
211------------
212
213+--------------------------------------+--------------------------------------------------------+
214| **CPS Project** | |
215| | |
216+--------------------------------------+--------------------------------------------------------+
217| **Docker images** | onap/cps-and-ncmp:3.2.5 |
218| | |
219+--------------------------------------+--------------------------------------------------------+
220| **Release designation** | 3.2.5 London |
221| | |
222+--------------------------------------+--------------------------------------------------------+
mpriyank06bfe4e2023-03-10 11:48:23 +0000[diff] [blame]223| **Release date** | 2023 March 10 |
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]224| | |
225+--------------------------------------+--------------------------------------------------------+
226
227Bug Fixes
228---------
2293.2.5
mpriyank06bfe4e2023-03-10 11:48:23 +0000[diff] [blame]230 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
mpriyankade5a6e2023-03-09 17:58:31 +0000[diff] [blame]231
232Features
233--------
234 - None
235
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]236Version: 3.2.4
237==============
238
239Release Data
240------------
241
242+--------------------------------------+--------------------------------------------------------+
243| **CPS Project** | |
244| | |
245+--------------------------------------+--------------------------------------------------------+
246| **Docker images** | onap/cps-and-ncmp:3.2.4 |
247| | |
248+--------------------------------------+--------------------------------------------------------+
249| **Release designation** | 3.2.4 London |
250| | |
251+--------------------------------------+--------------------------------------------------------+
mpriyankbd5ba8d2023-03-09 16:33:02 +0000[diff] [blame]252| **Release date** | 2023 March 09 |
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]253| | |
254+--------------------------------------+--------------------------------------------------------+
255
256Bug Fixes
257---------
2583.2.4
mpriyankbd5ba8d2023-03-09 16:33:02 +0000[diff] [blame]259 - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
260 - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
261
262Features
263--------
264 - None
seanbeirnef0f4fd82023-03-07 13:42:04 +0000[diff] [blame]265
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]266Version: 3.2.3
267==============
268
269Release Data
270------------
271
272+--------------------------------------+--------------------------------------------------------+
273| **CPS Project** | |
274| | |
275+--------------------------------------+--------------------------------------------------------+
276| **Docker images** | onap/cps-and-ncmp:3.2.3 |
277| | |
278+--------------------------------------+--------------------------------------------------------+
279| **Release designation** | 3.2.3 London |
280| | |
281+--------------------------------------+--------------------------------------------------------+
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]282| **Release date** | 2023 March 07 |
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]283| | |
284+--------------------------------------+--------------------------------------------------------+
285
286Bug Fixes
287---------
2883.2.3
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]289 - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]290
291Features
292--------
seanbeirnef9af5f82023-03-07 10:36:18 +0000[diff] [blame]293 - `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
294 - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]295
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]296Version: 3.2.2
297==============
298
299Release Data
300------------
301
302+--------------------------------------+--------------------------------------------------------+
303| **CPS Project** | |
304| | |
305+--------------------------------------+--------------------------------------------------------+
306| **Docker images** | onap/cps-and-ncmp:3.2.2 |
307| | |
308+--------------------------------------+--------------------------------------------------------+
309| **Release designation** | 3.2.2 London |
310| | |
311+--------------------------------------+--------------------------------------------------------+
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]312| **Release date** | 2023 February 08 |
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]313| | |
314+--------------------------------------+--------------------------------------------------------+
315
316Bug Fixes
317---------
mpriyank0b5950d2023-02-07 17:55:10 +0000[diff] [blame]3183.2.2
mpriyankfd43dbe2023-02-08 11:21:08 +0000[diff] [blame]319 - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_ Delete Performance Improvements.
mpriyank0b5950d2023-02-07 17:55:10 +0000[diff] [blame]320
321Features
322--------
323 - None
seanbeirnef8e980a2023-01-27 18:09:33 +0000[diff] [blame]324
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]325Version: 3.2.1
326==============
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]327
328Release Data
329------------
330
331+--------------------------------------+--------------------------------------------------------+
332| **CPS Project** | |
333| | |
334+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]335| **Docker images** | onap/cps-and-ncmp:3.2.1 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]336| | |
337+--------------------------------------+--------------------------------------------------------+
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]338| **Release designation** | 3.2.1 London |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]339| | |
340+--------------------------------------+--------------------------------------------------------+
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]341| **Release date** | 2023 January 27 |
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]342| | |
343+--------------------------------------+--------------------------------------------------------+
Cédric Ollivier490b20d2023-03-15 21:40:48 +0100[diff] [blame]344
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]345Features
346--------
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]3473.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]348 - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_ Added support for multiple data tree instances under 1 anchor.
349 - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_ Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
350 - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_ Upgrade Opendaylight
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]351 - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_ Get all dataspaces.
352 - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_ Get single dataspace.
lukegleesonf20b4992022-12-09 15:48:55 +0000[diff] [blame]353 - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_ Added API to get all schema sets for a given dataspace.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]354 - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_ DMI audit support for NCMP: Filter on any properties of CM Handles
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]355 - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_ Added support for application/xml Content-Type (write only).
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]356 - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_ Query large outputs using limit/depth/pagination
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]357 - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_ Optimized query for large number of hits with descendants.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]358 - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_ Fetch CM handles by collection of xpaths (CPS Core)
359 - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_ Updating CmHandleStates using batch operation
360 - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_ Use native query to delete data nodes
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]361
362Bug Fixes
363---------
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]3643.2.1
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]365 - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_ Optimized retrieval of data nodes with many descendants.
366 - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_ Hazelcast TTL for IMap is not working
367 - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_ Getting wrong error code for create node api
368 - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_ Creation of DataNodeBuilder with module name prefix is very slow
369 - `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 +0000[diff] [blame]370 - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_ Add Basic Auth to CPS/NCMP OpenAPI Definitions.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]371 - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_ Handle YangChoiceNode in right format.
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]372 - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_ Fix Delete uses case with '/' in path.
lukegleesone0154a62023-01-25 15:06:52 +0000[diff] [blame]373 - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_ Fix to allow posting data with '/' key fields.
374 - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_ CPS PATCH operation does not merge existing data
375 - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_ Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
376 - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_ CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
377 - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_ CpsDataPersistenceService#getDataNodes does not handle root xpath
378 - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_ CPS Path Processing Performance Test duration is too low
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]379
leventecsanyi37d72852022-10-26 10:44:08 +0200[diff] [blame]3803.2.0
ToineSiebelink294bcb52022-12-23 11:07:42 +0000[diff] [blame]381 - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control.
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]382
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]383Known Limitations, Issues and Workarounds
384-----------------------------------------
385
386*System Limitations*
387
seanbeirne72c267e2022-10-18 12:39:22 +0100[diff] [blame]388For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
389This is from commit CPS-506: List all known modules and revision to CPS-1312: Default CMHandles to READY during upgrade or from ONAP release Honolulu to Kohn.
lukegleeson3be99242022-10-11 14:34:56 +0100[diff] [blame]390
arpitsingh2b4c4882023-03-03 21:38:57 +0530[diff] [blame]391CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
392a 400 Bad Request is sent as response. This is part of commit CPS-1526.
393
seanbeirnedba2b102022-10-27 09:59:17 +0100[diff] [blame]394.. ====================
395.. * * * KOHN * * *
396.. ====================
397
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]398Version: 3.1.4
399==============
400
401Release Data
402------------
403
404+--------------------------------------+--------------------------------------------------------+
405| **CPS Project** | |
406| | |
407+--------------------------------------+--------------------------------------------------------+
408| **Docker images** | onap/cps-and-ncmp:3.1.4 |
409| | |
410+--------------------------------------+--------------------------------------------------------+
411| **Release designation** | 3.1.4 Kohn |
412| | |
413+--------------------------------------+--------------------------------------------------------+
mpriyank4bd450e2022-10-05 09:50:59 +0100[diff] [blame]414| **Release date** | 2022 October 5 |
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]415| | |
416+--------------------------------------+--------------------------------------------------------+
417
418Bug Fixes
419---------
lukegleeson8c6b5622022-09-29 15:58:06 +0100[diff] [blame]420 - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
mpriyankac0bffc2022-10-03 12:26:10 +0100[diff] [blame]421 - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]422
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]423Version: 3.1.3
424==============
425
426Release Data
427------------
428
429+--------------------------------------+--------------------------------------------------------+
430| **CPS Project** | |
431| | |
432+--------------------------------------+--------------------------------------------------------+
433| **Docker images** | onap/cps-and-ncmp:3.1.3 |
434| | |
435+--------------------------------------+--------------------------------------------------------+
436| **Release designation** | 3.1.3 Kohn |
437| | |
438+--------------------------------------+--------------------------------------------------------+
mpriyankfe775312022-09-30 14:16:51 +0100[diff] [blame]439| **Release date** | 2022 September 29 |
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]440| | |
441+--------------------------------------+--------------------------------------------------------+
442
443Bug Fixes
444---------
445 - None
446
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]447Version: 3.1.2
448==============
449
450Release Data
451------------
452
453+--------------------------------------+--------------------------------------------------------+
454| **CPS Project** | |
455| | |
456+--------------------------------------+--------------------------------------------------------+
457| **Docker images** | onap/cps-and-ncmp:3.1.2 |
458| | |
459+--------------------------------------+--------------------------------------------------------+
460| **Release designation** | 3.1.2 Kohn |
461| | |
462+--------------------------------------+--------------------------------------------------------+
mpriyank06736cb2022-09-29 14:29:40 +0100[diff] [blame]463| **Release date** | 2022 September 28 |
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]464| | |
465+--------------------------------------+--------------------------------------------------------+
466
467Bug Fixes
468---------
469 - None
470
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]471Version: 3.1.1
472==============
473
474Release Data
475------------
476
477+--------------------------------------+--------------------------------------------------------+
478| **CPS Project** | |
479| | |
480+--------------------------------------+--------------------------------------------------------+
481| **Docker images** | onap/cps-and-ncmp:3.1.1 |
482| | |
483+--------------------------------------+--------------------------------------------------------+
484| **Release designation** | 3.1.1 Kohn |
485| | |
486+--------------------------------------+--------------------------------------------------------+
mpriyankef0ddfc2022-09-28 12:19:34 +0100[diff] [blame]487| **Release date** | 2022 September 28 |
mpriyanka3f43502022-09-26 14:57:01 +0100[diff] [blame]488| | |
489+--------------------------------------+--------------------------------------------------------+
490
491Bug Fixes
492---------
493 - None
494
lukegleesonc9ec9152022-09-07 14:21:36 +0100[diff] [blame]495Security Notes
496--------------
497
498*Fixed Security Issues*
499
500 - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
501
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]502Version: 3.1.0
503==============
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]504
505Release Data
506------------
507
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]508+--------------------------------------+--------------------------------------------------------+
509| **CPS Project** | |
510| | |
511+--------------------------------------+--------------------------------------------------------+
512| **Docker images** | onap/cps-and-ncmp:3.1.0 |
513| | |
514+--------------------------------------+--------------------------------------------------------+
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]515| **Release designation** | 3.1.0 Kohn |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]516| | |
517+--------------------------------------+--------------------------------------------------------+
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]518| **Release date** | 2022 September 14 |
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]519| | |
520+--------------------------------------+--------------------------------------------------------+
521
522Features
523--------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]524 - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
525 - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
526 - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
527 - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
528 - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
529 - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
530 - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
531 - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
532 - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
533 - `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'
534 - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
535 - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
536 - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
537 - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
538 - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
539 - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
540 - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
541 - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
542 - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
543 - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
544 - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
545 - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
546 - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
547 - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
548
emacleeafb17362022-09-02 14:40:17 +0100[diff] [blame]549
550Bug Fixes
551---------
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]552 - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
553 - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
554 - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
555 - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
556 - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
557 - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
558 - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
559 - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
560 - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
561 - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
562 - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
563 - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
564 - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
565 - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
puthuparambil.adityadd904322022-09-21 10:53:51 +0100[diff] [blame]566
567Known Limitations, Issues and Workarounds
568-----------------------------------------
569
570*System Limitations*
571
572Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
573Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
DylanB95ESTb130fd32022-04-04 13:09:22 +0100[diff] [blame]574
lukegleeson4a34fa52022-09-19 15:31:59 +0100[diff] [blame]575*Known Vulnerabilities*
576
577None
578
579*Workarounds*
580
581None
582
583Security Notes
584--------------
585
586*Fixed Security Issues*
587
588 - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
589
590*Known Security Issues*
591
592None
593
Bruno Sakoto9c3541e2022-06-15 07:57:42 -0400[diff] [blame]594.. ========================
595.. * * * JAKARTA * * *
596.. ========================
597
598Version: 3.0.1
599==============
600
601Release Data
602------------
603
604+--------------------------------------+--------------------------------------------------------+
605| **CPS Project** | |
606| | |
607+--------------------------------------+--------------------------------------------------------+
608| **Docker images** | onap/cps-and-ncmp:3.0.1 |
609| | |
610+--------------------------------------+--------------------------------------------------------+
611| **Release designation** | 3.0.1 Jakarta |
612| | |
613+--------------------------------------+--------------------------------------------------------+
614| **Release date** | 2022 April 28 |
615| | |
616+--------------------------------------+--------------------------------------------------------+
617
618Bug Fixes
619---------
620 - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
621
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]622Version: 3.0.0
623==============
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]624
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]625Release Data
626------------
627
628+--------------------------------------+--------------------------------------------------------+
629| **CPS Project** | |
630| | |
631+--------------------------------------+--------------------------------------------------------+
632| **Docker images** | onap/cps-and-ncmp:3.0.0 |
633| | |
634+--------------------------------------+--------------------------------------------------------+
635| **Release designation** | 3.0.0 Jakarta |
636| | |
637+--------------------------------------+--------------------------------------------------------+
638| **Release date** | 2022 March 15 |
639| | |
640+--------------------------------------+--------------------------------------------------------+
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]641
642Features
643--------
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]644 - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]645 - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
646 - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]647 - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]648 - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
JosephKeenan82ebf532021-12-08 18:16:44 +0000[diff] [blame]649 - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]650 - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
Bruno Sakotoa1129b62022-03-15 08:09:07 -0400[diff] [blame]651 - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
652 - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]653 - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]654 - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]655
656Bug Fixes
657---------
658
659 - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
ToineSiebelink3f142302021-12-07 11:30:10 +0000[diff] [blame]660 - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
niamhcore65bc4fd2021-12-08 14:19:02 +0000[diff] [blame]661 - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
puthuparambil.aditya71395fb2022-01-05 13:39:31 +0000[diff] [blame]662 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
puthuparambil.aditya62ac0c32022-02-03 16:42:13 +0000[diff] [blame]663 - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]664 - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]665 - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
JosephKeenane0643ab2022-02-15 18:23:05 +0000[diff] [blame]666 - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
mpriyank80dee972022-02-23 15:17:23 +0530[diff] [blame]667 - `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 +0000[diff] [blame]668 - `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 +0000[diff] [blame]669
670Known Limitations, Issues and Workarounds
671-----------------------------------------
672
673*System Limitations*
674
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]675Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
676`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
677of cm handle registration.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]678
Lathishb3550f12022-03-15 12:03:53 +0000[diff] [blame]679The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
680for more information.
681
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]682*Known Vulnerabilities*
683
684None
685
686*Workarounds*
687
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]688Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
689pass an empty string as the value if you do not want to include names for these values.
niamhcoref7b414e2021-11-17 11:02:07 +0000[diff] [blame]690
691Security Notes
692--------------
693
694*Fixed Security Issues*
695
696None
697
698*Known Security Issues*
699
700None
701
702.. ========================
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]703.. * * * ISTANBUL * * *
704.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]705
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]706Version: 2.0.4
707==============
708
709Release Data
710------------
711
712+--------------------------------------+--------------------------------------------------------+
713| **CPS Project** | |
714| | |
715+--------------------------------------+--------------------------------------------------------+
716| **Docker images** | onap/cps-and-ncmp:2.0.4 |
717| | |
718+--------------------------------------+--------------------------------------------------------+
719| **Release designation** | 2.0.4 Istanbul |
720| | |
721+--------------------------------------+--------------------------------------------------------+
722| **Release date** | 2022 Feb 09 |
723| | |
724+--------------------------------------+--------------------------------------------------------+
725
726Bug Fixes
727---------
728
729 - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
730 - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
731
732Version: 2.0.3
733==============
734
735Release Data
736------------
737
738+--------------------------------------+--------------------------------------------------------+
739| **CPS Project** | |
740| | |
741+--------------------------------------+--------------------------------------------------------+
742| **Docker images** | onap/cps-and-ncmp:2.0.3 |
743| | |
744+--------------------------------------+--------------------------------------------------------+
745| **Release designation** | 2.0.3 Istanbul |
746| | |
747+--------------------------------------+--------------------------------------------------------+
748| **Release date** | 2022-07-01 |
749| | |
750+--------------------------------------+--------------------------------------------------------+
751
752Bug Fixes
753---------
754
755 - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
756
757Version: 2.0.2
758==============
759
760Release Data
761------------
762
763+--------------------------------------+--------------------------------------------------------+
764| **CPS Project** | |
765| | |
766+--------------------------------------+--------------------------------------------------------+
767| **Docker images** | onap/cps-and-ncmp:2.0.2 |
768| | |
769+--------------------------------------+--------------------------------------------------------+
770| **Release designation** | 2.0.2 Istanbul |
771| | |
772+--------------------------------------+--------------------------------------------------------+
773| **Release date** | 2021-16-12 |
774| | |
775+--------------------------------------+--------------------------------------------------------+
776
777Bug Fixes
778---------
779
780 - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
781
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]782Version: 2.0.1
783==============
784
785Release Data
786------------
787
788+--------------------------------------+--------------------------------------------------------+
789| **CPS Project** | |
790| | |
791+--------------------------------------+--------------------------------------------------------+
792| **Docker images** | onap/cps-and-ncmp:2.0.1 |
793| | |
794+--------------------------------------+--------------------------------------------------------+
795| **Release designation** | 2.0.1 Istanbul |
796| | |
797+--------------------------------------+--------------------------------------------------------+
798| **Release date** | 2021-14-10 |
799| | |
800+--------------------------------------+--------------------------------------------------------+
801
802Bug Fixes
803---------
804
805 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
806 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
807 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
808 - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
809
810Known Limitations, Issues and Workarounds
811-----------------------------------------
812
813*System Limitations*
814
815Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
816
817*Known Vulnerabilities*
818
819 - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
820
821*Workarounds*
822
823Add recursive method to save list node data to loop through all corresponding child nodes.
824
825Security Notes
826--------------
827
828*Fixed Security Issues*
829
830 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
831
832*Known Security Issues*
833
834None
835
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]836Version: 2.0.0
837==============
838
839Abstract
840--------
841
842This document provides the release notes for Istanbul release.
843
844Release Data
845------------
846
847+--------------------------------------+--------------------------------------------------------+
848| **CPS Project** | |
849| | |
850+--------------------------------------+--------------------------------------------------------+
851| **Docker images** | onap/cps-and-ncmp:2.0.0 |
852| | |
853+--------------------------------------+--------------------------------------------------------+
854| **Release designation** | 2.0.0 Istanbul |
855| | |
856+--------------------------------------+--------------------------------------------------------+
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]857| **Release date** | 2021-14-09 |
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]858| | |
859+--------------------------------------+--------------------------------------------------------+
860
861Features
862--------
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]863* Register DMI-Plugins with NCMP for CM Handle registrations.
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]864* Update, Create and Remove CM Handles.
865* Add support for retrieving and writing CM Handle data through NCMP datastores.
866* Automatic retrieval and caching of model information for CM Handles within NCMP.
867
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]868Deliverables
869------------
870
871Software Deliverables
872
873.. csv-table::
874 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
875 :widths: auto
876
877 "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
878
879Bug Fixes
880---------
881
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]882 - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]883 - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
884 - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]885 - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
886 - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]887 - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]888 - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]889 - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
890 - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]891 - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
892 - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
893 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]894 - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
895 - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]896 - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]897 - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]898 - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
899 - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
900 - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]901 - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
902 - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
903 - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
Bruno Sakoto0eaf3342022-02-11 15:05:29 -0500[diff] [blame]904 - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]905 - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
906 - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
907 - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]908
909This document provides the release notes for Istanbul release.
910
911Summary
912-------
913
914Following CPS components are available with default ONAP/CPS installation.
915
916
917 * Platform components
918
919 - CPS (Helm charts)
920
921 * Service components
922
DylanB95EST3fcf8692021-10-11 16:29:16 +0100[diff] [blame]923 - CPS-NCMP
924 - CPS-Temporal
925 - DMI-Plugin
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]926
927 * Additional resources that CPS utilizes deployed using ONAP common charts
928
929 - Postgres Database
930
931
932Below service components (mS) are available to be deployed on-demand.
933 - CPS-TBDMT
934
935
936Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
937
938Known Limitations, Issues and Workarounds
939-----------------------------------------
940
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]941*System Limitations*
942
943Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
944
945*Known Vulnerabilities*
946
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]947 - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
948 - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
949 - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]950
951*Workarounds*
952
953Add recursive method to save list node data to loop through all corresponding child nodes.
954
955Security Notes
956--------------
957
958*Fixed Security Issues*
959
960 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]961
962*Known Security Issues*
963
lukegleeson9c583712021-09-30 17:21:11 +0100[diff] [blame]964 - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
965
shivasubedi44beaa32021-09-13 15:16:30 +0100[diff] [blame]966Test Results
967------------
968 * `Integration tests`
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]969
ToineSiebelinkf0527c52021-07-06 13:03:03 +0100[diff] [blame]970.. ========================
971.. * * * HONOLULU * * *
972.. ========================
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]973
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]974Version: 1.0.1
975==============
976
977Release Data
978------------
979
980+--------------------------------------+--------------------------------------------------------+
981| **CPS Project** | |
982| | |
983+--------------------------------------+--------------------------------------------------------+
984| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
985| | |
986+--------------------------------------+--------------------------------------------------------+
987| **Release designation** | 1.0.1 Honolulu |
988| | |
989+--------------------------------------+--------------------------------------------------------+
990| **Release date** | 2021-04-09 |
991| | |
992+--------------------------------------+--------------------------------------------------------+
993
994Bug Fixes
995---------
996
puthuparambil.aditya8b584332021-10-12 16:49:03 +0100[diff] [blame]997 - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
ToineSiebelinkfd2134d2021-04-09 11:15:48 +0100[diff] [blame]998 - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
999 - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1000 - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1001 - `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
1002 - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1003 - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1004 - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1005
1006Security Notes
1007--------------
1008
1009*Fixed Security Issues*
1010
1011 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1012
ToineSiebelinka2d25b52021-04-13 15:10:47 +0100[diff] [blame]1013*Known Security Issues*
1014
1015 - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1016
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1017Version: 1.0.0
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1018==============
1019
1020
1021Abstract
1022--------
1023
1024This document provides the release notes for Honolulu release.
1025
1026Summary
1027-------
1028
1029Following CPS components are available with default ONAP/CPS installation.
1030
1031
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1032 * Platform components
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1033
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1034 - CPS (Helm charts)
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1035
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1036 * Service components
1037
1038 - CPS Core
1039
1040 * Additional resources that CPS utilizes deployed using ONAP common charts
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1041
1042 - Postgres Database
1043
1044
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1045Below service components (mS) are available to be deployed on-demand.
1046 - CPS-TBDMT
1047
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1048
1049Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1050
1051
1052Release Data
1053------------
1054
1055+--------------------------------------+--------------------------------------------------------+
1056| **CPS Project** | |
1057| | |
1058+--------------------------------------+--------------------------------------------------------+
1059| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
1060| | |
1061+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1062| **Release designation** | 1.0.0 Honolulu |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1063| | |
1064+--------------------------------------+--------------------------------------------------------+
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1065| **Release date** | 2021-03-11 |
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1066| | |
1067+--------------------------------------+--------------------------------------------------------+
1068
1069
1070Features
1071--------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1072Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1073CPS has been driven by the needs of the E2E Networking Slicing use case.
1074It currently supports basic (rw) persistence and simple queries.
1075It also provides MVP support for network data access using simulated data.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1076
1077.. _honolulu_deliverable:
1078
1079Deliverables
1080------------
1081
1082Software Deliverables
1083
1084.. csv-table::
1085 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1086 :widths: auto
1087
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1088 "cps", "", "onap/cps-and-nf-proxy:1.0.0"
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1089
1090
1091Known Limitations, Issues and Workarounds
1092-----------------------------------------
1093
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1094 - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1095 - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1096 - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
niamhcoredddf7312021-06-21 14:44:01 +0100[diff] [blame]1097 - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ & `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Update data node leaves API does not support updating a list element with compound keys.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1098
1099*System Limitations*
1100
1101None
1102
1103*Known Vulnerabilities*
1104
1105None
1106
1107*Workarounds*
1108
1109Documented under corresponding jira if applicable.
1110
1111Security Notes
1112--------------
1113
1114*Fixed Security Issues*
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]1115
1116* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1117 - Upgrade org.onap.oparent to 3.2.0
ToineSiebelink7c981df2021-03-01 09:53:56 +0000[diff] [blame]1118 - Upgrade spring.boot to 2.3.8.RELEASE
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1119 - Upgrade yangtools to 5.0.7
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1120
1121*Known Security Issues*
1122
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1123 * Weak Crytography using md5
1124 * Risk seen in Zip file expansion
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1125
1126*Known Vulnerabilities in Used Modules*
1127
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1128 None
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1129
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1130CPS code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive.
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1131
1132Test Results
1133------------
Rishi.Chail4359d282021-03-03 16:36:26 +0000[diff] [blame]1134 * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1135
1136References
1137----------
1138
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1139For more information on the latest ONAP release, please see:
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1140
1141#. `ONAP Home Page`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1142#. `ONAP Wiki Page`_
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1143#. `ONAP Documentation`_
1144#. `ONAP CPS Documentation`_
1145#. `ONAP Release Downloads`_
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1146
1147
1148.. _`ONAP Home Page`: https://www.onap.org
1149.. _`ONAP Wiki Page`: https://wiki.onap.org
1150.. _`ONAP Documentation`: https://docs.onap.org
ToineSiebelinkcac21862023-06-22 09:24:04 +0100[diff] [blame]1151.. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
ToineSiebelinkb87f3232021-02-26 12:05:30 +0000[diff] [blame]1152.. _`ONAP Release Downloads`: https://git.onap.org
1153
1154Quick Links:
1155
1156 - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1157 - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_