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