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