Merge "Updated the Documentation with sample yang and json"
[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-2022 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 ..      * * *   JAKARTA   * * *
17 ..      ========================
18
19 Version: 3.0.0
20 ==============
21
22 Release Data
23 ------------
24
25 +--------------------------------------+--------------------------------------------------------+
26 | **CPS Project**                      |                                                        |
27 |                                      |                                                        |
28 +--------------------------------------+--------------------------------------------------------+
29 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
30 |                                      |                                                        |
31 +--------------------------------------+--------------------------------------------------------+
32 | **Release designation**              | 3.0.0 Jakarta                                          |
33 |                                      |                                                        |
34 +--------------------------------------+--------------------------------------------------------+
35 | **Release date**                     | 2022 March 15                                          |
36 |                                      |                                                        |
37 +--------------------------------------+--------------------------------------------------------+
38
39 Features
40 --------
41    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
42    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
43    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
44    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
45    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
46    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
47    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
48    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
49    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
50    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
51    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
52
53 Bug Fixes
54 ---------
55
56    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
57    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
58    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
59    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
60    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
61    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
62    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
63    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
64    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
65    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
66
67 Known Limitations, Issues and Workarounds
68 -----------------------------------------
69
70 *System Limitations*
71
72 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
73 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
74 of cm handle registration.
75
76 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
77 for more information.
78
79 *Known Vulnerabilities*
80
81 None
82
83 *Workarounds*
84
85 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
86 pass an empty string as the value if you do not want to include names for these values.
87
88 Security Notes
89 --------------
90
91 *Fixed Security Issues*
92
93 None
94
95 *Known Security Issues*
96
97 None
98
99 ..      ========================
100 ..      * * *   ISTANBUL   * * *
101 ..      ========================
102
103 Version: 2.0.4
104 ==============
105
106 Release Data
107 ------------
108
109 +--------------------------------------+--------------------------------------------------------+
110 | **CPS Project**                      |                                                        |
111 |                                      |                                                        |
112 +--------------------------------------+--------------------------------------------------------+
113 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
114 |                                      |                                                        |
115 +--------------------------------------+--------------------------------------------------------+
116 | **Release designation**              | 2.0.4 Istanbul                                         |
117 |                                      |                                                        |
118 +--------------------------------------+--------------------------------------------------------+
119 | **Release date**                     | 2022 Feb 09                                            |
120 |                                      |                                                        |
121 +--------------------------------------+--------------------------------------------------------+
122
123 Bug Fixes
124 ---------
125
126    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
127    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
128
129 Version: 2.0.3
130 ==============
131
132 Release Data
133 ------------
134
135 +--------------------------------------+--------------------------------------------------------+
136 | **CPS Project**                      |                                                        |
137 |                                      |                                                        |
138 +--------------------------------------+--------------------------------------------------------+
139 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
140 |                                      |                                                        |
141 +--------------------------------------+--------------------------------------------------------+
142 | **Release designation**              | 2.0.3 Istanbul                                         |
143 |                                      |                                                        |
144 +--------------------------------------+--------------------------------------------------------+
145 | **Release date**                     | 2022-07-01                                             |
146 |                                      |                                                        |
147 +--------------------------------------+--------------------------------------------------------+
148
149 Bug Fixes
150 ---------
151
152    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
153
154 Version: 2.0.2
155 ==============
156
157 Release Data
158 ------------
159
160 +--------------------------------------+--------------------------------------------------------+
161 | **CPS Project**                      |                                                        |
162 |                                      |                                                        |
163 +--------------------------------------+--------------------------------------------------------+
164 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
165 |                                      |                                                        |
166 +--------------------------------------+--------------------------------------------------------+
167 | **Release designation**              | 2.0.2 Istanbul                                         |
168 |                                      |                                                        |
169 +--------------------------------------+--------------------------------------------------------+
170 | **Release date**                     | 2021-16-12                                             |
171 |                                      |                                                        |
172 +--------------------------------------+--------------------------------------------------------+
173
174 Bug Fixes
175 ---------
176
177    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
178
179 Version: 2.0.1
180 ==============
181
182 Release Data
183 ------------
184
185 +--------------------------------------+--------------------------------------------------------+
186 | **CPS Project**                      |                                                        |
187 |                                      |                                                        |
188 +--------------------------------------+--------------------------------------------------------+
189 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
190 |                                      |                                                        |
191 +--------------------------------------+--------------------------------------------------------+
192 | **Release designation**              | 2.0.1 Istanbul                                         |
193 |                                      |                                                        |
194 +--------------------------------------+--------------------------------------------------------+
195 | **Release date**                     | 2021-14-10                                             |
196 |                                      |                                                        |
197 +--------------------------------------+--------------------------------------------------------+
198
199 Bug Fixes
200 ---------
201
202    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
203    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
204    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
205    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
206
207 Known Limitations, Issues and Workarounds
208 -----------------------------------------
209
210 *System Limitations*
211
212 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
213
214 *Known Vulnerabilities*
215
216    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
217
218 *Workarounds*
219
220 Add recursive method to save list node data to loop through all corresponding child nodes.
221
222 Security Notes
223 --------------
224
225 *Fixed Security Issues*
226
227    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
228
229 *Known Security Issues*
230
231 None
232
233 Version: 2.0.0
234 ==============
235
236 Abstract
237 --------
238
239 This document provides the release notes for Istanbul release.
240
241 Release Data
242 ------------
243
244 +--------------------------------------+--------------------------------------------------------+
245 | **CPS Project**                      |                                                        |
246 |                                      |                                                        |
247 +--------------------------------------+--------------------------------------------------------+
248 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
249 |                                      |                                                        |
250 +--------------------------------------+--------------------------------------------------------+
251 | **Release designation**              | 2.0.0 Istanbul                                         |
252 |                                      |                                                        |
253 +--------------------------------------+--------------------------------------------------------+
254 | **Release date**                     | 2021-14-09                                             |
255 |                                      |                                                        |
256 +--------------------------------------+--------------------------------------------------------+
257
258 Features
259 --------
260 * Register DMI-Plugins with NCMP for CM Handle registrations.
261 * Update, Create and Remove CM Handles.
262 * Add support for retrieving and writing CM Handle data through NCMP datastores.
263 * Automatic retrieval and caching of model information for CM Handles within NCMP.
264
265 Deliverables
266 ------------
267
268 Software Deliverables
269
270 .. csv-table::
271    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
272    :widths: auto
273
274    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
275
276 Bug Fixes
277 ---------
278
279    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
280    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
281    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
282    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
283    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
284    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
285    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
286    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
287    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
288    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
289    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
290    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
291    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
292    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
293    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
294    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
295    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
296    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
297    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
298    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
299    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
300    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
301    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
302    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
303    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
304    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
305
306 This document provides the release notes for Istanbul release.
307
308 Summary
309 -------
310
311 Following CPS components are available with default ONAP/CPS installation.
312
313
314     * Platform components
315
316         - CPS (Helm charts)
317
318     * Service components
319
320         - CPS-NCMP
321         - CPS-Temporal
322         - DMI-Plugin
323
324     * Additional resources that CPS utilizes deployed using ONAP common charts
325
326         - Postgres Database
327
328
329 Below service components (mS) are available to be deployed on-demand.
330     - CPS-TBDMT
331
332
333 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
334
335 Known Limitations, Issues and Workarounds
336 -----------------------------------------
337
338 *System Limitations*
339
340 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
341
342 *Known Vulnerabilities*
343
344    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
345    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
346    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
347
348 *Workarounds*
349
350 Add recursive method to save list node data to loop through all corresponding child nodes.
351
352 Security Notes
353 --------------
354
355 *Fixed Security Issues*
356
357    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
358
359 *Known Security Issues*
360
361    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
362
363 Test Results
364 ------------
365     * `Integration tests`
366
367 ..      ========================
368 ..      * * *   HONOLULU   * * *
369 ..      ========================
370
371 Version: 1.0.1
372 ==============
373
374 Release Data
375 ------------
376
377 +--------------------------------------+--------------------------------------------------------+
378 | **CPS Project**                      |                                                        |
379 |                                      |                                                        |
380 +--------------------------------------+--------------------------------------------------------+
381 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
382 |                                      |                                                        |
383 +--------------------------------------+--------------------------------------------------------+
384 | **Release designation**              | 1.0.1 Honolulu                                         |
385 |                                      |                                                        |
386 +--------------------------------------+--------------------------------------------------------+
387 | **Release date**                     | 2021-04-09                                             |
388 |                                      |                                                        |
389 +--------------------------------------+--------------------------------------------------------+
390
391 Bug Fixes
392 ---------
393
394    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
395    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
396    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
397    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
398    - `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
399    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
400    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
401    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
402
403 Security Notes
404 --------------
405
406 *Fixed Security Issues*
407
408    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
409
410 *Known Security Issues*
411
412    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
413
414 Version: 1.0.0
415 ==============
416
417
418 Abstract
419 --------
420
421 This document provides the release notes for Honolulu release.
422
423 Summary
424 -------
425
426 Following CPS components are available with default ONAP/CPS installation.
427
428
429     * Platform components
430
431         - CPS (Helm charts)
432
433     * Service components
434
435         - CPS Core
436
437     * Additional resources that CPS utilizes deployed using ONAP common charts
438
439         - Postgres Database
440
441
442 Below service components (mS) are available to be deployed on-demand.
443     - CPS-TBDMT
444
445
446 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
447
448
449 Release Data
450 ------------
451
452 +--------------------------------------+--------------------------------------------------------+
453 | **CPS Project**                      |                                                        |
454 |                                      |                                                        |
455 +--------------------------------------+--------------------------------------------------------+
456 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
457 |                                      |                                                        |
458 +--------------------------------------+--------------------------------------------------------+
459 | **Release designation**              | 1.0.0 Honolulu                                         |
460 |                                      |                                                        |
461 +--------------------------------------+--------------------------------------------------------+
462 | **Release date**                     | 2021-03-11                                             |
463 |                                      |                                                        |
464 +--------------------------------------+--------------------------------------------------------+
465
466
467 Features
468 --------
469 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
470 CPS has been driven by the needs of the E2E Networking Slicing use case.
471 It currently supports basic (rw) persistence and simple queries.
472 It also provides MVP support for network data access using simulated data.
473
474 .. _honolulu_deliverable:
475
476 Deliverables
477 ------------
478
479 Software Deliverables
480
481 .. csv-table::
482    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
483    :widths: auto
484
485    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
486
487
488 Known Limitations, Issues and Workarounds
489 -----------------------------------------
490
491    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
492    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
493    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
494    - `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.
495
496 *System Limitations*
497
498 None
499
500 *Known Vulnerabilities*
501
502 None
503
504 *Workarounds*
505
506 Documented under corresponding jira if applicable.
507
508 Security Notes
509 --------------
510
511 *Fixed Security Issues*
512
513 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
514     - Upgrade org.onap.oparent to 3.2.0
515     - Upgrade spring.boot to 2.3.8.RELEASE
516     - Upgrade yangtools to 5.0.7
517
518 *Known Security Issues*
519
520     * Weak Crytography using md5
521     * Risk seen in Zip file expansion
522
523 *Known Vulnerabilities in Used Modules*
524
525     None
526
527 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.
528
529 Test Results
530 ------------
531     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
532
533 References
534 ----------
535
536 For more information on the ONAP Honolulu release, please see:
537
538 #. `ONAP Home Page`_
539 #. `ONAP Documentation`_
540 #. `ONAP Release Downloads`_
541 #. `ONAP Wiki Page`_
542
543
544 .. _`ONAP Home Page`: https://www.onap.org
545 .. _`ONAP Wiki Page`: https://wiki.onap.org
546 .. _`ONAP Documentation`: https://docs.onap.org
547 .. _`ONAP Release Downloads`: https://git.onap.org
548
549 Quick Links:
550
551         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
552         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_