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-2024 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 ..      * * *   NEW DELHI   * * *
  17 ..      =========================
  18
  19 Version: 3.4.2
  20 ==============
  21
  22 Release Data
  23 ------------
  24
  25 +--------------------------------------+--------------------------------------------------------+
  26 | **CPS Project**                      |                                                        |
  27 |                                      |                                                        |
  28 +--------------------------------------+--------------------------------------------------------+
  29 | **Docker images**                    | onap/cps-and-ncmp:3.4.2                                |
  30 |                                      |                                                        |
  31 +--------------------------------------+--------------------------------------------------------+
  32 | **Release designation**              | 3.4.2 New Delhi                                        |
  33 |                                      |                                                        |
  34 +--------------------------------------+--------------------------------------------------------+
  35 | **Release date**                     | Not yet released                                       |
  36 |                                      |                                                        |
  37 +--------------------------------------+--------------------------------------------------------+
  38
  39 Bug Fixes
  40 ---------
  41 3.4.2
  42
  43
  44 Features
  45 --------
  46     - `CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_ Double performance of CPS write operations (via write batching)
  47     - `CPS-2018 <https://jira.onap.org/browse/CPS-2018>`_ Improve performance of CPS update operations.
  48     - `CPS-2019 <https://jira.onap.org/browse/CPS-2019>`_ Improve performance of saving CM handles.
  49
  50 Notes
  51 -----
  52     - Java API method CpsDataService::saveListElementsBatch has been removed as part of CPS-2019.
  53
  54 Known Limitations, Issues and Workarounds
  55 -----------------------------------------
  56
  57 *System Limitations*
  58
  59 For upgrading, CPS uses Liquibase for database upgrades. In order to enable Hibernate write batching
  60 (`CPS-1795 <https://jira.onap.org/browse/CPS-1795>`_), a change to the database entity ID generation is required.
  61 As such, *this release does not fully support In-Service Software Upgrade* - CPS will not store new DataNodes and
  62 NCMP will not register new CM-handles during an upgrade with old and new versions of CPS running concurrently.
  63 Other operations (read, update, delete) are not impacted.
  64
  65
  66 Version: 3.4.1
  67 ==============
  68
  69 Release Data
  70 ------------
  71
  72 +--------------------------------------+--------------------------------------------------------+
  73 | **CPS Project**                      |                                                        |
  74 |                                      |                                                        |
  75 +--------------------------------------+--------------------------------------------------------+
  76 | **Docker images**                    | onap/cps-and-ncmp:3.4.1                                |
  77 |                                      |                                                        |
  78 +--------------------------------------+--------------------------------------------------------+
  79 | **Release designation**              | 3.4.1 New Delhi                                        |
  80 |                                      |                                                        |
  81 +--------------------------------------+--------------------------------------------------------+
  82 | **Release date**                     | 2023 December 20                                       |
  83 |                                      |                                                        |
  84 +--------------------------------------+--------------------------------------------------------+
  85
  86 Bug Fixes
  87 ---------
  88 3.4.1
  89     - `CPS-1979 <https://jira.onap.org/browse/CPS-1979>`_ Bug fix for Invalid topic name suffix.
  90
  91 Features
  92 --------
  93     - CPS-Temporal is no longer supported and any related documentation has been removed.
  94     - `CPS-1733 <https://jira.onap.org/browse/CPS-1733>`_ Upgrade YANG schema-set for CM handle without removing and adding it.
  95     - `CPS-1980 <https://jira.onap.org/browse/CPS-1980>`_ Exposing health and cluster metrics for hazelcast.
  96     - `CPS-1994 <https://jira.onap.org/browse/CPS-1994>`_ Use Apache Http Client for DMI REST requests.
  97     - `CPS-2005 <https://jira.onap.org/browse/CPS-2005>`_ Removing notification feature for cps updated events ( exclusively used by cps-temporal )
  98
  99 Known Issues
 100 ------------
 101     - `CPS-2000 <https://jira.onap.org/browse/CPS-2000>`_ Schema object cache is not distributed.
 102
 103
 104 Version: 3.4.0
 105 ==============
 106
 107 Release Data
 108 ------------
 109
 110 +--------------------------------------+--------------------------------------------------------+
 111 | **CPS Project**                      |                                                        |
 112 |                                      |                                                        |
 113 +--------------------------------------+--------------------------------------------------------+
 114 | **Docker images**                    | onap/cps-and-ncmp:3.4.0                                |
 115 |                                      |                                                        |
 116 +--------------------------------------+--------------------------------------------------------+
 117 | **Release designation**              | 3.4.0 New Delhi                                        |
 118 |                                      |                                                        |
 119 +--------------------------------------+--------------------------------------------------------+
 120 | **Release date**                     | 2023 November 09                                       |
 121 |                                      |                                                        |
 122 +--------------------------------------+--------------------------------------------------------+
 123
 124 Bug Fixes
 125 ---------
 126 3.4.0
 127     - `CPS-1956 <https://jira.onap.org/browse/CPS-1956>`_ Bug fix for No yang resources stored during cmhandle discovery.
 128
 129 ..      ========================
 130 ..      * * *   MONTREAL   * * *
 131 ..      ========================
 132
 133 Version: 3.3.9
 134 ==============
 135
 136 Release Data
 137 ------------
 138
 139 +--------------------------------------+--------------------------------------------------------+
 140 | **CPS Project**                      |                                                        |
 141 |                                      |                                                        |
 142 +--------------------------------------+--------------------------------------------------------+
 143 | **Docker images**                    | onap/cps-and-ncmp:3.3.9                                |
 144 |                                      |                                                        |
 145 +--------------------------------------+--------------------------------------------------------+
 146 | **Release designation**              | 3.3.9 Montreal                                         |
 147 |                                      |                                                        |
 148 +--------------------------------------+--------------------------------------------------------+
 149 | **Release date**                     | 2023 November 06                                       |
 150 |                                      |                                                        |
 151 +--------------------------------------+--------------------------------------------------------+
 152
 153 Bug Fixes
 154 ---------
 155 3.3.9
 156     - `CPS-1923 <https://jira.onap.org/browse/CPS-1923>`_ CPS and NCMP changed management endpoint and port from /manage to /actuator and port same as cps application port.
 157     - `CPS-1933 <https://jira.onap.org/browse/CPS-1933>`_ Setting up the class loader explicitly in hazelcast config.
 158
 159 Features
 160 --------
 161
 162 Version: 3.3.8
 163 ==============
 164
 165 Release Data
 166 ------------
 167
 168 +--------------------------------------+--------------------------------------------------------+
 169 | **CPS Project**                      |                                                        |
 170 |                                      |                                                        |
 171 +--------------------------------------+--------------------------------------------------------+
 172 | **Docker images**                    | onap/cps-and-ncmp:3.3.8                                |
 173 |                                      |                                                        |
 174 +--------------------------------------+--------------------------------------------------------+
 175 | **Release designation**              | 3.3.8 Montreal                                         |
 176 |                                      |                                                        |
 177 +--------------------------------------+--------------------------------------------------------+
 178 | **Release date**                     | 2023 September 29                                      |
 179 |                                      |                                                        |
 180 +--------------------------------------+--------------------------------------------------------+
 181
 182 Bug Fixes
 183 ---------
 184 3.3.8
 185
 186 Features
 187 --------
 188     - `CPS-1888 <https://jira.onap.org/browse/CPS-1888>`_ Uplift Spring Boot to 3.1.2.
 189
 190 Version: 3.3.7
 191 ==============
 192
 193 Release Data
 194 ------------
 195
 196 +--------------------------------------+--------------------------------------------------------+
 197 | **CPS Project**                      |                                                        |
 198 |                                      |                                                        |
 199 +--------------------------------------+--------------------------------------------------------+
 200 | **Docker images**                    | onap/cps-and-ncmp:3.3.7                                |
 201 |                                      |                                                        |
 202 +--------------------------------------+--------------------------------------------------------+
 203 | **Release designation**              | 3.3.7 Montreal                                         |
 204 |                                      |                                                        |
 205 +--------------------------------------+--------------------------------------------------------+
 206 | **Release date**                     | 2023 September 20                                      |
 207 |                                      |                                                        |
 208 +--------------------------------------+--------------------------------------------------------+
 209
 210 Bug Fixes
 211 ---------
 212 3.3.7
 213     - `CPS-1866 <https://jira.onap.org/browse/CPS-1866>`_ Fix ClassDefNotFoundError in opendaylight Yang parser
 214
 215 Features
 216 --------
 217     - `CPS-1789 <https://jira.onap.org/browse/CPS-1789>`_ CPS Upgrade to Springboot 3.0.
 218
 219 Note
 220 ----
 221 Migrating to Spring Boot 3.0 requires the product be built with Java 17 and at least MVN version 3.8.7.
 222
 223 Version: 3.3.6
 224 ==============
 225
 226 Release Data
 227 ------------
 228
 229 +--------------------------------------+--------------------------------------------------------+
 230 | **CPS Project**                      |                                                        |
 231 |                                      |                                                        |
 232 +--------------------------------------+--------------------------------------------------------+
 233 | **Docker images**                    | onap/cps-and-ncmp:3.3.6                                |
 234 |                                      |                                                        |
 235 +--------------------------------------+--------------------------------------------------------+
 236 | **Release designation**              | 3.3.6 Montreal                                         |
 237 |                                      |                                                        |
 238 +--------------------------------------+--------------------------------------------------------+
 239 | **Release date**                     | 2023 August 23                                         |
 240 |                                      |                                                        |
 241 +--------------------------------------+--------------------------------------------------------+
 242
 243 Bug Fixes
 244 ---------
 245 3.3.6
 246     - `CPS-1841 <https://jira.onap.org/browse/CPS-1841>`_ Update of top-level data node fails with exception
 247     - `CPS-1842 <https://jira.onap.org/browse/CPS-1842>`_ Replace event-id with correlation-id for data read operation cloud event
 248
 249 Features
 250 --------
 251     - `CPS-1696 <https://jira.onap.org/browse/CPS-1696>`_ Get Data Node to return entire List data node.
 252     - `CPS-1819 <https://jira.onap.org/browse/CPS-1819>`_ Ability to disable sending authorization header.
 253
 254
 255 Version: 3.3.5
 256 ==============
 257
 258 Release Data
 259 ------------
 260
 261 +--------------------------------------+--------------------------------------------------------+
 262 | **CPS Project**                      |                                                        |
 263 |                                      |                                                        |
 264 +--------------------------------------+--------------------------------------------------------+
 265 | **Docker images**                    | onap/cps-and-ncmp:3.3.5                                |
 266 |                                      |                                                        |
 267 +--------------------------------------+--------------------------------------------------------+
 268 | **Release designation**              | 3.3.5 Montreal                                         |
 269 |                                      |                                                        |
 270 +--------------------------------------+--------------------------------------------------------+
 271 | **Release date**                     | 2023 July 21                                           |
 272 |                                      |                                                        |
 273 +--------------------------------------+--------------------------------------------------------+
 274
 275 Bug Fixes
 276 ---------
 277 3.3.5
 278
 279 Features
 280 --------
 281     - `CPS-1760 <https://jira.onap.org/browse/CPS-1760>`_ Improve handling of special characters in Cps Paths
 282
 283 Version: 3.3.4
 284 ==============
 285
 286 Release Data
 287 ------------
 288
 289 +--------------------------------------+--------------------------------------------------------+
 290 | **CPS Project**                      |                                                        |
 291 |                                      |                                                        |
 292 +--------------------------------------+--------------------------------------------------------+
 293 | **Docker images**                    | onap/cps-and-ncmp:3.3.4                                |
 294 |                                      |                                                        |
 295 +--------------------------------------+--------------------------------------------------------+
 296 | **Release designation**              | 3.3.4 Montreal                                         |
 297 |                                      |                                                        |
 298 +--------------------------------------+--------------------------------------------------------+
 299 | **Release date**                     | 2023 July 19                                           |
 300 |                                      |                                                        |
 301 +--------------------------------------+--------------------------------------------------------+
 302
 303 Bug Fixes
 304 ---------
 305 3.3.4
 306
 307 Features
 308 --------
 309     - `CPS-1767 <https://jira.onap.org/browse/CPS-1767>`_ Upgrade CPS to java 17
 310
 311 Version: 3.3.3
 312 ==============
 313
 314 Release Data
 315 ------------
 316
 317 +--------------------------------------+--------------------------------------------------------+
 318 | **CPS Project**                      |                                                        |
 319 |                                      |                                                        |
 320 +--------------------------------------+--------------------------------------------------------+
 321 | **Docker images**                    | onap/cps-and-ncmp:3.3.3                                |
 322 |                                      |                                                        |
 323 +--------------------------------------+--------------------------------------------------------+
 324 | **Release designation**              | 3.3.3 Montreal                                         |
 325 |                                      |                                                        |
 326 +--------------------------------------+--------------------------------------------------------+
 327 | **Release date**                     | 2023 June 30                                           |
 328 |                                      |                                                        |
 329 +--------------------------------------+--------------------------------------------------------+
 330
 331 Bug Fixes
 332 ---------
 333 3.3.3
 334
 335 Features
 336 --------
 337     - `CPS-1515 <https://jira.onap.org/browse/CPS-1515>`_ Support Multiple CM-Handles for NCMP Get Operation
 338     - `CPS-1675 <https://jira.onap.org/browse/CPS-1675>`_ Persistence write performance improvement(s)
 339     - `CPS-1745 <https://jira.onap.org/browse/CPS-1745>`_ Upgrade to Openapi 3.0.3
 340
 341 Version: 3.3.2
 342 ==============
 343
 344 Release Data
 345 ------------
 346
 347 +--------------------------------------+--------------------------------------------------------+
 348 | **CPS Project**                      |                                                        |
 349 |                                      |                                                        |
 350 +--------------------------------------+--------------------------------------------------------+
 351 | **Docker images**                    | onap/cps-and-ncmp:3.3.2                                |
 352 |                                      |                                                        |
 353 +--------------------------------------+--------------------------------------------------------+
 354 | **Release designation**              | 3.3.2 Montreal                                         |
 355 |                                      |                                                        |
 356 +--------------------------------------+--------------------------------------------------------+
 357 | **Release date**                     | 2023 June 15                                           |
 358 |                                      |                                                        |
 359 +--------------------------------------+--------------------------------------------------------+
 360
 361 Bug Fixes
 362 ---------
 363 3.3.2
 364     - `CPS-1716 <https://jira.onap.org/browse/CPS-1716>`_ NCMP: Java Heap OutOfMemory errors and slow registration in case of 20k cmhandles
 365
 366 Features
 367 --------
 368     - `CPS-1006 <https://jira.onap.org/browse/CPS-1006>`_ Extend CPS PATCH API to allow update of leaves for multiple data nodes
 369     - `CPS-1273 <https://jira.onap.org/browse/CPS-1273>`_ Add <,> operators support to cps-path
 370     - `CPS-1664 <https://jira.onap.org/browse/CPS-1664>`_ Use recursive SQL to fetch descendants in CpsPath queries to improve query performance
 371     - `CPS-1676 <https://jira.onap.org/browse/CPS-1676>`_ Entity ID types do not match types in database definition
 372     - `CPS-1677 <https://jira.onap.org/browse/CPS-1677>`_ Remove dataspace_id column from Fragment table
 373
 374 Version: 3.3.1
 375 ==============
 376
 377 Release Data
 378 ------------
 379
 380 +--------------------------------------+--------------------------------------------------------+
 381 | **CPS Project**                      |                                                        |
 382 |                                      |                                                        |
 383 +--------------------------------------+--------------------------------------------------------+
 384 | **Docker images**                    | onap/cps-and-ncmp:3.3.1                                |
 385 |                                      |                                                        |
 386 +--------------------------------------+--------------------------------------------------------+
 387 | **Release designation**              | 3.3.1 Montreal                                         |
 388 |                                      |                                                        |
 389 +--------------------------------------+--------------------------------------------------------+
 390 | **Release date**                     | 2023 May 03                                            |
 391 |                                      |                                                        |
 392 +--------------------------------------+--------------------------------------------------------+
 393
 394 Bug Fixes
 395 ---------
 396 3.3.1
 397     - None
 398
 399 Features
 400 --------
 401     - `CPS-1272 <https://jira.onap.org/browse/CPS-1272>`_ Add Contains operation to CPS Path
 402     - `CPS-1573 <https://jira.onap.org/browse/CPS-1573>`_ Remove 32K limit for DB operations
 403     - `CPS-1627 <https://jira.onap.org/browse/CPS-1627>`_ Dependency versions uplift because of vulnerability issues
 404     - `CPS-1629 <https://jira.onap.org/browse/CPS-1629>`_ Ordering of leaf elements to support combination of AND/OR in cps-path
 405     - `CPS-1637 <https://jira.onap.org/browse/CPS-1637>`_ Extend hazelcast to work on kubernetes
 406
 407 Version: 3.3.0
 408 ==============
 409
 410 Release Data
 411 ------------
 412
 413 +--------------------------------------+--------------------------------------------------------+
 414 | **CPS Project**                      |                                                        |
 415 |                                      |                                                        |
 416 +--------------------------------------+--------------------------------------------------------+
 417 | **Docker images**                    | onap/cps-and-ncmp:3.3.0                                |
 418 |                                      |                                                        |
 419 +--------------------------------------+--------------------------------------------------------+
 420 | **Release designation**              | 3.3.0 Montreal                                         |
 421 |                                      |                                                        |
 422 +--------------------------------------+--------------------------------------------------------+
 423 | **Release date**                     | 2023 April 20                                          |
 424 |                                      |                                                        |
 425 +--------------------------------------+--------------------------------------------------------+
 426
 427 Bug Fixes
 428 ---------
 429 3.3.0
 430     - None
 431
 432 Features
 433 --------
 434     - `CPS-1215 <https://jira.onap.org/browse/CPS-1215>`_ Add OR operation for CPS Path
 435     - `CPS-1617 <https://jira.onap.org/browse/CPS-1617>`_ Use cascade delete in fragments table
 436
 437 ..      ======================
 438 ..      * * *   LONDON   * * *
 439 ..      ======================
 440
 441 Version: 3.2.6
 442 ==============
 443
 444 Release Data
 445 ------------
 446
 447 +--------------------------------------+--------------------------------------------------------+
 448 | **CPS Project**                      |                                                        |
 449 |                                      |                                                        |
 450 +--------------------------------------+--------------------------------------------------------+
 451 | **Docker images**                    | onap/cps-and-ncmp:3.2.6                                |
 452 |                                      |                                                        |
 453 +--------------------------------------+--------------------------------------------------------+
 454 | **Release designation**              | 3.2.6 London                                           |
 455 |                                      |                                                        |
 456 +--------------------------------------+--------------------------------------------------------+
 457 | **Release date**                     | 2023 March 22                                          |
 458 |                                      |                                                        |
 459 +--------------------------------------+--------------------------------------------------------+
 460
 461 Bug Fixes
 462 ---------
 463 3.2.6
 464     - `CPS-1526 <https://jira.onap.org/browse/CPS-1526>`_ Fix response message for PATCH operation
 465     - `CPS-1563 <https://jira.onap.org/browse/CPS-1563>`_ Fix 500 response error on id-searches with empty parameters
 466
 467 Features
 468 --------
 469     - `CPS-1396 <https://jira.onap.org/browse/CPS-1396>`_ Query data nodes across all anchors under one dataspace
 470
 471 Version: 3.2.5
 472 ==============
 473
 474 Release Data
 475 ------------
 476
 477 +--------------------------------------+--------------------------------------------------------+
 478 | **CPS Project**                      |                                                        |
 479 |                                      |                                                        |
 480 +--------------------------------------+--------------------------------------------------------+
 481 | **Docker images**                    | onap/cps-and-ncmp:3.2.5                                |
 482 |                                      |                                                        |
 483 +--------------------------------------+--------------------------------------------------------+
 484 | **Release designation**              | 3.2.5 London                                           |
 485 |                                      |                                                        |
 486 +--------------------------------------+--------------------------------------------------------+
 487 | **Release date**                     | 2023 March 10                                          |
 488 |                                      |                                                        |
 489 +--------------------------------------+--------------------------------------------------------+
 490
 491 Bug Fixes
 492 ---------
 493 3.2.5
 494     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ Introduce control switch for model loader functionality.
 495
 496 Features
 497 --------
 498     - None
 499
 500 Version: 3.2.4
 501 ==============
 502
 503 Release Data
 504 ------------
 505
 506 +--------------------------------------+--------------------------------------------------------+
 507 | **CPS Project**                      |                                                        |
 508 |                                      |                                                        |
 509 +--------------------------------------+--------------------------------------------------------+
 510 | **Docker images**                    | onap/cps-and-ncmp:3.2.4                                |
 511 |                                      |                                                        |
 512 +--------------------------------------+--------------------------------------------------------+
 513 | **Release designation**              | 3.2.4 London                                           |
 514 |                                      |                                                        |
 515 +--------------------------------------+--------------------------------------------------------+
 516 | **Release date**                     | 2023 March 09                                          |
 517 |                                      |                                                        |
 518 +--------------------------------------+--------------------------------------------------------+
 519
 520 Bug Fixes
 521 ---------
 522 3.2.4
 523     - `CPS-1533 <https://jira.onap.org/browse/CPS-1533>`_ Fix for Temp tables cause Out of shared memory errors in Postgres
 524     - `CPS-1537 <https://jira.onap.org/browse/CPS-1537>`_ NCMP failed to start due to issue in SubscriptionModelLoader
 525
 526 Features
 527 --------
 528     - None
 529
 530 Version: 3.2.3
 531 ==============
 532
 533 Release Data
 534 ------------
 535
 536 +--------------------------------------+--------------------------------------------------------+
 537 | **CPS Project**                      |                                                        |
 538 |                                      |                                                        |
 539 +--------------------------------------+--------------------------------------------------------+
 540 | **Docker images**                    | onap/cps-and-ncmp:3.2.3                                |
 541 |                                      |                                                        |
 542 +--------------------------------------+--------------------------------------------------------+
 543 | **Release designation**              | 3.2.3 London                                           |
 544 |                                      |                                                        |
 545 +--------------------------------------+--------------------------------------------------------+
 546 | **Release date**                     | 2023 March 07                                          |
 547 |                                      |                                                        |
 548 +--------------------------------------+--------------------------------------------------------+
 549
 550 Bug Fixes
 551 ---------
 552 3.2.3
 553    - `CPS-1494 <https://jira.onap.org/browse/CPS-1494>`_ NCMP Inventory Performance Improvements
 554
 555 Features
 556 --------
 557     - `CPS-1401 <https://jira.onap.org/browse/CPS-1401>`_ Added V2 of Get Data Node API,support to retrieve all data nodes under an anchor
 558     - `CPS-1502 <https://jira.onap.org/browse/CPS-1502>`_ Delete Performance Improvements
 559
 560 Version: 3.2.2
 561 ==============
 562
 563 Release Data
 564 ------------
 565
 566 +--------------------------------------+--------------------------------------------------------+
 567 | **CPS Project**                      |                                                        |
 568 |                                      |                                                        |
 569 +--------------------------------------+--------------------------------------------------------+
 570 | **Docker images**                    | onap/cps-and-ncmp:3.2.2                                |
 571 |                                      |                                                        |
 572 +--------------------------------------+--------------------------------------------------------+
 573 | **Release designation**              | 3.2.2 London                                           |
 574 |                                      |                                                        |
 575 +--------------------------------------+--------------------------------------------------------+
 576 | **Release date**                     | 2023 February 08                                       |
 577 |                                      |                                                        |
 578 +--------------------------------------+--------------------------------------------------------+
 579
 580 Bug Fixes
 581 ---------
 582 3.2.2
 583    - `CPS-1173 <https://jira.onap.org/browse/CPS-1173>`_  Delete Performance Improvements.
 584
 585 Features
 586 --------
 587    - None
 588
 589 Version: 3.2.1
 590 ==============
 591
 592 Release Data
 593 ------------
 594
 595 +--------------------------------------+--------------------------------------------------------+
 596 | **CPS Project**                      |                                                        |
 597 |                                      |                                                        |
 598 +--------------------------------------+--------------------------------------------------------+
 599 | **Docker images**                    | onap/cps-and-ncmp:3.2.1                                |
 600 |                                      |                                                        |
 601 +--------------------------------------+--------------------------------------------------------+
 602 | **Release designation**              | 3.2.1 London                                           |
 603 |                                      |                                                        |
 604 +--------------------------------------+--------------------------------------------------------+
 605 | **Release date**                     | 2023 January 27                                        |
 606 |                                      |                                                        |
 607 +--------------------------------------+--------------------------------------------------------+
 608
 609 Features
 610 --------
 611 3.2.1
 612    - `CPS-341 <https://jira.onap.org/browse/CPS-341>`_  Added support for multiple data tree instances under 1 anchor.
 613    - `CPS-1002 <https://jira.onap.org/browse/CPS-1002>`_  Add CPS-E-05 endpoint for 'Query data, NCMP-Operational Datastore' using cpsPaths
 614    - `CPS-1182 <https://jira.onap.org/browse/CPS-1182>`_  Upgrade Opendaylight
 615    - `CPS-1185 <https://jira.onap.org/browse/CPS-1185>`_  Get all dataspaces.
 616    - `CPS-1186 <https://jira.onap.org/browse/CPS-1186>`_  Get single dataspace.
 617    - `CPS-1187 <https://jira.onap.org/browse/CPS-1187>`_  Added API to get all schema sets for a given dataspace.
 618    - `CPS-1236 <https://jira.onap.org/browse/CPS-1236>`_  DMI audit support for NCMP: Filter on any properties of CM Handles
 619    - `CPS-1257 <https://jira.onap.org/browse/CPS-1257>`_  Added support for application/xml Content-Type (write only).
 620    - `CPS-1381 <https://jira.onap.org/browse/CPS-1381>`_  Query large outputs using limit/depth/pagination
 621    - `CPS-1421 <https://jira.onap.org/browse/CPS-1421>`_  Optimized query for large number of hits with descendants.
 622    - `CPS-1422 <https://jira.onap.org/browse/CPS-1422>`_  Fetch CM handles by collection of xpaths (CPS Core)
 623    - `CPS-1424 <https://jira.onap.org/browse/CPS-1424>`_  Updating CmHandleStates using batch operation
 624    - `CPS-1439 <https://jira.onap.org/browse/CPS-1439>`_  Use native query to delete data nodes
 625
 626 Bug Fixes
 627 ---------
 628 3.2.1
 629    - `CPS-1171 <https://jira.onap.org/browse/CPS-1171>`_  Optimized retrieval of data nodes with many descendants.
 630    - `CPS-1288 <https://jira.onap.org/browse/CPS-1288>`_  Hazelcast TTL for IMap is not working
 631    - `CPS-1289 <https://jira.onap.org/browse/CPS-1289>`_  Getting wrong error code for create node api
 632    - `CPS-1326 <https://jira.onap.org/browse/CPS-1326>`_  Creation of DataNodeBuilder with module name prefix is very slow
 633    - `CPS-1344 <https://jira.onap.org/browse/CPS-1344>`_  Top level container (prefix) is not always the first module
 634    - `CPS-1350 <https://jira.onap.org/browse/CPS-1350>`_  Add Basic Authentication to CPS/NCMP OpenAPI Definitions.
 635    - `CPS-1352 <https://jira.onap.org/browse/CPS-1352>`_  Handle YangChoiceNode in right format.
 636    - `CPS-1409 <https://jira.onap.org/browse/CPS-1409>`_  Fix Delete uses case with '/' in path.
 637    - `CPS-1433 <https://jira.onap.org/browse/CPS-1433>`_  Fix to allow posting data with '/' key fields.
 638    - `CPS-1442 <https://jira.onap.org/browse/CPS-1442>`_  CPS PATCH operation does not merge existing data
 639    - `CPS-1446 <https://jira.onap.org/browse/CPS-1446>`_  Locked cmhandles and ready to locked state transitions causing long cmHandle discovery
 640    - `CPS-1457 <https://jira.onap.org/browse/CPS-1457>`_  CpsDataPersistenceService#getDataNodes uses non-normalized xpaths
 641    - `CPS-1458 <https://jira.onap.org/browse/CPS-1458>`_  CpsDataPersistenceService#getDataNodes does not handle root xpath
 642    - `CPS-1460 <https://jira.onap.org/browse/CPS-1460>`_  CPS Path Processing Performance Test duration is too low
 643
 644 3.2.0
 645    - `CPS-1312 <https://jira.onap.org/browse/CPS-1312>`_  CPS(/NCMP) does not have version control.
 646
 647 Known Limitations, Issues and Workarounds
 648 -----------------------------------------
 649
 650 *System Limitations*
 651
 652 For upgrading, CPS uses Liquibase for database upgrades. CPS/NCMP currently only supports upgrading from Liquibase changelog 11 to Liquibase changelog 16.
 653 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.
 654
 655 CPS core Patch operation currently supports updating data of one top level data node. When performing Patch on multiple top level data nodes at once
 656 a 400 Bad Request is sent as response. This is part of commit CPS-1526.
 657
 658 ..      ====================
 659 ..      * * *   KOHN   * * *
 660 ..      ====================
 661
 662 Version: 3.1.4
 663 ==============
 664
 665 Release Data
 666 ------------
 667
 668 +--------------------------------------+--------------------------------------------------------+
 669 | **CPS Project**                      |                                                        |
 670 |                                      |                                                        |
 671 +--------------------------------------+--------------------------------------------------------+
 672 | **Docker images**                    | onap/cps-and-ncmp:3.1.4                                |
 673 |                                      |                                                        |
 674 +--------------------------------------+--------------------------------------------------------+
 675 | **Release designation**              | 3.1.4 Kohn                                             |
 676 |                                      |                                                        |
 677 +--------------------------------------+--------------------------------------------------------+
 678 | **Release date**                     | 2022 October 5                                         |
 679 |                                      |                                                        |
 680 +--------------------------------------+--------------------------------------------------------+
 681
 682 Bug Fixes
 683 ---------
 684    - `CPS-1265 <https://jira.onap.org/browse/CPS-1265>`_  Revision field should not be required (NotNull) on cps-ri YangResourceEntity
 685    - `CPS-1294 <https://jira.onap.org/browse/CPS-1294>`_  Kafka communication fault caused cmHandle registration error
 686
 687 Version: 3.1.3
 688 ==============
 689
 690 Release Data
 691 ------------
 692
 693 +--------------------------------------+--------------------------------------------------------+
 694 | **CPS Project**                      |                                                        |
 695 |                                      |                                                        |
 696 +--------------------------------------+--------------------------------------------------------+
 697 | **Docker images**                    | onap/cps-and-ncmp:3.1.3                                |
 698 |                                      |                                                        |
 699 +--------------------------------------+--------------------------------------------------------+
 700 | **Release designation**              | 3.1.3 Kohn                                             |
 701 |                                      |                                                        |
 702 +--------------------------------------+--------------------------------------------------------+
 703 | **Release date**                     | 2022 September 29                                      |
 704 |                                      |                                                        |
 705 +--------------------------------------+--------------------------------------------------------+
 706
 707 Bug Fixes
 708 ---------
 709    - None
 710
 711 Version: 3.1.2
 712 ==============
 713
 714 Release Data
 715 ------------
 716
 717 +--------------------------------------+--------------------------------------------------------+
 718 | **CPS Project**                      |                                                        |
 719 |                                      |                                                        |
 720 +--------------------------------------+--------------------------------------------------------+
 721 | **Docker images**                    | onap/cps-and-ncmp:3.1.2                                |
 722 |                                      |                                                        |
 723 +--------------------------------------+--------------------------------------------------------+
 724 | **Release designation**              | 3.1.2 Kohn                                             |
 725 |                                      |                                                        |
 726 +--------------------------------------+--------------------------------------------------------+
 727 | **Release date**                     | 2022 September 28                                      |
 728 |                                      |                                                        |
 729 +--------------------------------------+--------------------------------------------------------+
 730
 731 Bug Fixes
 732 ---------
 733    - None
 734
 735 Version: 3.1.1
 736 ==============
 737
 738 Release Data
 739 ------------
 740
 741 +--------------------------------------+--------------------------------------------------------+
 742 | **CPS Project**                      |                                                        |
 743 |                                      |                                                        |
 744 +--------------------------------------+--------------------------------------------------------+
 745 | **Docker images**                    | onap/cps-and-ncmp:3.1.1                                |
 746 |                                      |                                                        |
 747 +--------------------------------------+--------------------------------------------------------+
 748 | **Release designation**              | 3.1.1 Kohn                                             |
 749 |                                      |                                                        |
 750 +--------------------------------------+--------------------------------------------------------+
 751 | **Release date**                     | 2022 September 28                                      |
 752 |                                      |                                                        |
 753 +--------------------------------------+--------------------------------------------------------+
 754
 755 Bug Fixes
 756 ---------
 757    - None
 758
 759 Security Notes
 760 --------------
 761
 762 *Fixed Security Issues*
 763
 764    - `CPS-1226 <https://jira.onap.org/browse/CPS-1226>`_  Security bug in the logs
 765
 766 Version: 3.1.0
 767 ==============
 768
 769 Release Data
 770 ------------
 771
 772 +--------------------------------------+--------------------------------------------------------+
 773 | **CPS Project**                      |                                                        |
 774 |                                      |                                                        |
 775 +--------------------------------------+--------------------------------------------------------+
 776 | **Docker images**                    | onap/cps-and-ncmp:3.1.0                                |
 777 |                                      |                                                        |
 778 +--------------------------------------+--------------------------------------------------------+
 779 | **Release designation**              | 3.1.0 Kohn                                             |
 780 |                                      |                                                        |
 781 +--------------------------------------+--------------------------------------------------------+
 782 | **Release date**                     | 2022 September 14                                      |
 783 |                                      |                                                        |
 784 +--------------------------------------+--------------------------------------------------------+
 785
 786 Features
 787 --------
 788    - `CPS-340 <https://jira.onap.org/browse/CPS-340>`_  Patch and update the root data node
 789    - `CPS-575 <https://jira.onap.org/browse/CPS-575>`_  Write data for cmHandle using ncmp-datastores:passthrough-running (NCMP.)
 790    - `CPS-731 <https://jira.onap.org/browse/CPS-731>`_  Query based on Public CM Properties
 791    - `CPS-828 <https://jira.onap.org/browse/CPS-828>`_  Async: NCMP Rest impl. including Request ID generation
 792    - `CPS-829 <https://jira.onap.org/browse/CPS-829>`_  Async: Internal message topic incl. basic producer & Consumer
 793    - `CPS-830 <https://jira.onap.org/browse/CPS-830>`_  DMI-NCMP Asynchronously Publish Response Event to Client Topic
 794    - `CPS-869 <https://jira.onap.org/browse/CPS-869>`_  Apply Standardized logging fields to adhere to ONAP Best practice REQ-1072
 795    - `CPS-870 <https://jira.onap.org/browse/CPS-870>`_  Align CPS-Core output with SDN-C output (add module name)
 796    - `CPS-875 <https://jira.onap.org/browse/CPS-875>`_  CM Handle State: Watchdog-process that syncs 'ADVISED' CM Handles
 797    - `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'
 798    - `CPS-899 <https://jira.onap.org/browse/CPS-899>`_  Start and stop sessions on Java API
 799    - `CPS-909 <https://jira.onap.org/browse/CPS-909>`_  Separate NCMP endpoint for ch/{cm-handle}/properties and ch/{cm-handle}/state
 800    - `CPS-917 <https://jira.onap.org/browse/CPS-917>`_  Structured Errors response for passthrough use-cases in NCMP
 801    - `CPS-953 <https://jira.onap.org/browse/CPS-953>`_  Update maven deploy plugin version
 802    - `CPS-977 <https://jira.onap.org/browse/CPS-977>`_  Query CM Handles using CpsPath
 803    - `CPS-1000 <https://jira.onap.org/browse/CPS-1000>`_  Create Data Synchronization watchdog
 804    - `CPS-1016 <https://jira.onap.org/browse/CPS-1016>`_  Merge 2 'query' end points in NCMP
 805    - `CPS-1034 <https://jira.onap.org/browse/CPS-1034>`_  Publish lifecycle events for ADVISED , READY and LOCKED state transition"
 806    - `CPS-1064 <https://jira.onap.org/browse/CPS-1064>`_  Support retrieval of YANG module sources for CM handle on the NCMP interface
 807    - `CPS-1099 <https://jira.onap.org/browse/CPS-1099>`_  Expose simplified 'external' lock reason enum state over REST interface
 808    - `CPS-1101 <https://jira.onap.org/browse/CPS-1101>`_  Introducing the DELETING and DELETED Cmhandle State
 809    - `CPS-1102 <https://jira.onap.org/browse/CPS-1102>`_  Register the Cmhandle Sends Advised State notification.
 810    - `CPS-1133 <https://jira.onap.org/browse/CPS-1133>`_  Enable/Disable Data Sync for Cm Handle
 811    - `CPS-1136 <https://jira.onap.org/browse/CPS-1136>`_  DMI Audit Support (get all CM Handles for a registered DMI)
 812
 813
 814 Bug Fixes
 815 ---------
 816    - `CPS-896 <https://jira.onap.org/browse/CPS-896>`_  CM Handle Registration Process only partially completes when exception is thrown
 817    - `CPS-957 <https://jira.onap.org/browse/CPS-957>`_  NCMP: fix getResourceDataForPassthroughOperational endpoint
 818    - `CPS-1020 <https://jira.onap.org/browse/CPS-1020>`_  DuplicatedYangResourceException error at parallel cmHandle registration
 819    - `CPS-1056 <https://jira.onap.org/browse/CPS-1056>`_  Wrong error response format in case of Dmi plugin error
 820    - `CPS-1067 <https://jira.onap.org/browse/CPS-1067>`_  NCMP returns 500 error on searches endpoint when No DMI Handles registered
 821    - `CPS-1085 <https://jira.onap.org/browse/CPS-1085>`_  Performance degradation on ncmp/v1/ch/searches endpoint
 822    - `CPS-1088 <https://jira.onap.org/browse/CPS-1088>`_  Kafka consumer can not be turned off
 823    - `CPS-1097 <https://jira.onap.org/browse/CPS-1097>`_  Unable to change state from LOCKED to ADVISED
 824    - `CPS-1126 <https://jira.onap.org/browse/CPS-1126>`_  CmHandle creation performance degradation
 825    - `CPS-1175 <https://jira.onap.org/browse/CPS-1175>`_  Incorrect response when empty body executed for cmhandle id-searches
 826    - `CPS-1179 <https://jira.onap.org/browse/CPS-1179>`_  Node API - GET method returns invalid response when identifier contains '/'
 827    - `CPS-1212 <https://jira.onap.org/browse/CPS-1212>`_  Additional Properties for CM Handles not included when send to DMI Plugin
 828    - `CPS-1217 <https://jira.onap.org/browse/CPS-1217>`_  Searches endpoint gives back empty list however there are already available cmhandles
 829    - `CPS-1218 <https://jira.onap.org/browse/CPS-1218>`_  NCMP logs are flooded with SyncUtils logs
 830
 831 Known Limitations, Issues and Workarounds
 832 -----------------------------------------
 833
 834 *System Limitations*
 835
 836 Having '[' token in any index in any list will have a negative impact on the search functions leaf-conditions and text()-condition.
 837 Example of an xpath that would cause problems while using cps-path queries : /parent/child[@id='id[with]braces']
 838
 839 *Known Vulnerabilities*
 840
 841 None
 842
 843 *Workarounds*
 844
 845 None
 846
 847 Security Notes
 848 --------------
 849
 850 *Fixed Security Issues*
 851
 852    - `CPS-963 <https://jira.onap.org/browse/CPS-963>`_  Liquibase has got serious vulnerability, upgrade required
 853
 854 *Known Security Issues*
 855
 856 None
 857
 858 ..      ========================
 859 ..      * * *   JAKARTA   * * *
 860 ..      ========================
 861
 862 Version: 3.0.1
 863 ==============
 864
 865 Release Data
 866 ------------
 867
 868 +--------------------------------------+--------------------------------------------------------+
 869 | **CPS Project**                      |                                                        |
 870 |                                      |                                                        |
 871 +--------------------------------------+--------------------------------------------------------+
 872 | **Docker images**                    | onap/cps-and-ncmp:3.0.1                                |
 873 |                                      |                                                        |
 874 +--------------------------------------+--------------------------------------------------------+
 875 | **Release designation**              | 3.0.1 Jakarta                                          |
 876 |                                      |                                                        |
 877 +--------------------------------------+--------------------------------------------------------+
 878 | **Release date**                     | 2022 April 28                                          |
 879 |                                      |                                                        |
 880 +--------------------------------------+--------------------------------------------------------+
 881
 882 Bug Fixes
 883 ---------
 884    - `CPS-961 <https://jira.onap.org/browse/CPS-961>`_  Updated ANTLR compiler version to 4.9.2 to be compatible with runtime version
 885
 886 Version: 3.0.0
 887 ==============
 888
 889 Release Data
 890 ------------
 891
 892 +--------------------------------------+--------------------------------------------------------+
 893 | **CPS Project**                      |                                                        |
 894 |                                      |                                                        |
 895 +--------------------------------------+--------------------------------------------------------+
 896 | **Docker images**                    | onap/cps-and-ncmp:3.0.0                                |
 897 |                                      |                                                        |
 898 +--------------------------------------+--------------------------------------------------------+
 899 | **Release designation**              | 3.0.0 Jakarta                                          |
 900 |                                      |                                                        |
 901 +--------------------------------------+--------------------------------------------------------+
 902 | **Release date**                     | 2022 March 15                                          |
 903 |                                      |                                                        |
 904 +--------------------------------------+--------------------------------------------------------+
 905
 906 Features
 907 --------
 908    - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_  Define response objects (schemas) in cps-ncmp
 909    - `CPS-636 <https://jira.onap.org/browse/CPS-636>`_  Update operation for datastore pass through running
 910    - `CPS-638 <https://jira.onap.org/browse/CPS-638>`_  Delete operation for datastore pass through running
 911    - `CPS-677 <https://jira.onap.org/browse/CPS-677>`_  Support 'public' Cm Handle Properties
 912    - `CPS-741 <https://jira.onap.org/browse/CPS-741>`_  Re sync after removing cm handles
 913    - `CPS-777 <https://jira.onap.org/browse/CPS-777>`_  Ensure all DMI operations use POST method
 914    - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_  Add examples for parameters, request and response in openapi yaml for cps-core
 915    - `CPS-789 <https://jira.onap.org/browse/CPS-789>`_ CPS Data Updated Event Schema V2 to support delete operation
 916    - `CPS-791 <https://jira.onap.org/browse/CPS-791>`_ CPS-Core sends delete notification event
 917    - `CPS-817 <https://jira.onap.org/browse/CPS-817>`_  Create Endpoint For Get Cm Handles (incl. public properties) By Name
 918    - `CPS-837 <https://jira.onap.org/browse/CPS-837>`_  Add Remove and Update properties (DMI and Public) as part of CM Handle Registration update
 919
 920 Bug Fixes
 921 ---------
 922
 923    - `CPS-762 <https://jira.onap.org/browse/CPS-762>`_ Query cm handles for module names returns incorrect cm handle identifiers
 924    - `CPS-788 <https://jira.onap.org/browse/CPS-788>`_ Yang Resource formatting is incorrect
 925    - `CPS-783 <https://jira.onap.org/browse/CPS-783>`_ Remove cm handle does not completely remove all cm handle information
 926    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM
 927    - `CPS-856 <https://jira.onap.org/browse/CPS-856>`_ Retry mechanism not working for concurrent CmHandle registration
 928    - `CPS-867 <https://jira.onap.org/browse/CPS-867>`_ Database port made configurable through env variable DB_PORT
 929    - `CPS-886 <https://jira.onap.org/browse/CPS-886>`_ Fragment handling decreasing performance for large number of cmHandles
 930    - `CPS-887 <https://jira.onap.org/browse/CPS-887>`_ Increase performance of cmHandle registration for large number of schema sets in DB
 931    - `CPS-892 <https://jira.onap.org/browse/CPS-892>`_ Fixed the response code during CM-Handle Registration from 201 CREATED to 204 NO_CONTENT
 932    - `CPS-893 <https://jira.onap.org/browse/CPS-893>`_ NCMP Java API depends on NCMP-Rest-API (cyclic) through json properties on Java API
 933
 934 Known Limitations, Issues and Workarounds
 935 -----------------------------------------
 936
 937 *System Limitations*
 938
 939 Null can no longer be passed within the dmi plugin service names when registering a cm handle, as part of
 940 `CPS-837 <https://jira.onap.org/browse/CPS-837>`_ null is now used to indicate if a property should be removed as part
 941 of cm handle registration.
 942
 943 The Absolute path to list with integer key will not work. Please refer `CPS-961 <https://jira.onap.org/browse/CPS-961>`_
 944 for more information.
 945
 946 *Known Vulnerabilities*
 947
 948 None
 949
 950 *Workarounds*
 951
 952 Instead of passing null as a value within the dmi plugin service names, remove them from the request completely, or
 953 pass an empty string as the value if you do not want to include names for these values.
 954
 955 Security Notes
 956 --------------
 957
 958 *Fixed Security Issues*
 959
 960 None
 961
 962 *Known Security Issues*
 963
 964 None
 965
 966 ..      ========================
 967 ..      * * *   ISTANBUL   * * *
 968 ..      ========================
 969
 970 Version: 2.0.4
 971 ==============
 972
 973 Release Data
 974 ------------
 975
 976 +--------------------------------------+--------------------------------------------------------+
 977 | **CPS Project**                      |                                                        |
 978 |                                      |                                                        |
 979 +--------------------------------------+--------------------------------------------------------+
 980 | **Docker images**                    | onap/cps-and-ncmp:2.0.4                                |
 981 |                                      |                                                        |
 982 +--------------------------------------+--------------------------------------------------------+
 983 | **Release designation**              | 2.0.4 Istanbul                                         |
 984 |                                      |                                                        |
 985 +--------------------------------------+--------------------------------------------------------+
 986 | **Release date**                     | 2022 Feb 09                                            |
 987 |                                      |                                                        |
 988 +--------------------------------------+--------------------------------------------------------+
 989
 990 Bug Fixes
 991 ---------
 992
 993    - `CPS-879 <https://jira.onap.org/browse/CPS-879>`_  Fix docker compose for csit test.
 994    - `CPS-873 <https://jira.onap.org/browse/CPS-873>`_  Fix intermittent circular dependency error when the application starts.
 995
 996 Version: 2.0.3
 997 ==============
 998
 999 Release Data
