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