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