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