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