docs/sections/release-notes.rst

   1 ..
   2  This work is licensed under a Creative Commons Attribution 4.0
   3  International License.
   4 .. _release_notes:
   5
   6 =============
   7 Release Notes
   8 =============
   9
  10
  11 ..      ===========================
  12 ..      * * *   JAKARTA  * * *
  13 ..      ===========================
  14
  15 Abstract
  16 ========
  17
  18 This document provides the release notes for the JAKARTA release.
  19
  20 Summary
  21 =======
  22
  23
  24 Release Data
  25 ============
  26
  27
  28 +--------------------------------------+--------------------------------------+
  29 | **OOF Project**                      |                                      |
  30 |                                      |                                      |
  31 +--------------------------------------+--------------------------------------+
  32 | **Docker images**                    |   optf-osdf 3.0.6                    |
  33 |                                      |                                      |
  34 |                                      |                                      |
  35 +--------------------------------------+--------------------------------------+
  36 | **Release designation**              | 10.0.0 jakarta                       |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39 | **Release date**                     | 02/06/2022 (TBD)                     |
  40 |                                      |                                      |
  41 +--------------------------------------+--------------------------------------+
  42
  43
  44 New features
  45 ------------
  46
  47
  48
  49 Bug Fixes
  50 ---------
  51
  52 - OPTFRA-1059 - Update configuration for TN-FH in NxI termination app
  53
  54
  55 Known Limitations, Issues and Workarounds
  56 =========================================
  57
  58 System Limitations
  59 ------------------
  60
  61 Known Vulnerabilities
  62 ---------------------
  63
  64
  65 Workarounds
  66 -----------
  67
  68
  69 Security Notes
  70 --------------
  71
  72
  73 References
  74 ==========
  75
  76 For more information on the ONAP Jakarta release, please see:
  77
  78 #. `ONAP Home Page`_
  79 #. `ONAP Documentation`_
  80 #. `ONAP Release Downloads`_
  81 #. `ONAP Wiki Page`_
  82
  83 .. _`ONAP Home Page`: https://www.onap.org
  84 .. _`ONAP Wiki Page`: https://wiki.onap.org
  85 .. _`ONAP Documentation`: https://docs.onap.org
  86 .. _`ONAP Release Downloads`: https://git.onap.org
  87
  88 Quick Links:
  89
  90 - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
  91 - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
  92
  93
  94
  95 ..      ===========================
  96 ..      * * *   ISTANBUL  * * *
  97 ..      ===========================
  98
  99 Abstract
 100 ========
 101
 102 This document provides the release notes for the Istanbul release.
 103
 104 Summary
 105 =======
 106
 107
 108 Release Data
 109 ============
 110
 111
 112 +--------------------------------------+--------------------------------------+
 113 | **OOF Project**                      |                                      |
 114 |                                      |                                      |
 115 +--------------------------------------+--------------------------------------+
 116 | **Docker images**                    |   optf-osdf 3.0.6                    |
 117 |                                      |                                      |
 118 |                                      |                                      |
 119 +--------------------------------------+--------------------------------------+
 120 | **Release designation**              | 9.0.0 istanbul                       |
 121 |                                      |                                      |
 122 +--------------------------------------+--------------------------------------+
 123 | **Release date**                     | 28/10/2021 (TBD)                     |
 124 |                                      |                                      |
 125 +--------------------------------------+--------------------------------------+
 126
 127
 128 New features
 129 ------------
 130
 131 - Enhancements in NxI termination to support second level NSSIs
 132 - Update NxI termination app to use AAI DSL query
 133 - Add CPS client for PCI app
 134 - OSDF image optimization
 135
 136 Bug Fixes
 137 ---------
 138
 139 - OPTFRA-511 Return error when policies are not present
 140 - OPTFRA-943 Fix issues in NSI selection response
 141 - OPTFRA-853 Remove unwanted gplv3 components from docker image
 142
 143
 144 Known Limitations, Issues and Workarounds
 145 =========================================
 146
 147 System Limitations
 148 ------------------
 149
 150
 151 Known Vulnerabilities
 152 ---------------------
 153
 154
 155 Workarounds
 156 -----------
 157
 158
 159 Security Notes
 160 --------------
 161
 162
 163 References
 164 ==========
 165
 166 For more information on the ONAP Honolulu release, please see:
 167
 168 #. `ONAP Home Page`_
 169 #. `ONAP Documentation`_
 170 #. `ONAP Release Downloads`_
 171 #. `ONAP Wiki Page`_
 172
 173
 174 .. _`ONAP Home Page`: https://www.onap.org
 175 .. _`ONAP Wiki Page`: https://wiki.onap.org
 176 .. _`ONAP Documentation`: https://docs.onap.org
 177 .. _`ONAP Release Downloads`: https://git.onap.org
 178
 179 Quick Links:
 180     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 181     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 182
 183
 184 ..      ===========================
 185 ..      * * *   HONOLULU  * * *
 186 ..      ===========================
 187
 188 Abstract
 189 ========
 190
 191 This document provides the release notes for the Honolulu release.
 192
 193 Summary
 194 =======
 195
 196
 197 Release Data
 198 ============
 199
 200
 201 +--------------------------------------+--------------------------------------+
 202 | **OOF Project**                      |                                      |
 203 |                                      |                                      |
 204 +--------------------------------------+--------------------------------------+
 205 | **Docker images**                    |   optf-osdf 3.0.4                    |
 206 |                                      |                                      |
 207 |                                      |                                      |
 208 +--------------------------------------+--------------------------------------+
 209 | **Release designation**              | 8.0.0 honolulu                       |
 210 |                                      |                                      |
 211 +--------------------------------------+--------------------------------------+
 212 | **Release date**                     | 04/08/2021 (TBD)                     |
 213 |                                      |                                      |
 214 +--------------------------------------+--------------------------------------+
 215
 216
 217 New features
 218 ------------
 219
 220 - Add NST selection feature with AAI & SDC
 221 - Configuration management with consul KV store
 222
 223 Bug Fixes
 224 ---------
 225
 226 - OPTFRA-906  Update slice/service profile attributes
 227 - OPTFRA-871  Bug Fix in ML SON - convert cell_id before sending it to Minizinc
 228
 229
 230 Known Limitations, Issues and Workarounds
 231 =========================================
 232
 233 System Limitations
 234 ------------------
 235
 236
 237 Known Vulnerabilities
 238 ---------------------
 239
 240
 241 Workarounds
 242 -----------
 243
 244
 245 Security Notes
 246 --------------
 247
 248
 249 References
 250 ==========
 251
 252 For more information on the ONAP Honolulu release, please see:
 253
 254 #. `ONAP Home Page`_
 255 #. `ONAP Documentation`_
 256 #. `ONAP Release Downloads`_
 257 #. `ONAP Wiki Page`_
 258
 259
 260 .. _`ONAP Home Page`: https://www.onap.org
 261 .. _`ONAP Wiki Page`: https://wiki.onap.org
 262 .. _`ONAP Documentation`: https://docs.onap.org
 263 .. _`ONAP Release Downloads`: https://git.onap.org
 264
 265 Quick Links:
 266     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 267     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 268
 269 ..      ===========================
 270 ..      * * *   GUILIN   * * *
 271 ..      ===========================
 272
 273 Abstract
 274 ========
 275
 276 This document provides the release notes for the Guilin release.
 277
 278 Summary
 279 =======
 280
 281
 282 Release Data
 283 ============
 284
 285
 286 +--------------------------------------+--------------------------------------+
 287 | **OOF Project**                      |                                      |
 288 |                                      |                                      |
 289 +--------------------------------------+--------------------------------------+
 290 | **Docker images**                    |   optf-osdf 3.0.2                    |
 291 |                                      |                                      |
 292 |                                      |                                      |
 293 +--------------------------------------+--------------------------------------+
 294 | **Release designation**              | 7.0.0 guilin                         |
 295 |                                      |                                      |
 296 +--------------------------------------+--------------------------------------+
 297 | **Release date**                     | 2020-11-19 (TBD)                     |
 298 |                                      |                                      |
 299 +--------------------------------------+--------------------------------------+
 300
 301
 302 New features
 303 ------------
 304
 305 - NSI selection enhancements
 306 - Support for NSSI selection
 307 - Support for NSI/NSSI Termination
 308 - Support for Inter domain route optimization
 309 - Support for ML based SON optimization
 310 - Upgrade python version to 3.8
 311
 312 Bug Fixes
 313 ---------
 314
 315 - OPTFRA-839  Remove python 2.7 from OSDF docker image
 316 - OPTFRA-855  Fix slice selection API
 317 - OPTFRA-852  Callback implementation for NST selection
 318
 319 Known Limitations, Issues and Workarounds
 320 =========================================
 321
 322 System Limitations
 323 ------------------
 324
 325
 326 Known Vulnerabilities
 327 ---------------------
 328
 329
 330 Workarounds
 331 -----------
 332
 333
 334 Security Notes
 335 --------------
 336
 337
 338 References
 339 ==========
 340
 341 For more information on the ONAP Guilin release, please see:
 342
 343 #. `ONAP Home Page`_
 344 #. `ONAP Documentation`_
 345 #. `ONAP Release Downloads`_
 346 #. `ONAP Wiki Page`_
 347
 348
 349 .. _`ONAP Home Page`: https://www.onap.org
 350 .. _`ONAP Wiki Page`: https://wiki.onap.org
 351 .. _`ONAP Documentation`: https://docs.onap.org
 352 .. _`ONAP Release Downloads`: https://git.onap.org
 353
 354 Quick Links:
 355     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 356     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 357
 358 ..      ===========================
 359 ..      * * *    FRANKFURT    * * *
 360 ..      ===========================
 361
 362 Abstract
 363 ========
 364
 365 This document provides the release notes for the Frankfurt release.
 366
 367 Summary
 368 =======
 369
 370
 371 Release Data
 372 ============
 373
 374
 375 +--------------------------------------+--------------------------------------+
 376 | **OOF Project**                      |                                      |
 377 |                                      |                                      |
 378 +--------------------------------------+--------------------------------------+
 379 | **Docker images**                    |   optf-osdf 2.0.4                    |
 380 |                                      |                                      |
 381 |                                      |                                      |
 382 +--------------------------------------+--------------------------------------+
 383 | **Release designation**              | 6.0.0 frankfurt                      |
 384 |                                      |                                      |
 385 +--------------------------------------+--------------------------------------+
 386 | **Release date**                     | 2020-05-07 (TBD)                     |
 387 |                                      |                                      |
 388 +--------------------------------------+--------------------------------------+
 389
 390
 391 New features
 392 ------------
 393
 394 - Project is restructured into apps and libs.
 395 - A Generic optimizing engine is implemented.
 396 - New optimizer model for route optimization is added.
 397 - Policy apis are migrated from legacy apis to new decision api.
 398 - The Conductor adapter is moved from placement to adapters.
 399 - NST and NSI selection function has been implemented for Network
 400   Slicing use case.
 401 - PCI optimization is enhanced to support fixed cells field.
 402
 403 Bug Fixes
 404 ---------
 405
 406 - OPTFRA-482 The field "unique" should be defined in vnf policy.
 407 - OPTFRA-729 OSDF fails to start in the k8s environment.
 408 - OPTFRA-731 OSDF Policy interface is not working
 409 - OPTFRA-754 Return slice profile when service profile indicates the
 410   resource sharing level as not shared
 411 - OPTFRA-755 OOF Policy filtering does not work.
 412
 413 Known Limitations, Issues and Workarounds
 414 =========================================
 415
 416 System Limitations
 417 ------------------
 418
 419
 420 Known Vulnerabilities
 421 ---------------------
 422
 423
 424 Workarounds
 425 -----------
 426
 427
 428 Security Notes
 429 --------------
 430
 431
 432 References
 433 ==========
 434
 435 For more information on the ONAP Frankfurt release, please see:
 436
 437 #. `ONAP Home Page`_
 438 #. `ONAP Documentation`_
 439 #. `ONAP Release Downloads`_
 440 #. `ONAP Wiki Page`_
 441
 442
 443 .. _`ONAP Home Page`: https://www.onap.org
 444 .. _`ONAP Wiki Page`: https://wiki.onap.org
 445 .. _`ONAP Documentation`: https://docs.onap.org
 446 .. _`ONAP Release Downloads`: https://git.onap.org
 447
 448 Quick Links:
 449     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 450     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 451
 452
 453 Version: 5.0.1
 454 --------------
 455
 456 :Release Date: 2019-09-30 (El Alto Release)
 457
 458 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
 459
 460 Artifacts released:
 461
 462 optf-has:1.3.3
 463 optf-osdf:1.3.4
 464 optf-cmso:2.1.1
 465
 466 **New Features**
 467
 468 While no new features were added in the release, the following Stories were delivered as enhancements.
 469
 470     * [OPTFRA-415] Automation on policy model uploading
 471     * [OPTFRA-427] CMSO - Schedule a workflow in SO and track status to completion
 472
 473 * Platform Maturity Level 1
 474     * ~65.1+ unit test coverage
 475
 476
 477 **Bug Fixes**
 478
 479 The El Alto release for OOF fixed the following Bugs.
 480
 481     * [OPTFRA-579] Json error in homing solution
 482     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
 483     * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
 484     * [OPTFRA-577] Need for "ReadWriteMany" access on storage when deploying on Kubernetes?
 485     * [OPTFRA-517] Clean up optf/cmso in integration/csit for Dublin
 486     * [OPTFRA-486] Support "identifiers" field as a list of values
 487     * [OPTFRA-403] OOF CMSO Service kubernetes resources allocation is not done
 488     * [OPTFRA-526] OOF pods not running
 489     * [OPTFRA-409] Template example : purpose to be explained
 490     * [OPTFRA-593] OOF-CSMO healthcheck is failing in Master
 491
 492
 493 **Known Issues**
 494
 495     * [OPTFRA-576] optf-has-master-csit-has is testing Dublin image
 496     * [OPTFRA-596] CMSO - Sonar and CSIT jobs failing
 497     * [OPTFRA-608] Error in Homing with multiple policies
 498
 499 **Security Notes**
 500
 501 *Fixed Security Issues*
 502
 503     * [OJSI-122] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
 504     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
 505     * [OPTFRA-522] oof-osdf exposes plain text HTTP endpoint using port 30248
 506     * [OPTFRA-455] CMSO - Mitigate License Threat tomcat-embed-core
 507
 508 *Known Security Issues*
 509
 510     * [OPTFRA-481] Fix Vulnerability with spring-data-jpa package
 511     * [OPTFRA-431] Fix Vulnerability with spring-security-web package
 512
 513 *Known Vulnerabilities in Used Modules*
 514
 515 **Upgrade Notes**
 516
 517
 518 **Deprecation Notes**
 519
 520
 521 **Other**
 522
 523
 524 Version: 4.0.0
 525 --------------
 526
 527 :Release Date: 2019-06-06 (Dublin Release)
 528
 529 **New Features**
 530
 531 The Dublin release is the third release for ONAP Optimization Framework (OOF).
 532
 533 A summary of features includes
 534
 535 * Support SON (PCI/ANR) optimization using OSDF
 536 * Implement encryption for OSDF internal and external communication
 537
 538 * Platform Maturity Level 1
 539     * ~65.1+ unit test coverage
 540
 541 The Dublin release for OOF delivered the following Epics.
 542
 543     * [OPTFRA-426]      Track the changes to CMSO to support change management schedule optimization
 544     * [OPTFRA-424]      Extend OOF to support traffic distribution optimization
 545     * [OPTFRA-422]      Move OOF projects' CSIT to run on OOM
 546     * [OPTFRA-276]      Implementing a POC for 5G SON Optimization
 547     * [OPTFRA-270]      This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 548
 549
 550 **Bug Fixes**
 551
 552 * The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10463>`_
 553
 554 **Known Issues**
 555
 556
 557
 558 **Security Notes**
 559
 560 *Fixed Security Issues*
 561
 562 *Known Security Issues*
 563
 564     * [`OJSI-122 <https://jira.onap.org/browse/OJSI-122>`_] In default deployment OPTFRA (oof-osdf) exposes HTTP port 30248 outside of cluster.
 565
 566 *Known Vulnerabilities in Used Modules*
 567
 568 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 569 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.
 570
 571 Quick Links:
 572     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 573     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 574     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
 575
 576 **Upgrade Notes**
 577
 578 None.
 579
 580 **Deprecation Notes**
 581
 582 None.
 583
 584 **Other**
 585
 586 None
 587
 588 Version: 3.0.1
 589 --------------
 590
 591 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
 592
 593 The following items were deployed with the Casablanca Maintenance Release:
 594
 595
 596 **New Features**
 597
 598 None.
 599
 600 **Bug Fixes**
 601
 602 * [OPTFRA-401] -        Need flavor id while launching vm.
 603
 604
 605
 606 Version: 3.0.0
 607 --------------
 608
 609 :Release Date: 2018-11-30 (Casablanca Release)
 610
 611 **New Features**
 612
 613 The Casablanca release is the second release for ONAP Optimization Framework (OOF).
 614
 615 A summary of features includes
 616
 617 * Homing enhancements for improving service deployability
 618     * Discovering and reusing shared resources when processing multiple homing requests in parallel
 619     * Considering Latency Reduction (in addition to geographical distances) for homing optimization
 620     * Enhanced capacity checks during VNF homing
 621     * Asynchronous communication between HAS components
 622 * OOF Casablanca S3P Usability enhancement
 623     * Adherence to ONAP API Common Versioning Strategy (CVS) Proposal
 624     * Move all internal and external facing APIs to Swagger 2.0
 625 * OOF Casablanca S3P Performance enhancements
 626     * Creating a plan for performance improvements based on the baseline measured metrics
 627 * OOF development platform hardening
 628     * Deployment scripts
 629     * Fix Build Docker image script for supporting multiple versions
 630     * Fix OOM, HEAT deployment scripts (versioning)
 631     * CSIT functional tests for each repo
 632     * CI Jobs for different streams (Beijing, master etc)
 633     * Clean up nexus binaries and maven versioning
 634 * Integrate OOF with Certificate and Secret Management Service (CSM)
 635 * Support SON (PCI) optimization using OSDF
 636
 637 * Platform Maturity Level 1
 638     * ~65.1+ unit test coverage
 639
 640 The Casablanca release for OOF delivered the following Epics.
 641
 642     * [OPTFRA-273] - Epic Name: OOF Casablanca S3P Manageability enhancement
 643     * [OPTFRA-270] - Maintain current S3P levels
 644     * [OPTFRA-271] - OOF Casablanca S3P Security enhancement
 645     * [OPTFRA-267] - OOF - HPA Enhancements
 646     * [OPTFRA-276] - Implementing a POC for 5G SON Optimization
 647
 648
 649 **Bug Fixes**
 650
 651 * The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/OPTFRA/versions/10445>`_
 652
 653 **Known Issues**
 654
 655   * [OPTFRA-223] -      On boarding and testing AAF certificates for OSDF.
 656   * [OPTFRA-293] -      Implement encryption for all OSDF internal and external communication
 657   * [OPTFRA-329] -      role based access control for OSDF-Policy interface
 658
 659 **Security Notes**
 660
 661 OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 662 The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_.
 663
 664 Quick Links:
 665     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 666     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 667     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_
 668
 669 **Upgrade Notes**
 670
 671 None.
 672
 673 **Deprecation Notes**
 674
 675 None.
 676
 677 **Other**
 678
 679 None
 680
 681 Version: 2.0.0
 682 --------------
 683
 684 :Release Date: 2018-06-07
 685
 686 **New Features**
 687
 688
 689 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features includes:
 690
 691 * Baseline HAS functionality
 692     * support for VCPE use case
 693     * support for HPA (Hardware Platform Awareness)
 694 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
 695 * Platform Maturity Level 1
 696     * ~50%+ unit test coverage
 697
 698 The Beijing release for OOF delivered the following Epics.
 699
 700     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
 701     * [OPTFRA-6] - Integrate OOF with other ONAP components
 702     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
 703     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
 704     * [OPTFRA-21] - OOF Packaging
 705     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
 706     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
 707     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
 708     * [OPTFRA-33] - OOF Support for HPA
 709     * [OPTFRA-105] - All Documentation Related User Stories and Tasks
 710
 711
 712 **Bug Fixes**
 713
 714 None. Initial release R2 Beijing. No previous versions
 715
 716 **Known Issues**
 717
 718 None.
 719
 720 **Security Notes**
 721
 722 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 723
 724 Quick Links:
 725     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 726     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 727
 728 **Upgrade Notes**
 729
 730 None. Initial release R2 Beijing. No previous versions
 731
 732 **Deprecation Notes**
 733
 734 None. Initial release R2 Beijing. No previous versions
 735
 736 **Other**
 737
 738 None