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