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