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