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