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