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