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