1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright (C) 2021-2022 Nordix Foundation
.. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
.. _release_notes:
CPS Release Notes
#################
.. contents::
:depth: 2
..
.. ====================
.. * * * KOHN * * *
.. ====================
Version: 3.1.6 (not yet released)
=================================
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.6 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.6 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | (not yet released) |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- None
Version: 3.1.5
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.5 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.5 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 October 25 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_ CPS(/NCMP) does not have version control
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
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.
.. ====================
.. * * * KOHN * * *
.. ====================
Version: 3.1.4
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.4 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.4 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 October 5 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_ Revision field should not be required (NotNull) on cps-ri YangResourceEntity
- `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_ Kafka communication fault caused cmHandle registration error
Version: 3.1.3
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.3 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.3 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 September 29 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- None
Version: 3.1.2
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.2 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.2 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 September 28 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- None
Version: 3.1.1
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.1 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.1 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 September 28 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- None
Security Notes
--------------
*Fixed Security Issues*
- `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_ Security bug in the logs
Version: 3.1.0
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.1.0 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.1.0 Kohn |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 September 14 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
- `CPS-340 <https://jira.onap.org/browse/CPS-340>`_ Patch and update the root data node
- `CPS-575 <https://jira.onap.org/browse/CPS-575>`_ Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
- `CPS-731 <https://jira.onap.org/browse/CPS-731>`_ Query based on Public CM Properties
- `CPS-828 <https://jira.onap.org/browse/CPS-828>`_ Async: NCMP Rest impl. including Request ID generation
- `CPS-829 <https://jira.onap.org/browse/CPS-829>`_ Async: Internal message topic incl. basic producer & Consumer
- `CPS-830 <https://jira.onap.org/browse/CPS-830>`_ DMI-NCMP Asynchronously Publish Response Event to Client Topic
- `CPS-869 <https://jira.onap.org/browse/CPS-869>`_ Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
- `CPS-870 <https://jira.onap.org/browse/CPS-870>`_ Align CPS-Core output with SDN-C output (add module name)
- `CPS-875 <https://jira.onap.org/browse/CPS-875>`_ CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
- `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'
- `CPS-899 <https://jira.onap.org/browse/CPS-899>`_ Start and stop sessions on Java API
- `CPS-909 <https://jira.onap.org/browse/CPS-909>`_ Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
- `CPS-917 <https://jira.onap.org/browse/CPS-917>`_ Structured Errors response for passthrough use-cases in NCMP
- `CPS-953 <https://jira.onap.org/browse/CPS-953>`_ Update maven deploy plugin version
- `CPS-977 <https://jira.onap.org/browse/CPS-977>`_ Query CM Handles using CpsPath
- `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_ Create Data Synchronization watchdog
- `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_ Merge 2 'query' end points in NCMP
- `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_ Publish lifecycle events for ADVISED , READY and LOCKED state transition"
- `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_ Support retrieval of YANG module sources for CM handle on the NCMP interface
- `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_ Expose simplified 'external' lock reason enum state over REST interface
- `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_ Introducing the DELETING and DELETED Cmhandle State
- `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_ Register the Cmhandle Sends Advised State notification.
- `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_ Enable/Disable Data Sync for Cm Handle
- `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_ DMI Audit Support (get all CM Handles for a registered DMI)
Bug Fixes
---------
- `CPS-896 <https://jira.onap.org/browse/CPS-896>`_ CM Handle Registration Process only partially completes when exception is thrown
- `CPS-957 <https://jira.onap.org/browse/CPS-957>`_ NCMP: fix getResourceDataForPassthroughOperational endpoint
- `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_ DuplicatedYangResourceException error at parallel cmHandle registration
- `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_ Wrong error response format in case of Dmi plugin error
- `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_ NCMP returns 500 error on searches endpoint when No DMi Handles registered
- `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_ Performance degradation on ncmp/v1/ch/searches endpoint
- `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_ Kafka consumer can not be turned off
- `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_ Unable to change state from LOCKED to ADVISED
- `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_ CmHandle creation performance degradation
- `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_ Incorrect response when empty body executed for cmhandle id-searches
- `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_ Node API - GET method returns invalid response when identifier contains '/'
- `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_ Additional Properties for CM Handles not included when send to DMI Plugin
- `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_ Searches endpoint gives back empty list however there are already available cmhandles
- `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_ NCMP logs are flooded with SyncUtils logs
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
*Known Vulnerabilities*
None
*Workarounds*
None
Security Notes
--------------
*Fixed Security Issues*
- `CPS-963 <https://jira.onap.org/browse/CPS-963>`_ Liquibase has got serious vulnerability, upgrade required
*Known Security Issues*
None
.. ========================
.. * * * JAKARTA * * *
.. ========================
Version: 3.0.1
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.0.1 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.0.1 Jakarta |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 April 28 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-961 <https://jira.onap.org/browse/CPS-961>`_ Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
Version: 3.0.0
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:3.0.0 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 3.0.0 Jakarta |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 March 15 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
- `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
- `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
- `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
- `CPS-677 <https://jira.onap.org/browse/CPS-677>`_ Support 'public' Cm Handle Properties
- `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
- `CPS-777 <https://jira.onap.org/browse/CPS-777>`_ Ensure all DMI operations use POST method
- `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
- `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
- `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
- `CPS-817 <https://jira.onap.org/browse/CPS-817>`_ Create Endpoint For Get Cm Handles (incl. public properties) By Name
- `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
Bug Fixes
---------
- `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
- `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
- `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
- `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
- `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
- `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
- `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
- `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
- `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
- `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
`CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
of cm handle registration.
The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
for more information.
*Known Vulnerabilities*
None
*Workarounds*
Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
pass an empty string as the value if you do not want to include names for these values.
Security Notes
--------------
*Fixed Security Issues*
None
*Known Security Issues*
None
.. ========================
.. * * * ISTANBUL * * *
.. ========================
Version: 2.0.4
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:2.0.4 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 2.0.4 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022 Feb 09 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-879 <https://jira.onap.org/browse/CPS-879>`_ Fix docker compose for csit test.
- `CPS-873 <https://jira.onap.org/browse/CPS-873>`_ Fix intermittent circular dependency error when the application starts.
Version: 2.0.3
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:2.0.3 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 2.0.3 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2022-07-01 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Update log4j version to 2.17.1 due to security vulnerability
Version: 2.0.2
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:2.0.2 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 2.0.2 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-16-12 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-820 <https://jira.onap.org/browse/CPS-820>`_ Update log4j version due to security vulnerability
Version: 2.0.1
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:2.0.1 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 2.0.1 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-14-10 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
- `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
- `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
- `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
*Known Vulnerabilities*
- `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
*Workarounds*
Add recursive method to save list node data to loop through all corresponding child nodes.
Security Notes
--------------
*Fixed Security Issues*
- `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
*Known Security Issues*
None
Version: 2.0.0
==============
Abstract
--------
This document provides the release notes for Istanbul release.
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-ncmp:2.0.0 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 2.0.0 Istanbul |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-14-09 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
* Register DMI-Plugins with NCMP for CM Handle registrations.
* Update, Create and Remove CM Handles.
* Add support for retrieving and writing CM Handle data through NCMP datastores.
* Automatic retrieval and caching of model information for CM Handles within NCMP.
Deliverables
------------
Software Deliverables
.. csv-table::
:header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
:widths: auto
"cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
Bug Fixes
---------
- `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
- `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
- `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
- `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
- `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
- `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
- `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
- `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
- `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
- `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
- `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
- `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
- `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
- `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
- `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
- `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
- `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
- `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
- `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
- `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
- `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
- `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
- `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
- `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
- `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
- `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
This document provides the release notes for Istanbul release.
Summary
-------
Following CPS components are available with default ONAP/CPS installation.
* Platform components
- CPS (Helm charts)
* Service components
- CPS-NCMP
- CPS-Temporal
- DMI-Plugin
* Additional resources that CPS utilizes deployed using ONAP common charts
- Postgres Database
Below service components (mS) are available to be deployed on-demand.
- CPS-TBDMT
Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
Known Limitations, Issues and Workarounds
-----------------------------------------
*System Limitations*
Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
*Known Vulnerabilities*
- `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
- `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
- `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
*Workarounds*
Add recursive method to save list node data to loop through all corresponding child nodes.
Security Notes
--------------
*Fixed Security Issues*
- `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
*Known Security Issues*
- `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
Test Results
------------
* `Integration tests`
.. ========================
.. * * * HONOLULU * * *
.. ========================
Version: 1.0.1
==============
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | onap/cps-and-nf-proxy:1.0.1 |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.0.1 Honolulu |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-04-09 |
| | |
+--------------------------------------+--------------------------------------------------------+
Bug Fixes
---------
- `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
- `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
- `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
- `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
- `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
- `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
- `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
- `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
Security Notes
--------------
*Fixed Security Issues*
- `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
*Known Security Issues*
- `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
Version: 1.0.0
==============
Abstract
--------
This document provides the release notes for Honolulu release.
Summary
-------
Following CPS components are available with default ONAP/CPS installation.
* Platform components
- CPS (Helm charts)
* Service components
- CPS Core
* Additional resources that CPS utilizes deployed using ONAP common charts
- Postgres Database
Below service components (mS) are available to be deployed on-demand.
- CPS-TBDMT
Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
Release Data
------------
+--------------------------------------+--------------------------------------------------------+
| **CPS Project** | |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Docker images** | Refer :any:`Deliverable <honolulu_deliverable>` |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release designation** | 1.0.0 Honolulu |
| | |
+--------------------------------------+--------------------------------------------------------+
| **Release date** | 2021-03-11 |
| | |
+--------------------------------------+--------------------------------------------------------+
Features
--------
Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
CPS has been driven by the needs of the E2E Networking Slicing use case.
It currently supports basic (rw) persistence and simple queries.
It also provides MVP support for network data access using simulated data.
.. _honolulu_deliverable:
Deliverables
------------
Software Deliverables
.. csv-table::
:header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
:widths: auto
"cps", "", "onap/cps-and-nf-proxy:1.0.0"
Known Limitations, Issues and Workarounds
-----------------------------------------
- `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
- `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
- Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
- `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.
*System Limitations*
None
*Known Vulnerabilities*
None
*Workarounds*
Documented under corresponding jira if applicable.
Security Notes
--------------
*Fixed Security Issues*
* `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
- Upgrade org.onap.oparent to 3.2.0
- Upgrade spring.boot to 2.3.8.RELEASE
- Upgrade yangtools to 5.0.7
*Known Security Issues*
* Weak Crytography using md5
* Risk seen in Zip file expansion
*Known Vulnerabilities in Used Modules*
None
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.
Test Results
------------
* `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
References
----------
For more information on the ONAP Honolulu release, please see:
#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_
.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org
Quick Links:
- `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
- `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_
|
