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