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