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