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