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