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