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