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