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