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