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