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