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