Merge "Handle Subscription Response from DMI"
[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-2024 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 ..      * * *   NEW DELHI   * * *
17 ..      =========================
18
19 Version: 3.4.8
20 ==============
21
22 Release Data
23 ------------
24
25 +--------------------------------------+--------------------------------------------------------+
26 | **CPS Project**                      |                                                        |
27 |                                      |                                                        |
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images**                    | onap/cps-and-ncmp:3.4.8                                |
30 |                                      |                                                        |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation**              | 3.4.8 New Delhi                                        |
33 |                                      |                                                        |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date**                     | Not yet released                                       |
36 |                                      |                                                        |
37 +--------------------------------------+--------------------------------------------------------+
38
39 Features
40 --------
41
42 Version: 3.4.7
43 ==============
44
45 Release Data
46 ------------
47
48 +--------------------------------------+--------------------------------------------------------+
49 | **CPS Project**                      |                                                        |
50 |                                      |                                                        |
51 +--------------------------------------+--------------------------------------------------------+
52 | **Docker images**                    | onap/cps-and-ncmp:3.4.7                                |
53 |                                      |                                                        |
54 +--------------------------------------+--------------------------------------------------------+
55 | **Release designation**              | 3.4.7 New Delhi                                        |
56 |                                      |                                                        |
57 +--------------------------------------+--------------------------------------------------------+
58 | **Release date**                     | 2024 March 29                                          |
59 |                                      |                                                        |
60 +--------------------------------------+--------------------------------------------------------+
61
62 Bug Fixes
63 ---------
64 3.4.7
65     - `CPS-2150 <https://jira.onap.org/browse/CPS-2150>`_ Fix for Async task execution failed by TimeoutException.
66
67 Features
68 --------
69 3.4.7
70     - `CPS-2061 <https://jira.onap.org/browse/CPS-2061>`_ Liquibase Steps Condensing and Cleanup.
71     - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot to 3.2.4 version.
72
73 Version: 3.4.6
74 ==============
75
76 Release Data
77 ------------
78
79 +--------------------------------------+--------------------------------------------------------+
80 | **CPS Project**                      |                                                        |
81 |                                      |                                                        |
82 +--------------------------------------+--------------------------------------------------------+
83 | **Docker images**                    | onap/cps-and-ncmp:3.4.6                                |
84 |                                      |                                                        |
85 +--------------------------------------+--------------------------------------------------------+
86 | **Release designation**              | 3.4.6 New Delhi                                        |
87 |                                      |                                                        |
88 +--------------------------------------+--------------------------------------------------------+
89 | **Release date**                     | 2024 February 29                                       |
90 |                                      |                                                        |
91 +--------------------------------------+--------------------------------------------------------+
92
93 Bug Fixes
94 ---------
95 3.4.6
96     - `CPS-2126 <https://jira.onap.org/browse/CPS-2126>`_ Passing HTTP Authorization Bearer Token to DMI Plugins.
97
98
99 Features
100 --------
101     - `CPS-2133 <https://jira.onap.org/browse/CPS-2133>`_ Revert Uplift of Spring Boot version from 3.2.2 to 3.1.2
102
103 Notes
104 -----
105 This release brings improvements to compatibility with Service Mesh and for that below measures are been taken.
106
107 Basic authorization provided using Spring security is been removed from CPS-Core and NCMP and hence authorization is no longer enforced.(basic auth header will be ignored, but is still allowed).
108 NCMP will propagate a bearer token to DMI conditionally.
109 401 Unauthorized will not be returned. Best effort has been made to ensure backwards compatibility.
110
111 Version: 3.4.5
112 ==============
113
114 Release Data
115 ------------
116
117 +--------------------------------------+--------------------------------------------------------+
118 | **CPS Project**                      |                                                        |
119 |                                      |                                                        |
120 +--------------------------------------+--------------------------------------------------------+
121 | **Docker images**                    | onap/cps-and-ncmp:3.4.5                                |
122 |                                      |                                                        |
123 +--------------------------------------+--------------------------------------------------------+
124 | **Release designation**              | 3.4.5 New Delhi                                        |
125 |                                      |                                                        |
126 +--------------------------------------+--------------------------------------------------------+
127 | **Release date**                     | 2024 February 27                                       |
128 |                                      |                                                        |
129 +--------------------------------------+--------------------------------------------------------+
130
131 Bug Fixes
132 ---------
133 3.4.5
134
135
136 Features
137 --------
138     - `CPS-2101 <https://jira.onap.org/browse/CPS-2101>`_ Uplift Spring Boot version to 3.2.2
139
140
141 Version: 3.4.4
142 ==============
143
144 Release Data
145 ------------
146
147 +--------------------------------------+--------------------------------------------------------+
148 | **CPS Project**                      |                                                        |
149 |                                      |                                                        |
150 +--------------------------------------+--------------------------------------------------------+
151 | **Docker images**                    | onap/cps-and-ncmp:3.4.4                                |
152 |                                      |                                                        |
153 +--------------------------------------+--------------------------------------------------------+
154 | **Release designation**              | 3.4.4 New Delhi                                        |
155 |                                      |                                                        |
156 +--------------------------------------+--------------------------------------------------------+
157 | **Release date**                     | 2024 February 23                                       |
158 |                                      |                                                        |
159 +--------------------------------------+--------------------------------------------------------+
160
161 Bug Fixes
162 ---------
163 3.4.4
164     - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Upgrade Yang modules using module set tag functionalities fix
165
166 Features
167 --------
168     - `CPS-2057 <https://jira.onap.org/browse/CPS-2057>`_ Leaf lists are sorted by default if Yang model does not specify order.
169     - `CPS-2087 <https://jira.onap.org/browse/CPS-2087>`_ Performance improvement of CPS Path Queries.
170
171
172 Version: 3.4.3
173 ==============
174
175 Release Data
176 ------------
177
178 +--------------------------------------+--------------------------------------------------------+
179 | **CPS Project**                      |                                                        |
180 |                                      |                                                        |
181 +--------------------------------------+--------------------------------------------------------+
182 | **Docker images**                    | onap/cps-and-ncmp:3.4.3                                |
183 |                                      |                                                        |
184 +--------------------------------------+--------------------------------------------------------+
185 | **Release designation**              | 3.4.3 New Delhi                                        |
186 |                                      |                                                        |
187 +--------------------------------------+--------------------------------------------------------+
188 | **Release date**                     | 2024 February 07                                       |
189 |                                      |                                                        |
190 +--------------------------------------+--------------------------------------------------------+
191
192 Bug Fixes
193 ---------
194 3.4.3
195     - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Fix for Schema object cache not being distributed.
196     - `CPS-2027 <https://jira.onap.org/browse/CPS-2027>`_ Fixes for upgrade yang modules using module set tag.
197     - `CPS-2070 <https://jira.onap.org/browse/CPS-2070>`_ Add retry interval for Kafka consumer.
198
199 Features
200 --------
201     - `CPS-1824 <https://jira.onap.org/browse/CPS-1824>`_ CPS Delta between 2 anchors.
202     - `CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_ Add maven classifier to Spring Boot JAR.
203     - `CPS-1135 <https://jira.onap.org/browse/CPS-1135>`_ Extend CPS Module API to allow retrieval single module definition.
204
205 Notes
206 -----
207 The maven build of cps-application has been changed so that the JAR produced by spring-boot-maven-plugin has a
208 *-springboot* classifier (`CPS-2072 <https://jira.onap.org/browse/CPS-2072>`_). This means that the filename
209 of the Spring Boot JAR is *cps-application-3.4.3-springboot.jar*.
210
211 Version: 3.4.2
212 ==============
213
214 Release Data
215 ------------
216
217 +--------------------------------------+--------------------------------------------------------+
218 | **CPS Project**                      |                                                        |
219 |                                      |                                                        |
220 +--------------------------------------+--------------------------------------------------------+
221 | **Docker images**                    | onap/cps-and-ncmp:3.4.2                                |
222 |                                      |                                                        |
223 +--------------------------------------+--------------------------------------------------------+
224 | **Release designation**              | 3.4.2 New Delhi                                        |
225 |                                      |                                                        |
226 +--------------------------------------+--------------------------------------------------------+
227 | **Release date**                     | 2024 January 11                                        |
228 |                                      |                                                        |
229 +--------------------------------------+--------------------------------------------------------+
230
231 Bug Fixes
232 ---------
233 3.4.2
234
235
236 Features
237 --------
238     - `CPS-1638 <https://jira.onap.org/browse/CPS-1638>`_ Introduce trust level for CM handle.
239     - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
240     - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
241     - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
242
243 Notes
244 -----
245     - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
246
247 Known Limitations, Issues and Workarounds
248 -----------------------------------------
249
250 *System Limitations*
251
252 For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
253 (`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
254 As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
255 NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
256 Other operations (read, update, delete) are not impacted.
257
258
259 Version: 3.4.1
260 ==============
261
262 Release Data
263 ------------
264
265 +--------------------------------------+--------------------------------------------------------+
266 | **CPS Project**                      |                                                        |
267 |                                      |                                                        |
268 +--------------------------------------+--------------------------------------------------------+
269 | **Docker images**                    | onap/cps-and-ncmp:3.4.1                                |
270 |                                      |                                                        |
271 +--------------------------------------+--------------------------------------------------------+
272 | **Release designation**              | 3.4.1 New Delhi                                        |
273 |                                      |                                                        |
274 +--------------------------------------+--------------------------------------------------------+
275 | **Release date**                     | 2023 December 20                                       |
276 |                                      |                                                        |
277 +--------------------------------------+--------------------------------------------------------+
278
279 Bug Fixes
280 ---------
281 3.4.1
282     - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
283
284 Features
285 --------
286     - CPS-Temporal is no longer supported and any related documentation has been removed.
287     - `CPS-1733 <https://jira.onap.org/browse/CPS-1733>`_ Upgrade YANG schema-set for CM handle without removing and adding it.
288     - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
289     - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
290     - `CPS-2005 <https://jira.onap.org/browse/CPS-2005>`_ Removing notification feature for cps updated events ( exclusively used by cps-temporal )
291
292 Known Issues
293 ------------
294     - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
295
296
297 Version: 3.4.0
298 ==============
299
300 Release Data
301 ------------
302
303 +--------------------------------------+--------------------------------------------------------+
304 | **CPS Project**                      |                                                        |
305 |                                      |                                                        |
306 +--------------------------------------+--------------------------------------------------------+
307 | **Docker images**                    | onap/cps-and-ncmp:3.4.0                                |
308 |                                      |                                                        |
309 +--------------------------------------+--------------------------------------------------------+
310 | **Release designation**              | 3.4.0 New Delhi                                        |
311 |                                      |                                                        |
312 +--------------------------------------+--------------------------------------------------------+
313 | **Release date**                     | 2023 November 09                                       |
314 |                                      |                                                        |
315 +--------------------------------------+--------------------------------------------------------+
316
317 Bug Fixes
318 ---------
319 3.4.0
320     - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
321
322 ..      ========================
323 ..      * * *   MONTREAL   * * *
324 ..      ========================
325
326 Version: 3.3.9
327 ==============
328
329 Release Data
330 ------------
331
332 +--------------------------------------+--------------------------------------------------------+
333 | **CPS Project**                      |                                                        |
334 |                                      |                                                        |
335 +--------------------------------------+--------------------------------------------------------+
336 | **Docker images**                    | onap/cps-and-ncmp:3.3.9                                |
337 |                                      |                                                        |
338 +--------------------------------------+--------------------------------------------------------+
339 | **Release designation**              | 3.3.9 Montreal                                         |
340 |                                      |                                                        |
341 +--------------------------------------+--------------------------------------------------------+
342 | **Release date**                     | 2023 November 06                                       |
343 |                                      |                                                        |
344 +--------------------------------------+--------------------------------------------------------+
345
346 Bug Fixes
347 ---------
348 3.3.9
349     - `CPS-1923 <https://jira.onap.org/browse/CPS-1923>`_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port.
350     - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
351
352 Features
353 --------
354
355 Version: 3.3.8
356 ==============
357
358 Release Data
359 ------------
360
361 +--------------------------------------+--------------------------------------------------------+
362 | **CPS Project**                      |                                                        |
363 |                                      |                                                        |
364 +--------------------------------------+--------------------------------------------------------+
365 | **Docker images**                    | onap/cps-and-ncmp:3.3.8                                |
366 |                                      |                                                        |
367 +--------------------------------------+--------------------------------------------------------+
368 | **Release designation**              | 3.3.8 Montreal                                         |
369 |                                      |                                                        |
370 +--------------------------------------+--------------------------------------------------------+
371 | **Release date**                     | 2023 September 29                                      |
372 |                                      |                                                        |
373 +--------------------------------------+--------------------------------------------------------+
374
375 Bug Fixes
376 ---------
377 3.3.8
378
379 Features
380 --------
381     - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
382
383 Version: 3.3.7
384 ==============
385
386 Release Data
387 ------------
388
389 +--------------------------------------+--------------------------------------------------------+
390 | **CPS Project**                      |                                                        |
391 |                                      |                                                        |
392 +--------------------------------------+--------------------------------------------------------+
393 | **Docker images**                    | onap/cps-and-ncmp:3.3.7                                |
394 |                                      |                                                        |
395 +--------------------------------------+--------------------------------------------------------+
396 | **Release designation**              | 3.3.7 Montreal                                         |
397 |                                      |                                                        |
398 +--------------------------------------+--------------------------------------------------------+
399 | **Release date**                     | 2023 September 20                                      |
400 |                                      |                                                        |
401 +--------------------------------------+--------------------------------------------------------+
402
403 Bug Fixes
404 ---------
405 3.3.7
406     - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
407
408 Features
409 --------
410     - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
411
412 Note
413 ----
414 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
415
416 Version: 3.3.6
417 ==============
418
419 Release Data
420 ------------
421
422 +--------------------------------------+--------------------------------------------------------+
423 | **CPS Project**                      |                                                        |
424 |                                      |                                                        |
425 +--------------------------------------+--------------------------------------------------------+
426 | **Docker images**                    | onap/cps-and-ncmp:3.3.6                                |
427 |                                      |                                                        |
428 +--------------------------------------+--------------------------------------------------------+
429 | **Release designation**              | 3.3.6 Montreal                                         |
430 |                                      |                                                        |
431 +--------------------------------------+--------------------------------------------------------+
432 | **Release date**                     | 2023 August 23                                         |
433 |                                      |                                                        |
434 +--------------------------------------+--------------------------------------------------------+
435
436 Bug Fixes
437 ---------
438 3.3.6
439     - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
440     - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
441
442 Features
443 --------
444     - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
445     - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
446
447
448 Version: 3.3.5
449 ==============
450
451 Release Data
452 ------------
453
454 +--------------------------------------+--------------------------------------------------------+
455 | **CPS Project**                      |                                                        |
456 |                                      |                                                        |
457 +--------------------------------------+--------------------------------------------------------+
458 | **Docker images**                    | onap/cps-and-ncmp:3.3.5                                |
459 |                                      |                                                        |
460 +--------------------------------------+--------------------------------------------------------+
461 | **Release designation**              | 3.3.5 Montreal                                         |
462 |                                      |                                                        |
463 +--------------------------------------+--------------------------------------------------------+
464 | **Release date**                     | 2023 July 21                                           |
465 |                                      |                                                        |
466 +--------------------------------------+--------------------------------------------------------+
467
468 Bug Fixes
469 ---------
470 3.3.5
471
472 Features
473 --------
474     - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
475
476 Version: 3.3.4
477 ==============
478
479 Release Data
480 ------------
481
482 +--------------------------------------+--------------------------------------------------------+
483 | **CPS Project**                      |                                                        |
484 |                                      |                                                        |
485 +--------------------------------------+--------------------------------------------------------+
486 | **Docker images**                    | onap/cps-and-ncmp:3.3.4                                |
487 |                                      |                                                        |
488 +--------------------------------------+--------------------------------------------------------+
489 | **Release designation**              | 3.3.4 Montreal                                         |
490 |                                      |                                                        |
491 +--------------------------------------+--------------------------------------------------------+
492 | **Release date**                     | 2023 July 19                                           |
493 |                                      |                                                        |
494 +--------------------------------------+--------------------------------------------------------+
495
496 Bug Fixes
497 ---------
498 3.3.4
499
500 Features
501 --------
502     - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
503
504 Version: 3.3.3
505 ==============
506
507 Release Data
508 ------------
509
510 +--------------------------------------+--------------------------------------------------------+
511 | **CPS Project**                      |                                                        |
512 |                                      |                                                        |
513 +--------------------------------------+--------------------------------------------------------+
514 | **Docker images**                    | onap/cps-and-ncmp:3.3.3                                |
515 |                                      |                                                        |
516 +--------------------------------------+--------------------------------------------------------+
517 | **Release designation**              | 3.3.3 Montreal                                         |
518 |                                      |                                                        |
519 +--------------------------------------+--------------------------------------------------------+
520 | **Release date**                     | 2023 June 30                                           |
521 |                                      |                                                        |
522 +--------------------------------------+--------------------------------------------------------+
523
524 Bug Fixes
525 ---------
526 3.3.3
527
528 Features
529 --------
530     - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
531     - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
532     - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
533
534 Version: 3.3.2
535 ==============
536
537 Release Data
538 ------------
539
540 +--------------------------------------+--------------------------------------------------------+
541 | **CPS Project**                      |                                                        |
542 |                                      |                                                        |
543 +--------------------------------------+--------------------------------------------------------+
544 | **Docker images**                    | onap/cps-and-ncmp:3.3.2                                |
545 |                                      |                                                        |
546 +--------------------------------------+--------------------------------------------------------+
547 | **Release designation**              | 3.3.2 Montreal                                         |
548 |                                      |                                                        |
549 +--------------------------------------+--------------------------------------------------------+
550 | **Release date**                     | 2023 June 15                                           |
551 |                                      |                                                        |
552 +--------------------------------------+--------------------------------------------------------+
553
554 Bug Fixes
555 ---------
556 3.3.2
557     - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
558
559 Features
560 --------
561     - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
562     - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
563     - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
564     - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
565     - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
566
567 Version: 3.3.1
568 ==============
569
570 Release Data
571 ------------
572
573 +--------------------------------------+--------------------------------------------------------+
574 | **CPS Project**                      |                                                        |
575 |                                      |                                                        |
576 +--------------------------------------+--------------------------------------------------------+
577 | **Docker images**                    | onap/cps-and-ncmp:3.3.1                                |
578 |                                      |                                                        |
579 +--------------------------------------+--------------------------------------------------------+
580 | **Release designation**              | 3.3.1 Montreal                                         |
581 |                                      |                                                        |
582 +--------------------------------------+--------------------------------------------------------+
583 | **Release date**                     | 2023 May 03                                            |
584 |                                      |                                                        |
585 +--------------------------------------+--------------------------------------------------------+
586
587 Bug Fixes
588 ---------
589 3.3.1
590     - None
591
592 Features
593 --------
594     - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
595     - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
596     - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
597     - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
598     - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
599
600 Version: 3.3.0
601 ==============
602
603 Release Data
604 ------------
605
606 +--------------------------------------+--------------------------------------------------------+
607 | **CPS Project**                      |                                                        |
608 |                                      |                                                        |
609 +--------------------------------------+--------------------------------------------------------+
610 | **Docker images**                    | onap/cps-and-ncmp:3.3.0                                |
611 |                                      |                                                        |
612 +--------------------------------------+--------------------------------------------------------+
613 | **Release designation**              | 3.3.0 Montreal                                         |
614 |                                      |                                                        |
615 +--------------------------------------+--------------------------------------------------------+
616 | **Release date**                     | 2023 April 20                                          |
617 |                                      |                                                        |
618 +--------------------------------------+--------------------------------------------------------+
619
620 Bug Fixes
621 ---------
622 3.3.0
623     - None
624
625 Features
626 --------
627     - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
628     - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
629
630 ..      ======================
631 ..      * * *   LONDON   * * *
632 ..      ======================
633
634 Version: 3.2.6
635 ==============
636
637 Release Data
638 ------------
639
640 +--------------------------------------+--------------------------------------------------------+
641 | **CPS Project**                      |                                                        |
642 |                                      |                                                        |
643 +--------------------------------------+--------------------------------------------------------+
644 | **Docker images**                    | onap/cps-and-ncmp:3.2.6                                |
645 |                                      |                                                        |
646 +--------------------------------------+--------------------------------------------------------+
647 | **Release designation**              | 3.2.6 London                                           |
648 |                                      |                                                        |
649 +--------------------------------------+--------------------------------------------------------+
650 | **Release date**                     | 2023 March 22                                          |
651 |                                      |                                                        |
652 +--------------------------------------+--------------------------------------------------------+
653
654 Bug Fixes
655 ---------
656 3.2.6
657     - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
658     - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
659
660 Features
661 --------
662     - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
663
664 Version: 3.2.5
665 ==============
666
667 Release Data
668 ------------
669
670 +--------------------------------------+--------------------------------------------------------+
671 | **CPS Project**                      |                                                        |
672 |                                      |                                                        |
673 +--------------------------------------+--------------------------------------------------------+
674 | **Docker images**                    | onap/cps-and-ncmp:3.2.5                                |
675 |                                      |                                                        |
676 +--------------------------------------+--------------------------------------------------------+
677 | **Release designation**              | 3.2.5 London                                           |
678 |                                      |                                                        |
679 +--------------------------------------+--------------------------------------------------------+
680 | **Release date**                     | 2023 March 10                                          |
681 |                                      |                                                        |
682 +--------------------------------------+--------------------------------------------------------+
683
684 Bug Fixes
685 ---------
686 3.2.5
687     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
688
689 Features
690 --------
691     - None
692
693 Version: 3.2.4
694 ==============
695
696 Release Data
697 ------------
698
699 +--------------------------------------+--------------------------------------------------------+
700 | **CPS Project**                      |                                                        |
701 |                                      |                                                        |
702 +--------------------------------------+--------------------------------------------------------+
703 | **Docker images**                    | onap/cps-and-ncmp:3.2.4                                |
704 |                                      |                                                        |
705 +--------------------------------------+--------------------------------------------------------+
706 | **Release designation**              | 3.2.4 London                                           |
707 |                                      |                                                        |
708 +--------------------------------------+--------------------------------------------------------+
709 | **Release date**                     | 2023 March 09                                          |
710 |                                      |                                                        |
711 +--------------------------------------+--------------------------------------------------------+
712
713 Bug Fixes
714 ---------
715 3.2.4
716     - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
717     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
718
719 Features
720 --------
721     - None
722
723 Version: 3.2.3
724 ==============
725
726 Release Data
727 ------------
728
729 +--------------------------------------+--------------------------------------------------------+
730 | **CPS Project**                      |                                                        |
731 |                                      |                                                        |
732 +--------------------------------------+--------------------------------------------------------+
733 | **Docker images**                    | onap/cps-and-ncmp:3.2.3                                |
734 |                                      |                                                        |
735 +--------------------------------------+--------------------------------------------------------+
736 | **Release designation**              | 3.2.3 London                                           |
737 |                                      |                                                        |
738 +--------------------------------------+--------------------------------------------------------+
739 | **Release date**                     | 2023 March 07                                          |
740 |                                      |                                                        |
741 +--------------------------------------+--------------------------------------------------------+
742
743 Bug Fixes
744 ---------
745 3.2.3
746    - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
747
748 Features
749 --------
750     - `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
751     - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
752
753 Version: 3.2.2
754 ==============
755
756 Release Data
757 ------------
758
759 +--------------------------------------+--------------------------------------------------------+
760 | **CPS Project**                      |                                                        |
761 |                                      |                                                        |
762 +--------------------------------------+--------------------------------------------------------+
763 | **Docker images**                    | onap/cps-and-ncmp:3.2.2                                |
764 |                                      |                                                        |
765 +--------------------------------------+--------------------------------------------------------+
766 | **Release designation**              | 3.2.2 London                                           |
767 |                                      |                                                        |
768 +--------------------------------------+--------------------------------------------------------+
769 | **Release date**                     | 2023 February 08                                       |
770 |                                      |                                                        |
771 +--------------------------------------+--------------------------------------------------------+
772
773 Bug Fixes
774 ---------
775 3.2.2
776    - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_  Delete Performance Improvements.
777
778 Features
779 --------
780    - None
781
782 Version: 3.2.1
783 ==============
784
785 Release Data
786 ------------
787
788 +--------------------------------------+--------------------------------------------------------+
789 | **CPS Project**                      |                                                        |
790 |                                      |                                                        |
791 +--------------------------------------+--------------------------------------------------------+
792 | **Docker images**                    | onap/cps-and-ncmp:3.2.1                                |
793 |                                      |                                                        |
794 +--------------------------------------+--------------------------------------------------------+
795 | **Release designation**              | 3.2.1 London                                           |
796 |                                      |                                                        |
797 +--------------------------------------+--------------------------------------------------------+
798 | **Release date**                     | 2023 January 27                                        |
799 |                                      |                                                        |
800 +--------------------------------------+--------------------------------------------------------+
801
802 Features
803 --------
804 3.2.1
805    - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_  Added support for multiple data tree instances under 1 anchor.
806    - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_  Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
807    - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_  Upgrade Opendaylight
808    - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_  Get all dataspaces.
809    - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_  Get single dataspace.
810    - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_  Added API to get all schema sets for a given dataspace.
811    - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_  DMI audit support for NCMP: Filter on any properties of CM Handles
812    - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_  Added support for application/xml Content-Type (write only).
813    - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_  Query large outputs using limit/depth/pagination
814    - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_  Optimized query for large number of hits with descendants.
815    - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_  Fetch CM handles by collection of xpaths (CPS Core)
816    - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_  Updating CmHandleStates using batch operation
817    - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_  Use native query to delete data nodes
818
819 Bug Fixes
820 ---------
821 3.2.1
822    - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_  Optimized retrieval of data nodes with many descendants.
823    - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_  Hazelcast TTL for IMap is not working
824    - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_  Getting wrong error code for create node api
825    - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_  Creation of DataNodeBuilder with module name prefix is very slow
826    - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_  Top level container (prefix) is not always the first module
827    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
828    - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_  Handle YangChoiceNode in right format.
829    - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_  Fix Delete uses case with '/' in path.
830    - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_  Fix to allow posting data with '/' key fields.
831    - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_  CPS PATCH operation does not merge existing data
832    - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_  Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
833    - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_  CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
834    - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_  CpsDataPersistenceService#getDataNodes does not handle root xpath
835    - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_  CPS Path Processing Performance Test duration is too low
836
837 3.2.0
838    - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_  CPS(/NCMP) does not have version control.
839
840 Known Limitations, Issues and Workarounds
841 -----------------------------------------
842
843 *System Limitations*
844
845 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
846 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.
847
848 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
849 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
850
851 ..      ====================
852 ..      * * *   KOHN   * * *
853 ..      ====================
854
855 Version: 3.1.4
856 ==============
857
858 Release Data
859 ------------
860
861 +--------------------------------------+--------------------------------------------------------+
862 | **CPS Project**                      |                                                        |
863 |                                      |                                                        |
864 +--------------------------------------+--------------------------------------------------------+
865 | **Docker images**                    | onap/cps-and-ncmp:3.1.4                                |
866 |                                      |                                                        |
867 +--------------------------------------+--------------------------------------------------------+
868 | **Release designation**              | 3.1.4 Kohn                                             |
869 |                                      |                                                        |
870 +--------------------------------------+--------------------------------------------------------+
871 | **Release date**                     | 2022 October 5                                         |
872 |                                      |                                                        |
873 +--------------------------------------+--------------------------------------------------------+
874
875 Bug Fixes
876 ---------
877    - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_  Revision field should not be required (NotNull) on cps-ri YangResourceEntity
878    - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_  Kafka communication fault caused cmHandle registration error
879
880 Version: 3.1.3
881 ==============
882
883 Release Data
884 ------------
885
886 +--------------------------------------+--------------------------------------------------------+
887 | **CPS Project**                      |                                                        |
888 |                                      |                                                        |
889 +--------------------------------------+--------------------------------------------------------+
890 | **Docker images**                    | onap/cps-and-ncmp:3.1.3                                |
891 |                                      |                                                        |
892 +--------------------------------------+--------------------------------------------------------+
893 | **Release designation**              | 3.1.3 Kohn                                             |
894 |                                      |                                                        |
895 +--------------------------------------+--------------------------------------------------------+
896 | **Release date**                     | 2022 September 29                                      |
897 |                                      |                                                        |
898 +--------------------------------------+--------------------------------------------------------+
899
900 Bug Fixes
901 ---------
902    - None
903
904 Version: 3.1.2
905 ==============
906
907 Release Data
908 ------------
909
910 +--------------------------------------+--------------------------------------------------------+
911 | **CPS Project**                      |                                                        |
912 |                                      |                                                        |
913 +--------------------------------------+--------------------------------------------------------+
914 | **Docker images**                    | onap/cps-and-ncmp:3.1.2                                |
915 |                                      |                                                        |
916 +--------------------------------------+--------------------------------------------------------+
917 | **Release designation**              | 3.1.2 Kohn                                             |
918 |                                      |                                                        |
919 +--------------------------------------+--------------------------------------------------------+
920 | **Release date**                     | 2022 September 28                                      |
921 |                                      |                                                        |
922 +--------------------------------------+--------------------------------------------------------+
923
924 Bug Fixes
925 ---------
926    - None
927
928 Version: 3.1.1
929 ==============
930
931 Release Data
932 ------------
933
934 +--------------------------------------+--------------------------------------------------------+
935 | **CPS Project**                      |                                                        |
936 |                                      |                                                        |
937 +--------------------------------------+--------------------------------------------------------+
938 | **Docker images**                    | onap/cps-and-ncmp:3.1.1                                |
939 |                                      |                                                        |
940 +--------------------------------------+--------------------------------------------------------+
941 | **Release designation**              | 3.1.1 Kohn                                             |
942 |                                      |                                                        |
943 +--------------------------------------+--------------------------------------------------------+
944 | **Release date**                     | 2022 September 28                                      |
945 |                                      |                                                        |
946 +--------------------------------------+--------------------------------------------------------+
947
948 Bug Fixes
949 ---------
950    - None
951
952 Security Notes
953 --------------
954
955 *Fixed Security Issues*
956
957    - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_  Security bug in the logs
958
959 Version: 3.1.0
960 ==============
961
962 Release Data
963 ------------
964
965 +--------------------------------------+--------------------------------------------------------+
966 | **CPS Project**                      |                                                        |
967 |                                      |                                                        |
968 +--------------------------------------+--------------------------------------------------------+
969 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
970 |                                      |                                                        |
971 +--------------------------------------+--------------------------------------------------------+
972 | **Release designation**              | 3.1.0 Kohn                                             |
973 |                                      |                                                        |
974 +--------------------------------------+--------------------------------------------------------+
975 | **Release date**                     | 2022 September 14                                      |
976 |                                      |                                                        |
977 +--------------------------------------+--------------------------------------------------------+
978
979 Features
980 --------
981    - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_  Patch and update the root data node
982    - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
983    - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_  Query based on Public CM Properties
984    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
985    - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_  Async: Internal message topic incl. basic producer & Consumer
986    - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_  DMI-NCMP Asynchronously Publish Response Event to Client Topic
987    - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_  Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
988    - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_  Align CPS-Core output with SDN-C output (add module name)
989    - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_  CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
990    - `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'
991    - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_  Start and stop sessions on Java API
992    - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_  Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
993    - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_  Structured Errors response for passthrough use-cases in NCMP
994    - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_  Update maven deploy plugin version
995    - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_  Query CM Handles using CpsPath
996    - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_  Create Data Synchronization watchdog
997    - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_  Merge 2 'query' end points in NCMP
998    - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_  Publish lifecycle events for ADVISED , READY and LOCKED state transition"
999    - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_  Support retrieval of YANG module sources for CM handle on the NCMP interface
1000    - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_  Expose simplified 'external' lock reason enum state over REST interface
1001    - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_  Introducing the DELETING and DELETED Cmhandle State
1002    - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_  Register the Cmhandle Sends Advised State notification.
1003    - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_  Enable/Disable Data Sync for Cm Handle
1004    - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_  DMI Audit Support (get all CM Handles for a registered DMI)
1005
1006
1007 Bug Fixes
1008 ---------
1009    - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_  CM Handle Registration Process only partially completes when exception is thrown
1010    - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_  NCMP: fix getResourceDataForPassthroughOperational endpoint
1011    - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_  DuplicatedYangResourceException error at parallel cmHandle registration
1012    - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_  Wrong error response format in case of Dmi plugin error
1013    - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_  NCMP returns 500 error on searches endpoint when No DMI Handles registered
1014    - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_  Performance degradation on ncmp/v1/ch/searches endpoint
1015    - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_  Kafka consumer can not be turned off
1016    - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_  Unable to change state from LOCKED to ADVISED
1017    - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_  CmHandle creation performance degradation
1018    - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_  Incorrect response when empty body executed for cmhandle id-searches
1019    - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_  Node API - GET method returns invalid response when identifier contains '/'
1020    - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_  Additional Properties for CM Handles not included when send to DMI Plugin
1021    - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_  Searches endpoint gives back empty list however there are already available cmhandles
1022    - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_  NCMP logs are flooded with SyncUtils logs
1023
1024 Known Limitations, Issues and Workarounds
1025 -----------------------------------------
1026
1027 *System Limitations*
1028
1029 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
1030 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
1031
1032 *Known Vulnerabilities*
1033
1034 None
1035
1036 *Workarounds*
1037
1038 None
1039
1040 Security Notes
1041 --------------
1042
1043 *Fixed Security Issues*
1044
1045    - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_  Liquibase has got serious vulnerability, upgrade required
1046
1047 *Known Security Issues*
1048
1049 None
1050
1051 ..      ========================
1052 ..      * * *   JAKARTA   * * *
1053 ..      ========================
1054
1055 Version: 3.0.1
1056 ==============
1057
1058 Release Data
1059 ------------
1060
1061 +--------------------------------------+--------------------------------------------------------+
1062 | **CPS Project**                      |                                                        |
1063 |                                      |                                                        |
1064 +--------------------------------------+--------------------------------------------------------+
1065 | **Docker images**                    | onap/cps-and-ncmp:3.0.1                                |
1066 |                                      |                                                        |
1067 +--------------------------------------+--------------------------------------------------------+
1068 | **Release designation**              | 3.0.1 Jakarta                                          |
1069 |                                      |                                                        |
1070 +--------------------------------------+--------------------------------------------------------+
1071 | **Release date**                     | 2022 April 28                                          |
1072 |                                      |                                                        |
1073 +--------------------------------------+--------------------------------------------------------+
1074
1075 Bug Fixes
1076 ---------
1077    - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_  Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
1078
1079 Version: 3.0.0
1080 ==============
1081
1082 Release Data
1083 ------------
1084
1085 +--------------------------------------+--------------------------------------------------------+
1086 | **CPS Project**                      |                                                        |
1087 |                                      |                                                        |
1088 +--------------------------------------+--------------------------------------------------------+
1089 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
1090 |                                      |                                                        |
1091 +--------------------------------------+--------------------------------------------------------+
1092 | **Release designation**              | 3.0.0 Jakarta                                          |
1093 |                                      |                                                        |
1094 +--------------------------------------+--------------------------------------------------------+
1095 | **Release date**                     | 2022 March 15                                          |
1096 |                                      |                                                        |
1097 +--------------------------------------+--------------------------------------------------------+
1098
1099 Features
1100 --------
1101    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
1102    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
1103    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
1104    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
1105    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
1106    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
1107    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
1108    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
1109    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
1110    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
1111    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
1112
1113 Bug Fixes
1114 ---------
1115
1116    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
1117    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
1118    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
1119    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
1120    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
1121    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
1122    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
1123    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
1124    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
1125    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
1126
1127 Known Limitations, Issues and Workarounds
1128 -----------------------------------------
1129
1130 *System Limitations*
1131
1132 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
1133 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
1134 of cm handle registration.
1135
1136 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
1137 for more information.
1138
1139 *Known Vulnerabilities*
1140
1141 None
1142
1143 *Workarounds*
1144
1145 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
1146 pass an empty string as the value if you do not want to include names for these values.
1147
1148 Security Notes
1149 --------------
1150
1151 *Fixed Security Issues*
1152
1153 None
1154
1155 *Known Security Issues*
1156
1157 None
1158
1159 ..      ========================
1160 ..      * * *   ISTANBUL   * * *
1161 ..      ========================
1162
1163 Version: 2.0.4
1164 ==============
1165
1166 Release Data
1167 ------------
1168
1169 +--------------------------------------+--------------------------------------------------------+
1170 | **CPS Project**                      |                                                        |
1171 |                                      |                                                        |
1172 +--------------------------------------+--------------------------------------------------------+
1173 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
1174 |                                      |                                                        |
1175 +--------------------------------------+--------------------------------------------------------+
1176 | **Release designation**              | 2.0.4 Istanbul                                         |
1177 |                                      |                                                        |
1178 +--------------------------------------+--------------------------------------------------------+
1179 | **Release date**                     | 2022 Feb 09                                            |
1180 |                                      |                                                        |
1181 +--------------------------------------+--------------------------------------------------------+
1182
1183 Bug Fixes
1184 ---------
1185
1186    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
1187    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
1188
1189 Version: 2.0.3
1190 ==============
1191
1192 Release Data
1193 ------------
1194
1195 +--------------------------------------+--------------------------------------------------------+
1196 | **CPS Project**                      |                                                        |
1197 |                                      |                                                        |
1198 +--------------------------------------+--------------------------------------------------------+
1199 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
1200 |                                      |                                                        |
1201 +--------------------------------------+--------------------------------------------------------+
1202 | **Release designation**              | 2.0.3 Istanbul                                         |
1203 |                                      |                                                        |
1204 +--------------------------------------+--------------------------------------------------------+
1205 | **Release date**                     | 2022-07-01                                             |
1206 |                                      |                                                        |
1207 +--------------------------------------+--------------------------------------------------------+
1208
1209 Bug Fixes
1210 ---------
1211
1212    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
1213
1214 Version: 2.0.2
1215 ==============
1216
1217 Release Data
1218 ------------
1219
1220 +--------------------------------------+--------------------------------------------------------+
1221 | **CPS Project**                      |                                                        |
1222 |                                      |                                                        |
1223 +--------------------------------------+--------------------------------------------------------+
1224 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
1225 |                                      |                                                        |
1226 +--------------------------------------+--------------------------------------------------------+
1227 | **Release designation**              | 2.0.2 Istanbul                                         |
1228 |                                      |                                                        |
1229 +--------------------------------------+--------------------------------------------------------+
1230 | **Release date**                     | 2021-16-12                                             |
1231 |                                      |                                                        |
1232 +--------------------------------------+--------------------------------------------------------+
1233
1234 Bug Fixes
1235 ---------
1236
1237    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
1238
1239 Version: 2.0.1
1240 ==============
1241
1242 Release Data
1243 ------------
1244
1245 +--------------------------------------+--------------------------------------------------------+
1246 | **CPS Project**                      |                                                        |
1247 |                                      |                                                        |
1248 +--------------------------------------+--------------------------------------------------------+
1249 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
1250 |                                      |                                                        |
1251 +--------------------------------------+--------------------------------------------------------+
1252 | **Release designation**              | 2.0.1 Istanbul                                         |
1253 |                                      |                                                        |
1254 +--------------------------------------+--------------------------------------------------------+
1255 | **Release date**                     | 2021-14-10                                             |
1256 |                                      |                                                        |
1257 +--------------------------------------+--------------------------------------------------------+
1258
1259 Bug Fixes
1260 ---------
1261
1262    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1263    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1264    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1265    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1266
1267 Known Limitations, Issues and Workarounds
1268 -----------------------------------------
1269
1270 *System Limitations*
1271
1272 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1273
1274 *Known Vulnerabilities*
1275
1276    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1277
1278 *Workarounds*
1279
1280 Add recursive method to save list node data to loop through all corresponding child nodes.
1281
1282 Security Notes
1283 --------------
1284
1285 *Fixed Security Issues*
1286
1287    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1288
1289 *Known Security Issues*
1290
1291 None
1292
1293 Version: 2.0.0
1294 ==============
1295
1296 Abstract
1297 --------
1298
1299 This document provides the release notes for Istanbul release.
1300
1301 Release Data
1302 ------------
1303
1304 +--------------------------------------+--------------------------------------------------------+
1305 | **CPS Project**                      |                                                        |
1306 |                                      |                                                        |
1307 +--------------------------------------+--------------------------------------------------------+
1308 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
1309 |                                      |                                                        |
1310 +--------------------------------------+--------------------------------------------------------+
1311 | **Release designation**              | 2.0.0 Istanbul                                         |
1312 |                                      |                                                        |
1313 +--------------------------------------+--------------------------------------------------------+
1314 | **Release date**                     | 2021-14-09                                             |
1315 |                                      |                                                        |
1316 +--------------------------------------+--------------------------------------------------------+
1317
1318 Features
1319 --------
1320 * Register DMI-Plugins with NCMP for CM Handle registrations.
1321 * Update, Create and Remove CM Handles.
1322 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1323 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1324
1325 Deliverables
1326 ------------
1327
1328 Software Deliverables
1329
1330 .. csv-table::
1331    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1332    :widths: auto
1333
1334    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1335
1336 Bug Fixes
1337 ---------
1338
1339    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1340    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1341    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1342    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1343    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1344    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1345    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1346    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1347    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1348    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1349    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1350    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1351    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1352    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1353    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1354    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1355    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1356    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1357    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1358    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1359    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1360    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1361    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1362    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1363    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1364    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1365
1366 This document provides the release notes for Istanbul release.
1367
1368 Summary
1369 -------
1370
1371 Following CPS components are available with default ONAP/CPS installation.
1372
1373
1374     * Platform components
1375
1376         - CPS (Helm charts)
1377
1378     * Service components
1379
1380         - CPS-NCMP
1381         - DMI-Plugin
1382
1383     * Additional resources that CPS utilizes deployed using ONAP common charts
1384
1385         - Postgres Database
1386
1387
1388 Below service components (mS) are available to be deployed on-demand.
1389     - CPS-TBDMT
1390
1391
1392 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1393
1394 Known Limitations, Issues and Workarounds
1395 -----------------------------------------
1396
1397 *System Limitations*
1398
1399 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1400
1401 *Known Vulnerabilities*
1402
1403    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1404    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1405    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1406
1407 *Workarounds*
1408
1409 Add recursive method to save list node data to loop through all corresponding child nodes.
1410
1411 Security Notes
1412 --------------
1413
1414 *Fixed Security Issues*
1415
1416    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1417
1418 *Known Security Issues*
1419
1420    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1421
1422 Test Results
1423 ------------
1424     * `Integration tests`
1425
1426 ..      ========================
1427 ..      * * *   HONOLULU   * * *
1428 ..      ========================
1429
1430 Version: 1.0.1
1431 ==============
1432
1433 Release Data
1434 ------------
1435
1436 +--------------------------------------+--------------------------------------------------------+
1437 | **CPS Project**                      |                                                        |
1438 |                                      |                                                        |
1439 +--------------------------------------+--------------------------------------------------------+
1440 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
1441 |                                      |                                                        |
1442 +--------------------------------------+--------------------------------------------------------+
1443 | **Release designation**              | 1.0.1 Honolulu                                         |
1444 |                                      |                                                        |
1445 +--------------------------------------+--------------------------------------------------------+
1446 | **Release date**                     | 2021-04-09                                             |
1447 |                                      |                                                        |
1448 +--------------------------------------+--------------------------------------------------------+
1449
1450 Bug Fixes
1451 ---------
1452
1453    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1454    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1455    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1456    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1457    - `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
1458    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1459    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1460    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1461
1462 Security Notes
1463 --------------
1464
1465 *Fixed Security Issues*
1466
1467    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1468
1469 *Known Security Issues*
1470
1471    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1472
1473 Version: 1.0.0
1474 ==============
1475
1476
1477 Abstract
1478 --------
1479
1480 This document provides the release notes for Honolulu release.
1481
1482 Summary
1483 -------
1484
1485 Following CPS components are available with default ONAP/CPS installation.
1486
1487
1488     * Platform components
1489
1490         - CPS (Helm charts)
1491
1492     * Service components
1493
1494         - CPS Core
1495
1496     * Additional resources that CPS utilizes deployed using ONAP common charts
1497
1498         - Postgres Database
1499
1500
1501 Below service components (mS) are available to be deployed on-demand.
1502     - CPS-TBDMT
1503
1504
1505 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1506
1507
1508 Release Data
1509 ------------
1510
1511 +--------------------------------------+--------------------------------------------------------+
1512 | **CPS Project**                      |                                                        |
1513 |                                      |                                                        |
1514 +--------------------------------------+--------------------------------------------------------+
1515 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
1516 |                                      |                                                        |
1517 +--------------------------------------+--------------------------------------------------------+
1518 | **Release designation**              | 1.0.0 Honolulu                                         |
1519 |                                      |                                                        |
1520 +--------------------------------------+--------------------------------------------------------+
1521 | **Release date**                     | 2021-03-11                                             |
1522 |                                      |                                                        |
1523 +--------------------------------------+--------------------------------------------------------+
1524
1525
1526 Features
1527 --------
1528 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1529 CPS has been driven by the needs of the E2E Networking Slicing use case.
1530 It currently supports basic (rw) persistence and simple queries.
1531 It also provides MVP support for network data access using simulated data.
1532
1533 .. _honolulu_deliverable:
1534
1535 Deliverables
1536 ------------
1537
1538 Software Deliverables
1539
1540 .. csv-table::
1541    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1542    :widths: auto
1543
1544    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1545
1546
1547 Known Limitations, Issues and Workarounds
1548 -----------------------------------------
1549
1550    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1551    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1552    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1553    - `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.
1554
1555 *System Limitations*
1556
1557 None
1558
1559 *Known Vulnerabilities*
1560
1561 None
1562
1563 *Workarounds*
1564
1565 Documented under corresponding jira if applicable.
1566
1567 Security Notes
1568 --------------
1569
1570 *Fixed Security Issues*
1571
1572 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1573     - Upgrade org.onap.oparent to 3.2.0
1574     - Upgrade spring.boot to 2.3.8.RELEASE
1575     - Upgrade yangtools to 5.0.7
1576
1577 *Known Security Issues*
1578
1579     * Weak Cryptography using md5
1580     * Risk seen in Zip file expansion
1581
1582 *Known Vulnerabilities in Used Modules*
1583
1584     None
1585
1586 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.
1587
1588 Test Results
1589 ------------
1590     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1591
1592 References
1593 ----------
1594
1595 For more information on the latest ONAP release, please see:
1596
1597 #. `ONAP Home Page`_
1598 #. `ONAP Wiki Page`_
1599 #. `ONAP Documentation`_
1600 #. `ONAP CPS Documentation`_
1601 #. `ONAP Release Downloads`_
1602
1603
1604 .. _`ONAP Home Page`: https://www.onap.org
1605 .. _`ONAP Wiki Page`: https://wiki.onap.org
1606 .. _`ONAP Documentation`: https://docs.onap.org
1607 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1608 .. _`ONAP Release Downloads`: https://git.onap.org
1609
1610 Quick Links:
1611
1612         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1613         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_