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