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