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