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