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