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