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