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