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