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