1000 ------------
1001
1002 +--------------------------------------+--------------------------------------------------------+
1003 | **CPS Project**                      |                                                        |
1004 |                                      |                                                        |
1005 +--------------------------------------+--------------------------------------------------------+
1006 | **Docker images**                    | onap/cps-and-ncmp:2.0.3                                |
1007 |                                      |                                                        |
1008 +--------------------------------------+--------------------------------------------------------+
1009 | **Release designation**              | 2.0.3 Istanbul                                         |
1010 |                                      |                                                        |
1011 +--------------------------------------+--------------------------------------------------------+
1012 | **Release date**                     | 2022-07-01                                             |
1013 |                                      |                                                        |
1014 +--------------------------------------+--------------------------------------------------------+
1015
1016 Bug Fixes
1017 ---------
1018
1019    - `CPS-841 <https://jira.onap.org/browse/CPS-841>`_  Update log4j version to 2.17.1 due to security vulnerability
1020
1021 Version: 2.0.2
1022 ==============
1023
1024 Release Data
1025 ------------
1026
1027 +--------------------------------------+--------------------------------------------------------+
1028 | **CPS Project**                      |                                                        |
1029 |                                      |                                                        |
1030 +--------------------------------------+--------------------------------------------------------+
1031 | **Docker images**                    | onap/cps-and-ncmp:2.0.2                                |
1032 |                                      |                                                        |
1033 +--------------------------------------+--------------------------------------------------------+
1034 | **Release designation**              | 2.0.2 Istanbul                                         |
1035 |                                      |                                                        |
1036 +--------------------------------------+--------------------------------------------------------+
1037 | **Release date**                     | 2021-16-12                                             |
1038 |                                      |                                                        |
1039 +--------------------------------------+--------------------------------------------------------+
1040
1041 Bug Fixes
1042 ---------
1043
1044    - `CPS-820 <https://jira.onap.org/browse/CPS-820>`_  Update log4j version due to security vulnerability
1045
1046 Version: 2.0.1
1047 ==============
1048
1049 Release Data
1050 ------------
1051
1052 +--------------------------------------+--------------------------------------------------------+
1053 | **CPS Project**                      |                                                        |
1054 |                                      |                                                        |
1055 +--------------------------------------+--------------------------------------------------------+
1056 | **Docker images**                    | onap/cps-and-ncmp:2.0.1                                |
1057 |                                      |                                                        |
1058 +--------------------------------------+--------------------------------------------------------+
1059 | **Release designation**              | 2.0.1 Istanbul                                         |
1060 |                                      |                                                        |
1061 +--------------------------------------+--------------------------------------------------------+
1062 | **Release date**                     | 2021-14-10                                             |
1063 |                                      |                                                        |
1064 +--------------------------------------+--------------------------------------------------------+
1065
1066 Bug Fixes
1067 ---------
1068
1069    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1070    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1071    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1072    - `CPS-691 <https://jira.onap.org/browse/CPS-691>`_ NCMP no master index label on index documentation page
1073
1074 Known Limitations, Issues and Workarounds
1075 -----------------------------------------
1076
1077 *System Limitations*
1078
1079 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1080
1081 *Known Vulnerabilities*
1082
1083    - `CPS-725 <https://jira.onap.org/browse/CPS-725>`_ fix sample docker compose of cps/ncmp and onap dmi plugin
1084
1085 *Workarounds*
1086
1087 Add recursive method to save list node data to loop through all corresponding child nodes.
1088
1089 Security Notes
1090 --------------
1091
1092 *Fixed Security Issues*
1093
1094    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1095
1096 *Known Security Issues*
1097
1098 None
1099
1100 Version: 2.0.0
1101 ==============
1102
1103 Abstract
1104 --------
1105
1106 This document provides the release notes for Istanbul release.
1107
1108 Release Data
1109 ------------
1110
1111 +--------------------------------------+--------------------------------------------------------+
1112 | **CPS Project**                      |                                                        |
1113 |                                      |                                                        |
1114 +--------------------------------------+--------------------------------------------------------+
1115 | **Docker images**                    | onap/cps-and-ncmp:2.0.0                                |
1116 |                                      |                                                        |
1117 +--------------------------------------+--------------------------------------------------------+
1118 | **Release designation**              | 2.0.0 Istanbul                                         |
1119 |                                      |                                                        |
1120 +--------------------------------------+--------------------------------------------------------+
1121 | **Release date**                     | 2021-14-09                                             |
1122 |                                      |                                                        |
1123 +--------------------------------------+--------------------------------------------------------+
1124
1125 Features
1126 --------
1127 * Register DMI-Plugins with NCMP for CM Handle registrations.
1128 * Update, Create and Remove CM Handles.
1129 * Add support for retrieving and writing CM Handle data through NCMP datastores.
1130 * Automatic retrieval and caching of model information for CM Handles within NCMP.
1131
1132 Deliverables
1133 ------------
1134
1135 Software Deliverables
1136
1137 .. csv-table::
1138    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1139    :widths: auto
1140
1141    "cps", "", "onap/cps-and-ncmp-proxy:2.0.0"
1142
1143 Bug Fixes
1144 ---------
1145
1146    - `CPS-310 <https://jira.onap.org/browse/CPS-310>`_ Data schema migration from Honolulu to Istanbul is failing
1147    - `CPS-316 <https://jira.onap.org/browse/CPS-316>`_ Xpath cannot be created for augmentation data node
1148    - `CPS-336 <https://jira.onap.org/browse/CPS-336>`_ Ends-with functionality in cpsPath does not conform with standard xPath behavior
1149    - `CPS-345 <https://jira.onap.org/browse/CPS-345>`_ Leaf String value comparison matches mix of single and double quotes
1150    - `CPS-357 <https://jira.onap.org/browse/CPS-357>`_ cps-review-verification-maven-master Jenkins job is failing when running csit test
1151    - `CPS-367 <https://jira.onap.org/browse/CPS-367>`_ Get descendent does not support xpaths that end in list values
1152    - `CPS-377 <https://jira.onap.org/browse/CPS-377>`_ Init ran model validation is failing error details are not provided
1153    - `CPS-422 <https://jira.onap.org/browse/CPS-422>`_ REST 404 response returned instead of 400 for POST/PUT/PATCH request types
1154    - `CPS-450 <https://jira.onap.org/browse/CPS-450>`_ Datanode query using full path to node causes NPE
1155    - `CPS-451 <https://jira.onap.org/browse/CPS-451>`_ cps-ran-schema-model@2021-01-28.yang missing root container
1156    - `CPS-464 <https://jira.onap.org/browse/CPS-464>`_ Request to update node leaves (patch) responds with Internal Server Error
1157    - `CPS-465 <https://jira.onap.org/browse/CPS-465>`_ Request to update node leaves (patch) responds with json parsing failure
1158    - `CPS-466 <https://jira.onap.org/browse/CPS-466>`_ Concurrent requests to create schema sets for the same yang model are not supported
1159    - `CPS-479 <https://jira.onap.org/browse/CPS-479>`_ Get Nodes API does not always return the object from the root
1160    - `CPS-500 <https://jira.onap.org/browse/CPS-500>`_ Special Character Limitations of cpsPath Queries
1161    - `CPS-501 <https://jira.onap.org/browse/CPS-501>`_ Put DataNode API has missing transaction and error handling for concurrency issues
1162    - `CPS-524 <https://jira.onap.org/browse/CPS-524>`_ Issue with CPSData API to add an item to an existing list node
1163    - `CPS-560 <https://jira.onap.org/browse/CPS-560>`_ Response from cps query using text() contains escape characters
1164    - `CPS-566 <https://jira.onap.org/browse/CPS-566>`_ Can't access grandparent node through ancestor axis
1165    - `CPS-573 <https://jira.onap.org/browse/CPS-573>`_ /v1/ch/PNFDemo1/modules returning 401 unauthorised.
1166    - `CPS-587 <https://jira.onap.org/browse/CPS-587>`_ cps-ncmp-service NullpointerException when DmiPluginRegistration has no additionProperties
1167    - `CPS-591 <https://jira.onap.org/browse/CPS-591>`_ CPS-Core Leaf stored as integer is being returned from DB as float
1168    - `CPS-601 <https://jira.onap.org/browse/CPS-601>`_ CPS swagger-ui does not show NCMP endpoints
1169    - `CPS-616 <https://jira.onap.org/browse/CPS-616>`_ NCMP base path does not conform to agreed API URL
1170    - `CPS-630 <https://jira.onap.org/browse/CPS-630>`_ Incorrect information sent when same anchor is updated faster than notification service processes
1171    - `CPS-635 <https://jira.onap.org/browse/CPS-635>`_ Module Resource call does not include body
1172
1173 This document provides the release notes for Istanbul release.
1174
1175 Summary
1176 -------
1177
1178 Following CPS components are available with default ONAP/CPS installation.
1179
1180
1181     * Platform components
1182
1183         - CPS (Helm charts)
1184
1185     * Service components
1186
1187         - CPS-NCMP
1188         - DMI-Plugin
1189
1190     * Additional resources that CPS utilizes deployed using ONAP common charts
1191
1192         - Postgres Database
1193
1194
1195 Below service components (mS) are available to be deployed on-demand.
1196     - CPS-TBDMT
1197
1198
1199 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1200
1201 Known Limitations, Issues and Workarounds
1202 -----------------------------------------
1203
1204 *System Limitations*
1205
1206 Limitations to the amount of child nodes that can be added to the fix above. The current limit is 3.
1207
1208 *Known Vulnerabilities*
1209
1210    - `CPS-594 <https://jira.onap.org/browse/CPS-594>`_ SQL ConstraintViolationException when updating the list node element using PATCH List node API
1211    - `CPS-653 <https://jira.onap.org/browse/CPS-653>`_ cmHandleProperties not supported by dmi in fetch modules
1212    - `CPS-673 <https://jira.onap.org/browse/CPS-673>`_ Improvement and cleanup for CPS Core charts
1213
1214 *Workarounds*
1215
1216 Add recursive method to save list node data to loop through all corresponding child nodes.
1217
1218 Security Notes
1219 --------------
1220
1221 *Fixed Security Issues*
1222
1223    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1224
1225 *Known Security Issues*
1226
1227    - `CPS-581 <https://jira.onap.org/browse/CPS-581>`_ Remove security vulnerabilities
1228
1229 Test Results
1230 ------------
1231     * `Integration tests`
1232
1233 ..      ========================
1234 ..      * * *   HONOLULU   * * *
1235 ..      ========================
1236
1237 Version: 1.0.1
1238 ==============
1239
1240 Release Data
1241 ------------
1242
1243 +--------------------------------------+--------------------------------------------------------+
1244 | **CPS Project**                      |                                                        |
1245 |                                      |                                                        |
1246 +--------------------------------------+--------------------------------------------------------+
1247 | **Docker images**                    | onap/cps-and-nf-proxy:1.0.1                            |
1248 |                                      |                                                        |
1249 +--------------------------------------+--------------------------------------------------------+
1250 | **Release designation**              | 1.0.1 Honolulu                                         |
1251 |                                      |                                                        |
1252 +--------------------------------------+--------------------------------------------------------+
1253 | **Release date**                     | 2021-04-09                                             |
1254 |                                      |                                                        |
1255 +--------------------------------------+--------------------------------------------------------+
1256
1257 Bug Fixes
1258 ---------
1259
1260    - `CPS-706 <https://jira.onap.org/browse/CPS-706>`_ Get moduleschema/yangresouce endpoint not working
1261    - `CPS-276 <https://jira.onap.org/browse/CPS-276>`_ Improve error reporting for invalid cpsPath on Queries
1262    - `CPS-288 <https://jira.onap.org/browse/CPS-288>`_ Move security configuration to the application module
1263    - `CPS-290 <https://jira.onap.org/browse/CPS-290>`_ Internal Server Error when creating the same data node twice
1264    - `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
1265    - `CPS-300 <https://jira.onap.org/browse/CPS-304>`_ Not able to create data instances for 2 different anchors using the same model
1266    - `CPS-304 <https://jira.onap.org/browse/CPS-304>`_ Use ONAP recommended base Java Docker image
1267    - `CPS-308 <https://jira.onap.org/browse/CPS-308>`_ Not able to upload yang models files greater than 1MB
1268
1269 Security Notes
1270 --------------
1271
1272 *Fixed Security Issues*
1273
1274    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1275
1276 *Known Security Issues*
1277
1278    - `Security Waiver <https://wiki.onap.org/display/DW/Honolulu+Exception+Request+for+CPS>`_ Security - Expose external endpoints with https
1279
1280 Version: 1.0.0
1281 ==============
1282
1283
1284 Abstract
1285 --------
1286
1287 This document provides the release notes for Honolulu release.
1288
1289 Summary
1290 -------
1291
1292 Following CPS components are available with default ONAP/CPS installation.
1293
1294
1295     * Platform components
1296
1297         - CPS (Helm charts)
1298
1299     * Service components
1300
1301         - CPS Core
1302
1303     * Additional resources that CPS utilizes deployed using ONAP common charts
1304
1305         - Postgres Database
1306
1307
1308 Below service components (mS) are available to be deployed on-demand.
1309     - CPS-TBDMT
1310
1311
1312 Under OOM (Kubernetes) all CPS component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1313
1314
1315 Release Data
1316 ------------
1317
1318 +--------------------------------------+--------------------------------------------------------+
1319 | **CPS Project**                      |                                                        |
1320 |                                      |                                                        |
1321 +--------------------------------------+--------------------------------------------------------+
1322 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
1323 |                                      |                                                        |
1324 +--------------------------------------+--------------------------------------------------------+
1325 | **Release designation**              | 1.0.0 Honolulu                                         |
1326 |                                      |                                                        |
1327 +--------------------------------------+--------------------------------------------------------+
1328 | **Release date**                     | 2021-03-11                                             |
1329 |                                      |                                                        |
1330 +--------------------------------------+--------------------------------------------------------+
1331
1332
1333 Features
1334 --------
1335 Configuration Persistence Service is a model driven persistence solution for data described by YANG models.
1336 CPS has been driven by the needs of the E2E Networking Slicing use case.
1337 It currently supports basic (rw) persistence and simple queries.
1338 It also provides MVP support for network data access using simulated data.
1339
1340 .. _honolulu_deliverable:
1341
1342 Deliverables
1343 ------------
1344
1345 Software Deliverables
1346
1347 .. csv-table::
1348    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1349    :widths: auto
1350
1351    "cps", "", "onap/cps-and-nf-proxy:1.0.0"
1352
1353
1354 Known Limitations, Issues and Workarounds
1355 -----------------------------------------
1356
1357    - `CPS-249 <https://jira.onap.org/browse/CPS-249>`_ Exception stack trace is exposed
1358    - `CPS-264 <https://jira.onap.org/browse/CPS-264>`_ Unique timestamp is missing when tagging docker images.
1359    - Methods exposed on API which are yet not implemented : deleteAnchor, getNodesByDataspace & deleteDataspace.
1360    - `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.
1361
1362 *System Limitations*
1363
1364 None
1365
1366 *Known Vulnerabilities*
1367
1368 None
1369
1370 *Workarounds*
1371
1372 Documented under corresponding jira if applicable.
1373
1374 Security Notes
1375 --------------
1376
1377 *Fixed Security Issues*
1378
1379 * `CPS-167 <https://jira.onap.org/browse/CPS-167>`_ -Update CPS dependencies as Required for Honolulu release
1380     - Upgrade org.onap.oparent to 3.2.0
1381     - Upgrade spring.boot to 2.3.8.RELEASE
1382     - Upgrade yangtools to 5.0.7
1383
1384 *Known Security Issues*
1385
1386     * Weak Cryptography using md5
1387     * Risk seen in Zip file expansion
1388
1389 *Known Vulnerabilities in Used Modules*
1390
1391     None
1392
1393 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.
1394
1395 Test Results
1396 ------------
1397     * `Integration tests <https://wiki.onap.org/display/DW/CPS+Integration+Test+Cases>`_
1398
1399 References
1400 ----------
1401
1402 For more information on the latest ONAP release, please see:
1403
1404 #. `ONAP Home Page`_
1405 #. `ONAP Wiki Page`_
1406 #. `ONAP Documentation`_
1407 #. `ONAP CPS Documentation`_
1408 #. `ONAP Release Downloads`_
1409
1410
1411 .. _`ONAP Home Page`: https://www.onap.org
1412 .. _`ONAP Wiki Page`: https://wiki.onap.org
1413 .. _`ONAP Documentation`: https://docs.onap.org
1414 .. _`ONAP CPS Documentation`: https://docs.onap.org/projects/onap-cps
1415 .. _`ONAP Release Downloads`: https://git.onap.org
1416
1417 Quick Links:
1418
1419         - `CPS project page <https://wiki.onap.org/pages/viewpage.action?pageId=71834216>`_
1420         - `Passing Badge information for CPS <https://bestpractices.coreinfrastructure.org/en/projects/4398>`_