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