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