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