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-2022 Nordix Foundation
   4
   5 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
   6 .. _release_notes:
   7
   8 CPS Release Notes
   9 #################
  10
  11 .. contents::
  12     :depth: 2
  13 ..
  14
  15 ..      ====================
  16 ..      * * *   KOHN   * * *
  17 ..      ====================
  18
  19 Version: 3.1.1
  20 ==============
  21
  22 Release Data
  23 ------------
  24
  25 +--------------------------------------+--------------------------------------------------------+
  26 | **CPS Project**                      |                                                        |
  27 |                                      |                                                        |
  28 +--------------------------------------+--------------------------------------------------------+
  29 | **Docker images**                    | onap/cps-and-ncmp:3.1.1                                |
  30 |                                      |                                                        |
  31 +--------------------------------------+--------------------------------------------------------+
  32 | **Release designation**              | 3.1.1 Kohn                                             |
  33 |                                      |                                                        |
  34 +--------------------------------------+--------------------------------------------------------+
  35 | **Release date**                     | (yet to release)                                       |
  36 |                                      |                                                        |
  37 +--------------------------------------+--------------------------------------------------------+
  38
  39 Bug Fixes
  40 ---------
  41    - None
  42
  43 Security Notes
  44 --------------
  45
  46 *Fixed Security Issues*
  47
  48    - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_  Security bug in the logs
  49
  50 Version: 3.1.0
  51 ==============
  52
  53 Release Data
  54 ------------
  55
  56 +--------------------------------------+--------------------------------------------------------+
  57 | **CPS Project**                      |                                                        |
  58 |                                      |                                                        |
  59 +--------------------------------------+--------------------------------------------------------+
  60 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
  61 |                                      |                                                        |
  62 +--------------------------------------+--------------------------------------------------------+
  63 | **Release designation**              | 3.1.0 Kohn                                             |
  64 |                                      |                                                        |
  65 +--------------------------------------+--------------------------------------------------------+
  66 | **Release date**                     | 2022 September 14                                      |
  67 |                                      |                                                        |
  68 +--------------------------------------+--------------------------------------------------------+
  69
  70 Features
  71 --------
  72    - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_  Patch and update the root data node
  73    - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
  74    - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_  Query based on Public CM Properties
  75    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
  76    - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_  Async: Internal message topic incl. basic producer & Consumer
  77    - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_  DMI-NCMP Asynchronously Publish Response Event to Client Topic
  78    - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_  Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
  79    - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_  Align CPS-Core output with SDN-C output (add module name)
  80    - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_  CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
  81    - `CPS-877 <https://jira.onap.org/browse/CPS-877>`_  CM Handle State: Exclude any CM-Handles from queries/operations that are not in state 'READY'
  82    - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_  Start and stop sessions on Java API
  83    - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_  Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
  84    - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_  Structured Errors response for passthrough use-cases in NCMP
  85    - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_  Update maven deploy plugin version
  86    - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_  Query CM Handles using CpsPath
  87    - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_  Create Data Synchronization watchdog
  88    - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_  Merge 2 'query' end points in NCMP
  89    - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_  Publish lifecycle events for ADVISED , READY and LOCKED state transition"
  90    - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_  Support retrieval of YANG module sources for CM handle on the NCMP interface
  91    - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_  Expose simplified 'external' lock reason enum state over REST interface
  92    - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_  Introducing the DELETING and DELETED Cmhandle State
  93    - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_  Register the Cmhandle Sends Advised State notification.
  94    - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_  Enable/Disable Data Sync for Cm Handle
  95    - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_  DMI Audit Support (get all CM Handles for a registered DMI)
  96
  97
  98 Bug Fixes
  99 ---------
 100    - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_  CM Handle Registration Process only partially completes when exception is thrown
 101    - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_  NCMP: fix getResourceDataForPassthroughOperational endpoint
 102    - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_  DuplicatedYangResourceException error at parallel cmHandle registration
 103    - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_  Wrong error response format in case of Dmi plugin error
 104    - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_  NCMP returns 500 error on searches endpoint when No DMi Handles registered
 105    - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_  Performance degradation on ncmp/v1/ch/searches endpoint
 106    - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_  Kafka consumer can not be turned off
 107    - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_  Unable to change state from LOCKED to ADVISED
 108    - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_  CmHandle creation performance degradation
 109    - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_  Incorrect response when empty body executed for cmhandle id-searches
 110    - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_  Node API - GET method returns invalid response when identifier contains '/'
 111    - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_  Additional Properties for CM Handles not included when send to DMI Plugin
 112    - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_  Searches endpoint gives back empty list however there are already available cmhandles
 113    - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_  NCMP logs are flooded with SyncUtils logs
 114
 115 Known Limitations, Issues and Workarounds
 116 -----------------------------------------
 117
 118 *System Limitations*
 119
 120 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
 121 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
 122
 123 *Known Vulnerabilities*
 124
 125 None
 126
 127 *Workarounds*
 128
 129 None
 130
 131 Security Notes
 132 --------------
 133
 134 *Fixed Security Issues*
 135
 136    - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_  Liquibase has got serious vulnerability, upgrade required
 137
 138 *Known Security Issues*
 139
 140 None
 141
 142 ..      ========================
 143 ..      * * *   JAKARTA   * * *
 144 ..      ========================
 145
 146 Version: 3.0.1
 147 ==============
 148
 149 Release Data
 150 ------------
 151
 152 +--------------------------------------+--------------------------------------------------------+
 153 | **CPS Project**                      |                                                        |
 154 |                                      |                                                        |
 155 +--------------------------------------+--------------------------------------------------------+
 156 | **Docker images**                    | onap/cps-and-ncmp:3.0.1                                |
 157 |                                      |                                                        |
 158 +--------------------------------------+--------------------------------------------------------+
 159 | **Release designation**              | 3.0.1 Jakarta                                          |
 160 |                                      |                                                        |
 161 +--------------------------------------+--------------------------------------------------------+
 162 | **Release date**                     | 2022 April 28                                          |
 163 |                                      |                                                        |
 164 +--------------------------------------+--------------------------------------------------------+
 165
 166 Bug Fixes
 167 ---------
 168    - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_  Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
 169
 170 Version: 3.0.0
 171 ==============
 172
 173 Release Data
 174 ------------
 175
 176 +--------------------------------------+--------------------------------------------------------+
 177 | **CPS Project**                      |                                                        |
 178 |                                      |                                                        |
 179 +--------------------------------------+--------------------------------------------------------+
 180 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
 181 |                                      |                                                        |
 182 +--------------------------------------+--------------------------------------------------------+
 183 | **Release designation**              | 3.0.0 Jakarta                                          |
 184 |                                      |                                                        |
 185 +--------------------------------------+--------------------------------------------------------+
 186 | **Release date**                     | 2022 March 15                                          |
 187 |                                      |                                                        |
 188 +--------------------------------------+--------------------------------------------------------+
 189
 190 Features
 191 --------
 192    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
 193    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
 194    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
 195    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
 196    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
 197    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
 198    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
 199    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
 200    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
 201    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
 202    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
 203
 204 Bug Fixes
 205 ---------
 206
 207    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
 208    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
 209    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
 210    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 211    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
 212    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
 213    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
 214    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
 215    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
 216    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCM-Rest-API (cyclic) through json properties on Java API
 217
 218 Known Limitations, Issues and Workarounds
 219 -----------------------------------------
 220
 221 *System Limitations*
 222
 223 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
 224 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
 225 of cm handle registration.
 226
 227 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
 228 for more information.
 229
 230 *Known Vulnerabilities*
 231
 232 None
 233
 234 *Workarounds*
 235
 236 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
 237 pass an empty string as the value if you do not want to include names for these values.
 238
 239 Security Notes
 240 --------------
 241
 242 *Fixed Security Issues*
 243
 244 None
 245
 246 *Known Security Issues*
 247
 248 None
 249
 250 ..      ========================
 251 ..      * * *   ISTANBUL   * * *
 252 ..      ========================
 253
 254 Version: 2.0.4
 255 ==============
 256
 257 Release Data
 258 ------------
 259
 260 +--------------------------------------+--------------------------------------------------------+
 261 | **CPS Project**                      |                                                        |
 262 |                                      |                                                        |
 263 +--------------------------------------+--------------------------------------------------------+
 264 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
 265 |                                      |                                                        |
 266 +--------------------------------------+--------------------------------------------------------+
 267 | **Release designation**              | 2.0.4 Istanbul                                         |
 268 |                                      |                                                        |
 269 +--------------------------------------+--------------------------------------------------------+
 270 | **Release date**                     | 2022 Feb 09                                            |
 271 |                                      |                                                        |
 272 +--------------------------------------+--------------------------------------------------------+
 273
 274 Bug Fixes
 275 ---------
 276
 277    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
 278    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
 279
 280 Version: 2.0.3
 281 ==============
 282
 283 Release Data
 284 ------------
 285
 286 +--------------------------------------+--------------------------------------------------------+
 287 | **CPS Project**                      |                                                        |
 288 |                                      |                                                        |
 289 +--------------------------------------+--------------------------------------------------------+
 290 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
 291 |                                      |                                                        |
 292 +--------------------------------------+--------------------------------------------------------+
 293 | **Release designation**              | 2.0.3 Istanbul                                         |
 294 |                                      |                                                        |
 295 +--------------------------------------+--------------------------------------------------------+
 296 | **Release date**                     | 2022-07-01                                             |
 297 |                                      |                                                        |
 298 +--------------------------------------+--------------------------------------------------------+
 299
 300 Bug Fixes
 301 ---------
 302
 303    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
 304
 305 Version: 2.0.2
 306 ==============
 307
 308 Release Data
 309 ------------
 310
 311 +--------------------------------------+--------------------------------------------------------+
 312 | **CPS Project**                      |                                                        |
 313 |                                      |                                                        |
 314 +--------------------------------------+--------------------------------------------------------+
 315 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
 316 |                                      |                                                        |
 317 +--------------------------------------+--------------------------------------------------------+
 318 | **Release designation**              | 2.0.2 Istanbul                                         |
 319 |                                      |                                                        |
 320 +--------------------------------------+--------------------------------------------------------+
 321 | **Release date**                     | 2021-16-12                                             |
 322 |                                      |                                                        |
 323 +--------------------------------------+--------------------------------------------------------+
 324
 325 Bug Fixes
 326 ---------
 327
 328    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
 329
 330 Version: 2.0.1
 331 ==============
 332
 333 Release Data
 334 ------------
 335
 336 +--------------------------------------+--------------------------------------------------------+
 337 | **CPS Project**                      |                                                        |
 338 |                                      |                                                        |
 339 +--------------------------------------+--------------------------------------------------------+
 340 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
 341 |                                      |                                                        |
 342 +--------------------------------------+--------------------------------------------------------+
 343 | **Release designation**              | 2.0.1 Istanbul                                         |
 344 |                                      |                                                        |
 345 +--------------------------------------+--------------------------------------------------------+
 346 | **Release date**                     | 2021-14-10                                             |
 347 |                                      |                                                        |
 348 +--------------------------------------+--------------------------------------------------------+
 349
 350 Bug Fixes
 351 ---------
 352
 353    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
 354    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 355    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
 356    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
 357
 358 Known Limitations, Issues and Workarounds
 359 -----------------------------------------
 360
 361 *System Limitations*
 362
 363 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
 364
 365 *Known Vulnerabilities*
 366
 367    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
 368
 369 *Workarounds*
 370
 371 Add recursive method to save list node data to loop through all corresponding child nodes.
 372
 373 Security Notes
 374 --------------
 375
 376 *Fixed Security Issues*
 377
 378    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
 379
 380 *Known Security Issues*
 381
 382 None
 383
 384 Version: 2.0.0
 385 ==============
 386
 387 Abstract
 388 --------
 389
 390 This document provides the release notes for Istanbul release.
 391
 392 Release Data
 393 ------------
 394
 395 +--------------------------------------+--------------------------------------------------------+
 396 | **CPS Project**                      |                                                        |
 397 |                                      |                                                        |
 398 +--------------------------------------+--------------------------------------------------------+
 399 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
 400 |                                      |                                                        |
 401 +--------------------------------------+--------------------------------------------------------+
 402 | **Release designation**              | 2.0.0 Istanbul                                         |
 403 |                                      |                                                        |
 404 +--------------------------------------+--------------------------------------------------------+
 405 | **Release date**                     | 2021-14-09                                             |
 406 |                                      |                                                        |
 407 +--------------------------------------+--------------------------------------------------------+
 408
 409 Features
 410 --------
 411 * Register DMI-Plugins with NCMP for CM Handle registrations.
 412 * Update, Create and Remove CM Handles.
 413 * Add support for retrieving and writing CM Handle data through NCMP datastores.
 414 * Automatic retrieval and caching of model information for CM Handles within NCMP.
 415
 416 Deliverables
 417 ------------
 418
 419 Software Deliverables
 420
 421 .. csv-table::
 422    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 423    :widths: auto
 424
 425    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
 426
 427 Bug Fixes
 428 ---------
 429
 430    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
 431    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
 432    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
 433    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
 434    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
 435    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
 436    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
 437    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
 438    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
 439    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
 440    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
 441    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
 442    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
 443    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
 444    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
 445    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
 446    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
 447    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
 448    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
 449    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
 450    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
 451    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
 452    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
 453    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
 454    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
 455    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
 456
 457 This document provides the release notes for Istanbul release.
 458
 459 Summary
 460 -------
 461
 462 Following CPS components are available with default ONAP/CPS installation.
 463
 464
 465     * Platform components
 466
 467         - CPS (Helm charts)
 468
 469     * Service components
 470
 471         - CPS-NCMP
 472         - CPS-Temporal
 473         - DMI-Plugin
 474
 475     * Additional resources that CPS utilizes deployed using ONAP common charts
 476
 477         - Postgres Database
 478
 479
 480 Below service components (mS) are available to be deployed on-demand.
 481     - CPS-TBDMT
 482
 483
 484 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 485
 486 Known Limitations, Issues and Workarounds
 487 -----------------------------------------
 488
 489 *System Limitations*
 490
 491 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
 492
 493 *Known Vulnerabilities*
 494
 495    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
 496    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
 497    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
 498
 499 *Workarounds*
 500
 501 Add recursive method to save list node data to loop through all corresponding child nodes.
 502
 503 Security Notes
 504 --------------
 505
 506 *Fixed Security Issues*
 507
 508    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 509
 510 *Known Security Issues*
 511
 512    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
 513
 514 Test Results
 515 ------------
 516     * `Integration tests`
 517
 518 ..      ========================
 519 ..      * * *   HONOLULU   * * *
 520 ..      ========================
 521
 522 Version: 1.0.1
 523 ==============
 524
 525 Release Data
 526 ------------
 527
 528 +--------------------------------------+--------------------------------------------------------+
 529 | **CPS Project**                      |                                                        |
 530 |                                      |                                                        |
 531 +--------------------------------------+--------------------------------------------------------+
 532 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
 533 |                                      |                                                        |
 534 +--------------------------------------+--------------------------------------------------------+
 535 | **Release designation**              | 1.0.1 Honolulu                                         |
 536 |                                      |                                                        |
 537 +--------------------------------------+--------------------------------------------------------+
 538 | **Release date**                     | 2021-04-09                                             |
 539 |                                      |                                                        |
 540 +--------------------------------------+--------------------------------------------------------+
 541
 542 Bug Fixes
 543 ---------
 544
 545    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
 546    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
 547    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
 548    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
 549    - `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
 550    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
 551    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
 552    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
 553
 554 Security Notes
 555 --------------
 556
 557 *Fixed Security Issues*
 558
 559    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 560
 561 *Known Security Issues*
 562
 563    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
 564
 565 Version: 1.0.0
 566 ==============
 567
 568
 569 Abstract
 570 --------
 571
 572 This document provides the release notes for Honolulu release.
 573
 574 Summary
 575 -------
 576
 577 Following CPS components are available with default ONAP/CPS installation.
 578
 579
 580     * Platform components
 581
 582         - CPS (Helm charts)
 583
 584     * Service components
 585
 586         - CPS Core
 587
 588     * Additional resources that CPS utilizes deployed using ONAP common charts
 589
 590         - Postgres Database
 591
 592
 593 Below service components (mS) are available to be deployed on-demand.
 594     - CPS-TBDMT
 595
 596
 597 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 598
 599
 600 Release Data
 601 ------------
 602
 603 +--------------------------------------+--------------------------------------------------------+
 604 | **CPS Project**                      |                                                        |
 605 |                                      |                                                        |
 606 +--------------------------------------+--------------------------------------------------------+
 607 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
 608 |                                      |                                                        |
 609 +--------------------------------------+--------------------------------------------------------+
 610 | **Release designation**              | 1.0.0 Honolulu                                         |
 611 |                                      |                                                        |
 612 +--------------------------------------+--------------------------------------------------------+
 613 | **Release date**                     | 2021-03-11                                             |
 614 |                                      |                                                        |
 615 +--------------------------------------+--------------------------------------------------------+
 616
 617
 618 Features
 619 --------
 620 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
 621 CPS has been driven by the needs of the E2E Networking Slicing use case.
 622 It currently supports basic (rw) persistence and simple queries.
 623 It also provides MVP support for network data access using simulated data.
 624
 625 .. _honolulu_deliverable:
 626
 627 Deliverables
 628 ------------
 629
 630 Software Deliverables
 631
 632 .. csv-table::
 633    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 634    :widths: auto
 635
 636    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
 637
 638
 639 Known Limitations, Issues and Workarounds
 640 -----------------------------------------
 641
 642    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
 643    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
 644    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
 645    - `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.
 646
 647 *System Limitations*
 648
 649 None
 650
 651 *Known Vulnerabilities*
 652
 653 None
 654
 655 *Workarounds*
 656
 657 Documented under corresponding jira if applicable.
 658
 659 Security Notes
 660 --------------
 661
 662 *Fixed Security Issues*
 663
 664 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
 665     - Upgrade org.onap.oparent to 3.2.0
 666     - Upgrade spring.boot to 2.3.8.RELEASE
 667     - Upgrade yangtools to 5.0.7
 668
 669 *Known Security Issues*
 670
 671     * Weak Crytography using md5
 672     * Risk seen in Zip file expansion
 673
 674 *Known Vulnerabilities in Used Modules*
 675
 676     None
 677
 678 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.
 679
 680 Test Results
 681 ------------
 682     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
 683
 684 References
 685 ----------
 686
 687 For more information on the ONAP Honolulu release, please see:
 688
 689 #. `ONAP Home Page`_
 690 #. `ONAP Documentation`_
 691 #. `ONAP Release Downloads`_
 692 #. `ONAP Wiki Page`_
 693
 694
 695 .. _`ONAP Home Page`: https://www.onap.org
 696 .. _`ONAP Wiki Page`: https://wiki.onap.org
 697 .. _`ONAP Documentation`: https://docs.onap.org
 698 .. _`ONAP Release Downloads`: https://git.onap.org
 699
 700 Quick Links:
 701
 702         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
 703         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_