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