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