docs/sections/release-notes.rst

   1 ..
   2  This work is licensed under a Creative Commons Attribution 4.0
   3  International License.
   4
   5 =============
   6 Release Notes
   7 =============
   8
   9 ..      ===========================
  10 ..      * * *    HONOLULU    * * *
  11 ..      ===========================
  12
  13 Abstract
  14 ========
  15
  16 This document provides the release notes for the Honolulu release.
  17
  18 Summary
  19 =======
  20
  21
  22 Release Data
  23 ============
  24
  25
  26 +--------------------------------------+--------------------------------------+
  27 | **OOF Project**                      |                                      |
  28 |                                      |                                      |
  29 +--------------------------------------+--------------------------------------+
  30 | **Docker images**                    | - optf-has 2.1.4                     |
  31 |                                      |                                      |
  32 +--------------------------------------+--------------------------------------+
  33 | **Release designation**              | 8.0.0 honolulu                       |
  34 |                                      |                                      |
  35 +--------------------------------------+--------------------------------------+
  36 | **Release date**                     | 04/08/2021 (TBD)                     |
  37 |                                      |                                      |
  38 +--------------------------------------+--------------------------------------+
  39
  40
  41 New features
  42 ------------
  43
  44 - Support for NST selection feature with AAI and SDC interface
  45 - Enhancement in Slice profile generation - Deriving TA list from coverage Area
  46
  47 Bug Fixes
  48 =========
  49
  50 - OPTFRA-907 Fix AAI plugin to fetch service/slice profile associated with NSI/NSSI
  51 - OPTFRA-924 Replace pycryptodome with pycrytodomex, since it is not well maintained
  52
  53 Known Limitations, Issues and Workarounds
  54 =========================================
  55
  56 System Limitations
  57 ------------------
  58
  59
  60 Known Vulnerabilities
  61 ---------------------
  62
  63
  64 Workarounds
  65 -----------
  66
  67
  68 Security Notes
  69 --------------
  70
  71
  72 References
  73 ==========
  74
  75 For more information on the ONAP Honolulu release, please see:
  76
  77 #. `ONAP Home Page`_
  78 #. `ONAP Documentation`_
  79 #. `ONAP Release Downloads`_
  80 #. `ONAP Wiki Page`_
  81
  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     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
  90     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
  91
  92
  93 ..      ===========================
  94 ..      * * *    GUILIN    * * *
  95 ..      ===========================
  96
  97 Abstract
  98 ========
  99
 100 This document provides the release notes for the Guilin release.
 101
 102 Summary
 103 =======
 104
 105
 106 Release Data
 107 ============
 108
 109
 110 +--------------------------------------+--------------------------------------+
 111 | **OOF Project**                      |                                      |
 112 |                                      |                                      |
 113 +--------------------------------------+--------------------------------------+
 114 | **Docker images**                    | - optf-has 2.1.2                     |
 115 |                                      |                                      |
 116 +--------------------------------------+--------------------------------------+
 117 | **Release designation**              | 7.0.0 guilin                         |
 118 |                                      |                                      |
 119 +--------------------------------------+--------------------------------------+
 120 | **Release date**                     | 2020-11-19 (TBD)                     |
 121 |                                      |                                      |
 122 +--------------------------------------+--------------------------------------+
 123
 124
 125 New features
 126 ------------
 127
 128 - Support for Generic objective functions
 129 - Candidate schema refactoring
 130 - New candidate types - NSI, Slice profiles
 131 - Functionality added in AAI plugin to support NSI candidates
 132
 133 Bug Fixes
 134 =========
 135
 136 - OPTFRA-854 HAS to support multiple inventory provider for a demand
 137 - OPTFRA-839 Remove python 2.7 from HAS docker image
 138
 139 Known Limitations, Issues and Workarounds
 140 =========================================
 141
 142 System Limitations
 143 ------------------
 144
 145
 146 Known Vulnerabilities
 147 ---------------------
 148
 149
 150 Workarounds
 151 -----------
 152
 153
 154 Security Notes
 155 --------------
 156
 157
 158 References
 159 ==========
 160
 161 For more information on the ONAP Guilin release, please see:
 162
 163 #. `ONAP Home Page`_
 164 #. `ONAP Documentation`_
 165 #. `ONAP Release Downloads`_
 166 #. `ONAP Wiki Page`_
 167
 168
 169 .. _`ONAP Home Page`: https://www.onap.org
 170 .. _`ONAP Wiki Page`: https://wiki.onap.org
 171 .. _`ONAP Documentation`: https://docs.onap.org
 172 .. _`ONAP Release Downloads`: https://git.onap.org
 173
 174 Quick Links:
 175     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 176     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 177
 178
 179 ..      ===========================
 180 ..      * * *    FRANKFURT    * * *
 181 ..      ===========================
 182
 183 Abstract
 184 ========
 185
 186 This document provides the release notes for the Frankfurt release.
 187
 188 Summary
 189 =======
 190
 191
 192 Release Data
 193 ============
 194
 195
 196 +--------------------------------------+--------------------------------------+
 197 | **OOF Project**                      |                                      |
 198 |                                      |                                      |
 199 +--------------------------------------+--------------------------------------+
 200 | **Docker images**                    | - optf-has 2.0.4                     |
 201 |                                      |                                      |
 202 +--------------------------------------+--------------------------------------+
 203 | **Release designation**              | 6.0.0 frankfurt                      |
 204 |                                      |                                      |
 205 +--------------------------------------+--------------------------------------+
 206 | **Release date**                     | 2020-05-07 (TBD)                     |
 207 |                                      |                                      |
 208 +--------------------------------------+--------------------------------------+
 209
 210
 211 New features
 212 ------------
 213
 214 - Passthrough attributes has been added to placement request.
 215 - HAS container to run as non-root user.
 216 - HAS Component has be upgraded to Python 3.8.
 217 - New inventory type NSSI is added.
 218 - Functionality has been added to AAI plugin to get the nssi candidates
 219   from AAI.
 220 - New constraint named ``threshold`` has been added to the solver.
 221
 222 Bug Fixes
 223 =========
 224
 225 - OPTFRA-734 Nginx failing to start as non-root user.
 226 - OPTFRA-733 AAF authentication fails while handling API requests.
 227 - OPTFRA-746 Add NSI id to NSSI candidate.
 228 - OPTFRA-747 Music api not using server url in https mode.
 229 - OPTFRA-728 HPA CSIT test failures.
 230 - OPTFRA-726 Nginx needs to run as root.
 231 - OPTFRA-630 Sonar failing jobs.
 232
 233 Known Limitations, Issues and Workarounds
 234 =========================================
 235
 236 System Limitations
 237 ------------------
 238
 239
 240 Known Vulnerabilities
 241 ---------------------
 242
 243
 244 Workarounds
 245 -----------
 246
 247
 248 Security Notes
 249 --------------
 250
 251 **Fixed Security issues**
 252
 253 All HAS containers were running as root user which is fixed in this
 254 release under OPTFRA-711.
 255
 256 References
 257 ==========
 258
 259 For more information on the ONAP Frankfurt release, please see:
 260
 261 #. `ONAP Home Page`_
 262 #. `ONAP Documentation`_
 263 #. `ONAP Release Downloads`_
 264 #. `ONAP Wiki Page`_
 265
 266
 267 .. _`ONAP Home Page`: https://www.onap.org
 268 .. _`ONAP Wiki Page`: https://wiki.onap.org
 269 .. _`ONAP Documentation`: https://docs.onap.org
 270 .. _`ONAP Release Downloads`: https://git.onap.org
 271
 272 Quick Links:
 273     - `OOF project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 274     - `Passing Badge information for OOF <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 275
 276 Version: 5.0.1
 277 --------------
 278
 279 :Release Date: 2019-09-30 (El Alto Release)
 280
 281 The El Alto release is the fourth release for ONAP Optimization Framework (OOF).
 282
 283 Artifacts released:
 284
 285 optf-has:1.3.3
 286
 287 **New Features**
 288
 289 No new features were added in the release. However, the HAS-Music interface was enhanced from HAS to enable HTTPS based communication.
 290 Since MUSIC wasnt ready to expose HTTPS in El Alto, using HTTPS was made into an optional flag through config.
 291
 292     * [OPTFRA-330] security: HTTPS support for HAS-MUSIC interface
 293
 294 * Platform Maturity Level 1
 295     * ~56.2%+ unit test coverage
 296
 297
 298 **Bug Fixes**
 299
 300 The El Alto release for OOF fixed the following Bugs.
 301
 302     * [OPTFRA-579] Json error in homing solution
 303     * [OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275
 304     * [OPTFRA-409] Template example : purpose to be explained
 305
 306
 307 **Known Issues**
 308
 309 **Security Notes**
 310
 311 *Fixed Security Issues*
 312
 313     * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
 314       This issue has been also described in "[OPTFRA-521] oof-has-api exposes plain text HTTP endpoint using port 30275"
 315
 316 *Known Security Issues*
 317
 318 *Known Vulnerabilities in Used Modules*
 319
 320 **Upgrade Notes**
 321
 322
 323 **Deprecation Notes**
 324
 325
 326 **Other**
 327
 328
 329 Version: 4.0.0
 330 --------------
 331
 332 :Release Date: 2019-06-06 (Dublin Release)
 333
 334 **New Features**
 335
 336 A summary of features includes:
 337
 338 * Extend OOF to support traffic distribution optimization
 339 * Implement encryption for HAS internal and external communication
 340
 341 * Platform Maturity Level 1
 342     * ~56.2%+ unit test coverage
 343
 344 The Dublin release for OOF delivered the following Epics.
 345
 346     * [OPTFRA-424]      Extend OOF to support traffic distribution optimization
 347     * [OPTFRA-422]      Move OOF projects' CSIT to run on OOM
 348     * [OPTFRA-270]      This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 349
 350 **Bug Fixes**
 351     * OPTFRA-515        Pod oof-has-controller is in CrashLoopBackOff after ONAP deployment
 352     * OPTFRA-513        OOF-HAS pods fail to come up in ONAP deployment
 353     * OPTFRA-492        HAS API pod failure
 354     * OPTFRA-487        OOF HAS CSIT failing with HTTPS changes
 355     * OPTFRA-475        Remove Casablanca jobs in preparation for Dublin branch
 356     * OPTFRA-467        Remove aai simulator code from HAS solver
 357     * OPTFRA-465        Fix data code smells
 358     * OPTFRA-461        Enable HTTPS and TLS for HAS API
 359     * OPTFRA-452        Remove misleading reservation logic
 360     * OPTFRA-449        Create OOM based CSIT for HAS
 361     * OPTFRA-448        Multiple Sonar Issues
 362     * OPTFRA-445        Modify HAS Data component to support new A&AI requests required by Distribute Traffic functionality
 363     * OPTFRA-444        Implement Distribute Traffic API exposure in HAS
 364     * OPTFRA-412        Got 'NoneType' error when there's no flavor info inside vim
 365     * OPTFRA-411        latency_country_rules_loader.py - Remove the unused local variable "ctx".
 366     * OPTFRA-302        Enhance coverage of existing HAS code to 55%
 367
 368
 369 **Known Issues**
 370
 371 These are all issues with fix version: Dublin Release and status: open, in-progress, reopened
 372
 373     * OPTFRA-494        HAS request 'limit' argument is ignored.
 374
 375 **Security Issues**
 376
 377 *Fixed Security Issues*
 378
 379 *Known Security Issues*
 380
 381     * [`OJSI-137 <https://jira.onap.org/browse/OJSI-137>`_] In default deployment OPTFRA (oof-has-api) exposes HTTP port 30275 outside of cluster.
 382
 383 *Known Vulnerabilities in Used Modules*
 384
 385 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_.
 386
 387 **Quick Links**:
 388     - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 389     - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 390     - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_
 391 **Upgrade Notes**
 392 To upgrade, run docker container or install from source, See Distribution page
 393
 394 **Deprecation Notes**
 395 No features deprecated in this release
 396
 397 **Other**
 398 None
 399
 400
 401 Version: 3.0.1
 402 --------------
 403
 404 :Release Date: 2019-01-31 (Casablanca Maintenance Release)
 405
 406 The following items were deployed with the Casablanca Maintenance Release:
 407
 408
 409 **New Features**
 410
 411 None.
 412
 413 **Bug Fixes**
 414
 415 * [OPTFRA-401] -        Need flavor id while launching vm.
 416
 417
 418
 419 Version: 3.0.0
 420 --------------
 421
 422 :Release Date: 2018-11-30 (R3 Casablanca Release)
 423
 424 **New Features**
 425
 426 A summary of features includes:
 427
 428 * Security enhancements, including integration with AAF to implement access controls on
 429     OSDF and HAS northbound interfaces
 430 * Integration with SMS
 431 * Platform Maturity Level 1
 432     * ~50%+ unit test coverage
 433 * Hardware Platform Awareness Enhancements
 434     1) Added support for SRIOV-NIC and directives to assist the orchestrator
 435     2) Select the best candidate across all cloud region based on HPA score.
 436     3) HPA metrics using prometheus
 437
 438 The Casablanca release for OOF delivered the following Epics.
 439
 440     * OPTFRA-106 - OOF Functional Testing Related User Stories and Tasks
 441     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
 442     * OPTFRA-267 - OOF - HPA Enhancements
 443     * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
 444     * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 445     * OPTFRA-271 - This epic spans the work to progress further from the current security level
 446     * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
 447     * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
 448     * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
 449     * OPTFRA-275 - This epic spans the stories to improve deployability of services
 450     * OPTFRA-276 - Implementing a POC for 5G SON Optimization
 451     * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
 452
 453 **Bug Fixes**
 454
 455     * OPTFRA-205 - Generated conductor.conf missing configurations
 456     * OPTFRA-210 - Onboarding to Music error
 457     * OPTFRA-211 - Error solution for HPA
 458     * OPTFRA-249 - OOF does not return serviceResourceId in homing solution
 459     * OPTFRA-259 - Fix intermittent failure of HAS CSIT job
 460     * OPTFRA-264 - oof-has-zookeeper image pull error
 461     * OPTFRA-305 - Analyze OOM health check failure
 462     * OPTFRA-306 - OOF-Homing fails health check in HEAT deployment
 463     * OPTFRA-321 - Fix osdf functional tests script to fix builder failures
 464     * OPTFRA-323 - Cannot resolve multiple policies with the same 'hpa-feature' name
 465     * OPTFRA-325 - spelling mistake
 466     * OPTFRA-326 - hyperlink links are missing
 467     * OPTFRA-335 - Making flavors an optional field in HAS candidate object
 468     * OPTFRA-336 - OOM oof deployment failure on missing image - optf-osdf:1.2.0
 469     * OPTFRA-338 - Create authentication key for OOF-VFC integration
 470     * OPTFRA-341 - Cannot support multiple candidates for one feature in one flavor
 471     * OPTFRA-344 - Fix broken HPA CSIT test
 472     * OPTFRA-354 - Generalize the logic to process Optimization policy
 473     * OPTFRA-358 - Tox fails with the AttributeError: 'module' object has no attribute 'MUSIC_API'
 474     * OPTFRA-359 - Create index on plans table for HAS
 475     * OPTFRA-362 - AAF Authentication CSIT issues
 476     * OPTFRA-365 - Fix Jenkins jobs for CMSO
 477     * OPTFRA-366 - HAS CSIT issues
 478     * OPTFRA-370 - Update the version of the OSDF and HAS images
 479     * OPTFRA-374 - 'ModelCustomizationName' should be optional for the request
 480     * OPTFRA-375 - SO-OSDF request is failing without modelCustomizationName value
 481     * OPTFRA-384 - Generate and Validate Policy for vFW testing
 482     * OPTFRA-385 - resourceModelName is sent in place of resourceModuleName
 483     * OPTFRA-388 - Fix OOF to handle sdnr/configdb api changes
 484     * OPTFRA-395 - CMSO - Fix security violations and increment version
 485
 486
 487 **Known Issues**
 488
 489 These are all issues with fix version: Casablanca Release and status: open, in-progress, reopened
 490
 491     * OPTFRA-401 - Need flavor id while launching vm
 492     * OPTFRA-398 - Add documentation for OOF-VFC interaction
 493     * OPTFRA-393 - CMSO Implement code coverage
 494     * OPTFRA-383 - OOF 7 of 8 pods are not starting in a clean master 20181029
 495     * OPTFRA-368 - Remove Beijing repositories from CLM jenkins
 496     * OPTFRA-337 - Document new transitions in HAS states
 497     * OPTFRA-331 - Role-based access controls to OOF
 498     * OPTFRA-329 - role based access control for OSDF-Policy interface
 499     * OPTFRA-316 - Clean up hard-coded references to south bound dependencies
 500     * OPTFRA-314 - Create user stories for documenting new APIs defined for OOF
 501     * OPTFRA-304 - Code cleaning
 502     * OPTFRA-300 - Fix Heat deployment scripts for OOF
 503     * OPTFRA-298 - Should be able to orchestrate Cross Domain and Cross Layer VPN
 504     * OPTFRA-297 - OOF Should support Cross Domain and Cross Layer VPN
 505     * OPTFRA-296 - Support SON (PCI) optimization using OSDF
 506     * OPTFRA-293 - Implement encryption for all OSDF internal and external communication
 507     * OPTFRA-292 - Implement encryption for all HAS internal and external communication
 508     * OPTFRA-279 - Policy-based capacity check enhancements
 509     * OPTFRA-276 - Implementing a POC for 5G SON Optimization
 510     * OPTFRA-274 - This epic spans the work to progress further from the current Usability level
 511     * OPTFRA-273 - This epic spans the work to progress further from the current Manageability level
 512     * OPTFRA-272 - This epic spans the work to progress further from the current Performance level
 513     * OPTFRA-271 - This epic spans the work to progress further from the current security level
 514     * OPTFRA-270 - This epic captures stories related to maintaining current S3P levels of the project as new functional requirements are supported
 515     * OPTFRA-269 - This epic covers the work to get the OOF development platform ready for Casablanca development
 516     * OPTFRA-268 - OOF - project specific enhancements
 517     * OPTFRA-266 - Integrate OOF with Certificate and Secret Management Service (CSM)
 518     * OPTFRA-262 - ReadTheDoc - update for R3
 519     * OPTFRA-260 - Testing vCPE flows with multiple clouds
 520     * OPTFRA-240 - Driving Superior Isolation for Tiered Services using Resource Reservation -- Optimization Policies for Residential vCPE
 521     * OPTFRA-223 - On boarding and testing AAF certificates for OSDF
 522
 523 **Security Issues**
 524
 525 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 526
 527 **Quick Links**:
 528         - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 529
 530         - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 531
 532 **Upgrade Notes**
 533 To upgrade, run docker container or install from source, See Distribution page
 534
 535 **Deprecation Notes**
 536 No features deprecated in this release
 537
 538 **Other**
 539 None
 540
 541 Version: 2.0.0
 542 --------------
 543
 544 :Release Date: 2018-06-07 (Beijing Release)
 545
 546 **New Features**
 547
 548 The ONAP Optimization Framework (OOF) is new in Beijing. A summary of features incldues:
 549
 550 * Baseline HAS functionality
 551     * support for VCPE use case
 552     * support for HPA (Hardware Platform Awareness)
 553 * Integration with OOF OSDF, SO, Policy, AAI, and Multi-Cloud
 554 * Platform Maturity Level 1
 555     * ~50%+ unit test coverage
 556
 557 The Beijing release for OOF delivered the following Epics.
 558
 559     * [OPTFRA-2] - On-boarding and Stabilization of the OOF seed code
 560
 561     * [OPTFRA-6] - Integrate OOF with other ONAP components
 562
 563     * [OPTFRA-7] - Integration with R2 Use Cases [HPA, Change Management, Scaling]
 564
 565     * [OPTFRA-20] - OOF Adapters for Retrieving and Resolving Policies
 566
 567     * [OPTFRA-21] - OOF Packaging
 568
 569     * [OPTFRA-28] - OOF Adapters for Beijing Release (Policy, SDC, A&AI, Multi Cloud, etc.)
 570
 571     * [OPTFRA-29] - Policies and Specifications for Initial Applications [Change Management, HPA]
 572
 573     * [OPTFRA-32] - Platform Maturity Requirements for Beijing release
 574
 575     * [OPTFRA-33] - OOF Support for HPA
 576
 577     * [OPTFRA-105] - All Documentation Related User Stories and Tasks
 578
 579
 580 **Bug Fixes**
 581
 582 None. Initial release R2 Beijing. No previous versions
 583
 584 **Known Issues**
 585
 586     * [OPTFRA-179] - Error solution for HPA
 587
 588     * [OPTFRA-205] - Onboarding to Music error
 589
 590     * [OPTFRA-210] - Generated conductor.conf missing configurations
 591
 592     * [OPTFRA-211] - Remove Extraneous Flavor Information from cloud-region cache
 593
 594
 595 **Security Issues**
 596
 597 OPTFRA code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found.
 598
 599 Quick Links:
 600         - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_
 601
 602         - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_
 603
 604 **Upgrade Notes**
 605 None. Initial release R2 Beijing. No previous versions
 606
 607 **Deprecation Notes**
 608 None. Initial release R2 Beijing. No previous versions
 609
 610 **Other**
 611 None