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