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