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