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