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