docs/release-notes.rst

   1 .. ============LICENSE_START==========================================
   2 .. ===================================================================
   3 .. Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   4 .. ===================================================================
   5 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.  (the "License");
   6 .. you may not use this documentation except in compliance with the License.
   7 .. You may obtain a copy of the License at
   8 ..
   9 ..  https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 .. Unless required by applicable law or agreed to in writing, software
  12 .. distributed under the License is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ============LICENSE_END============================================
  17
  18 Release Notes
  19 =============
  20
  21 .. note
  22 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
  23 ..      * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
  24 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
  25 ..      * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
  26 ..      * This note must be removed after content has been added.
  27
  28
  29 Version: 1.4.3
  30 --------------
  31
  32 :Release Date: 2018-11-30
  33
  34
  35 **New Features**
  36
  37 The Casablanca release added the following functionality:
  38
  39          - Upgraded OpenDaylight (ODL) version to Oxygen
  40
  41          - Upgraded to Karaf 4.1.5
  42
  43          - Migrated DB from mysql to maria db with galeira, tested on k8s clustering platform
  44
  45          - Added an ansible docker container, tested for DistributeTraffic LCM action
  46
  47          - Added support for the following LCM actions (a desciption of all of the above LCM actions can be found in the APPC LCM API Guide on readthedoc):
  48
  49                 - To support in-place software upgrade:
  50
  51                   - DistributeTraffic
  52
  53                 - To support storage management in OpenStack
  54
  55                   - Reboot with hard and soft option
  56
  57          - Additional contributions as part of Casablanca include:
  58
  59                 - Support for Platform Maturity requirements, including:
  60
  61                    - Increased security
  62
  63                           - Enabled bath feature from AAF, CDT GUI and APIDOC can be used when AAF enbled  (see `APPC-1237 <https://jira.onap.org/browse/APPC-1237>`_ for additional details)
  64                           - Addressed critical alerts reported via Nexus IQ to the extent possible (see `APPC-770 <https://jira.onap.org/browse/APPC-770>`_ and wiki: https://wiki.onap.org/pages/viewpage.action?pageId=40927352 )
  65
  66                    - Stability
  67
  68                           - Executed 72 hour stability test on both Heat and OOM deployed environments using JMeter to drive a steady set of transactions over the 72 hour period (see the following wiki page for more details: https://wiki.onap.org/display/DW/APPC+72+Hour+Stability+Testing+Casablanca )
  69
  70                    - Resiliency
  71
  72                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see https://wiki.onap.org/display/DW/APPC+Resiliency for additional details)
  73
  74
  75 **Bug Fixes**
  76
  77         - `APPC-1009 <https://jira.onap.org/browse/APPC-1009>`_ - An incorrect regex in appc-provider-model was causing intermittent unit test failures. This is now fixed.
  78
  79         - `APPC-1021 <https://jira.onap.org/browse/APPC-1021>`_ - An unnecessary pseudoterminal allocation for SSH connection was causing problems when trying to connect to a ConfD NETCONF Server.
  80
  81         - `APPC-1107 <https://jira.onap.org/browse/APPC-1107>`_ - Database problems were causing artifacts created in CDT to not save to APPC. These have been fixed.
  82
  83         - `APPC-1111 <https://jira.onap.org/browse/APPC-1111>`_ - TestDmaapConsumerImpl.testFetch method was taking 130+ seconds to run test. Build time is shorter now.
  84
  85         - `APPC-1112 <https://jira.onap.org/browse/APPC-1112>`_ - Several unit tests in TimeTest.java had intermittent failures.
  86
  87         - `APPC-1157 <https://jira.onap.org/browse/APPC-1157>`_ - Mockito package was removed from the APPC client jar. It was causing conflicts with other applications using APPC client library.
  88
  89         - `APPC-1184 <https://jira.onap.org/browse/APPC-1184>`_ - The APPC LCM API documentation was outdated and did not reflect the correct endpoints.
  90
  91         - `APPC-1186 <https://jira.onap.org/browse/APPC-1186>`_ - VNF-Level OpenStack actions such as Restart were failing if the optional identity-url was omitted from the payload of the request.
  92
  93         - `APPC-1188 <https://jira.onap.org/browse/APPC-1188>`_ - Exception was occurring if force flag was set to false in a request from policy.
  94
  95         - `APPC-1192 <https://jira.onap.org/browse/APPC-1192>`_ - CDT was not updating the DEVICE_INTERFACE_PROTOCOL table, so APPC was unable to get the protocol during lcm actions.
  96
  97         - `APPC-1205 <https://jira.onap.org/browse/APPC-1205>`_ - Artifacts manually entered into CDT were not saving correctly, while artifacts created by uploading a template were.
  98
  99         - `APPC-1207 <https://jira.onap.org/browse/APPC-1207>`_ - Logging constants were missing in several features, causing incorrect logging messages.
 100
 101         - `APPC-1218 <https://jira.onap.org/browse/APPC-1218>`_ - Aai connection had certificate errors and path build exceptions.
 102
 103         - `APPC-1224 <https://jira.onap.org/browse/APPC-1224>`_ - SubRequestID was not being relayed back to Policy in DMaaP Response messages.
 104
 105         - `APPC-1226 <https://jira.onap.org/browse/APPC-1226>`_ - Mock code to mimic backend execution for Reboot was causing problems and has been removed.
 106
 107         - `APPC-1227 <https://jira.onap.org/browse/APPC-1227>`_ - APPC was not able to read VNF templates created with CDT.
 108
 109         - `APPC-1230 <https://jira.onap.org/browse/APPC-1230>`_ - APPC was using the GenericRestart DG instead of DGOrchestrator.
 110
 111         - `APPC-1231 <https://jira.onap.org/browse/APPC-1231>`_ - APPC was not updating the TRANSACTIONS table correctly when an operation completed.
 112
 113         - `APPC-1233 <https://jira.onap.org/browse/APPC-1233>`_ - DGOrchestrator was incorrectly being given an output.payload parameter instead of output-payload.
 114
 115         - `APPC-1234 <https://jira.onap.org/browse/APPC-1234>`_ - AppC Open Day Light login was responding 401 unauthorized when AAF was enabled.
 116
 117         - `APPC-1237 <https://jira.onap.org/browse/APPC-1237>`_ - APPC was not properly url-encoding AAF credentials.
 118
 119         - `APPC-1243 <https://jira.onap.org/browse/APPC-1243>`_ - Container was not preserving mysql data after kubectl edit statefulset.
 120
 121         - `APPC-1244 <https://jira.onap.org/browse/APPC-1244>`_ - Ansible Server would never start in oom.
 122
 123 **Known Issues**
 124
 125         - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
 126             - This issue is relevant during the vCPE use case.
 127             - Due to this defect, the VM will perform four start/stop sequences, instead of the normal one.
 128             - After the four start/stop sequences, the VM will be left in the correct state that it should be in.
 129
 130         - Work-around required for vCPE use case to correct the error described in: `CCSDK-741 <https://jira.onap.org/browse/CCSDK-741>`_
 131             - CCSDK aai adapter doesn't recognize generic-vnf attribute in the response, as it is not defined by aai_schema XSD
 132             - To work around this, several steps must be performed as described here:
 133
 134                 1. Add a restapi template file into the appc docker containers
 135                     a. Enter the appc docker container (docker exec... or kubectl exec...)
 136                     b. Create a directory: /opt/onap/appc/templates
 137                     c. Download this file `aai-named-query.json <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob_plain;f=vcpe-workaround-files/aai-named-query.json;hb=refs/heads/casablanca>`_ and place it in that directory
 138                 2. Replace the generic restart DG with a new one
 139                     a. Download the `APPC_Generic_Restart.xml <https://gerrit.onap.org/r/gitweb?p=appc/deployment.git;a=blob_plain;f=vcpe-workaround-files/APPC_method_Generic_Restart_3.0.0.xml;hb=refs/heads/casablanca>`_
 140                     b. Edit the file. Find the parameter definition lines for restapiUrl, restapiUser, restapiPassword (lines 52-54) and replace these with the correct values for your aai server.
 141                     c. Copy this file into the appc docker containers to the /opt/onap/appc/svclogic/graphs directory (you will be replacing the old version of the file with this copy)
 142                 3. Load the new DG file
 143                     a. In the appc docker containers, enter the "/opt/appc/svclogic/bin directory
 144                     b. Run install-converted-dgs.sh
 145
 146 Quick Links:
 147
 148         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
 149
 150         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
 151
 152         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=40927352>`_
 153
 154 **Other**
 155
 156 - Limitations, Constraints and other worthy notes:
 157
 158         - OpenStack Restriction:
 159
 160                 - Currently APPC only supports OpenStack.
 161
 162                 - Admin level access for Tenant level operations.
 163
 164                 - OpenStack Hypervisorcheck is turned off by default.
 165
 166                 - OpenStack Hypervisorcheck is turned off by default.
 167
 168         - Integration with MultiCloud is supported for Standalone Restart (i.e., not via DGOrchestrator). For any other action, such as Stop, Start, etc.. via MultiCloud requires the MultiCloud identity URL to be either passed in the payload or defined in appc.properties.
 169
 170
 171
 172 Version: 1.3.0
 173 --------------
 174
 175
 176 :Release Date: 2018-06-07
 177
 178
 179 **New Features**
 180
 181 The Beijing release added the following functionality:
 182
 183          - Added support for the following LCM actions (a desciption of all of the above LCM actions can be found in the APPC LCM API Guide on readthedoc):
 184
 185                 - To support in-place software upgrade:
 186
 187                   - QuiesceTraffic
 188                   - ResumeTraffic
 189                   - UpgradeSoftware
 190                   - UpgradePreCheck
 191                   - UpgradePostCheck
 192                   - UpgradeBackup
 193                   - UpgradeBackout
 194
 195                 - To support storage management in OpenStack
 196
 197                   - AttachVolume
 198                   - DetachVolume
 199
 200                 - To support Manual Scale Out use case
 201
 202                   - ConfigScaleOut (more details can be found in teh APPC Epic: `APPC-431 <https://jira.onap.org/browse/APPC-431>`_ )
 203
 204                 - To support general operations
 205
 206                   - ActionStatus
 207
 208
 209          - Contributed the APPC Controller Design Tool (CDT), which enables self-serve capabilities by allowing users to model their VNF/VNFC for consumption by APPC to use in the execution of requests to perform life cycle management activities.
 210
 211                 - More details on the APPC CDT can be found in the APPC CDT User Guide in readthedocs.
 212                 - Additional information on how the APPC CDT tool was used to model the vLB and build teh artifacts needed by APPC to execute teh ConfigScaleOut action can be found at the following wiki pages: https://wiki.onap.org/pages/viewpage.action?pageId=33065185
 213
 214          - Additional contributions as part of Beijing include:
 215
 216                 - Support for Platform Maturity requirements, including:
 217
 218                    - Increased security
 219
 220                           - Added security to ODL web-based API access via AAF (see `APPC-404 <https://jira.onap.org/browse/APPC-404>`_ for additional details)
 221                           - Addressed critical alerts reported via Nexus IQ to the extent possible (see `APPC-656 <https://jira.onap.org/browse/APPC-656>`_ )
 222
 223                    - Stability
 224
 225                           - Executed 72 hour stability test on both Heat and OOM deployed environments using JMeter to drive a steady set of transactions over the 72 hour period (see the following wiki page for more details: https://wiki.onap.org/display/DW/ONAP+APPC+72+Hour+Stability+Test+Results )
 226
 227                    - Resiliency
 228
 229                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see `APPC-414 <https://jira.onap.org/browse/APPC-414>`_ for additional details)
 230
 231                 - Upgraded OpenDaylight (ODL) version to Nitrogen
 232
 233
 234
 235
 236 **Bug Fixes**
 237
 238 The following defects that were documented as known issues in Amsterdam have been fixed in Beijing release:
 239
 240         - `APPC-316 <https://jira.onap.org/browse/APPC-316>`_ - Null payload issue for Stop Application
 241
 242         - `APPC-315 <https://jira.onap.org/browse/APPC-315>`_ - appc-request-handler is giving error java.lang.NoClassDefFoundError
 243
 244         - `APPC-312 <https://jira.onap.org/browse/APPC-312>`_ - APPC request is going to wrong request handler and rejecting request
 245
 246         - `APPC-311 <https://jira.onap.org/browse/APPC-311>`_ - The APPC LCM Provider Healthcheck
 247
 248         - `APPC-309 <https://jira.onap.org/browse/APPC-309>`_ - APPC LCM Provider URL missing in appc.properties.
 249
 250         - `APPC-307 <https://jira.onap.org/browse/APPC-307>`_ - Embed jackson-annotations dependency in appc-dg-common during run-time
 251
 252         - `APPC-276 <https://jira.onap.org/browse/APPC-276>`_ - Some Junit are breaking convention causing excessively long build
 253
 254         - `APPC-248 <https://jira.onap.org/browse/APPC-248>`_ - There is an compatibility issue between PowerMock and Jacoco which causes Sonar coverage not to be captured. Fix is to move to Mockito.
 255
 256
 257 **Known Issues**
 258
 259 The following issues remain open at the end of Beijing release. Please refer to Jira for further details and workaround, if available.
 260
 261         - `APPC-987 <https://jira.onap.org/browse/APPC-987>`_ - APPC Investigate TRANSACTION Table Aging. See **Other** section for further information
 262
 263         - `APPC-977 <https://jira.onap.org/browse/APPC-977>`_ - Procedures needed for enabling AAF support in OOM. See **Other** section for further information
 264
 265         - `APPC-973 <https://jira.onap.org/browse/APPC-973>`_ - Fix delimiter string for xml-download CDT action
 266
 267         - `APPC-940 <https://jira.onap.org/browse/APPC-940>`_ - APPC CDT Tool is not updating appc_southbound.properties with the URL supplied for REST
 268
 269         - `APPC-929 <https://jira.onap.org/browse/APPC-929>`_ - LCM API - ConfigScaleOut- Payload parameter to be manadatory set to "true"
 270
 271         - `APPC-912 <https://jira.onap.org/browse/APPC-912>`_ - MalformedChunkCodingException in MDSALStoreImpl.getNodeName
 272
 273         - `APPC-892 <https://jira.onap.org/browse/APPC-892>`_ - Cntl+4 to highlight and replace feature-Textbox is accepting space  and able to submit without giving any value
 274
 275         - `APPC-869 <https://jira.onap.org/browse/APPC-869>`_ - VM Snapshot error occurs during image validation.
 276
 277         - `APPC-814 <https://jira.onap.org/browse/APPC-814>`_ - Update openecomp-tosca-datatype namespace
 278
 279         - `APPC-340 <https://jira.onap.org/browse/APPC-340>`_ - APPC rejecting request even for decimal of millisecond timestamp difference
 280
 281         - `APPC-154 <https://jira.onap.org/browse/APPC-154>`_ - Logging issue - Request REST API of APPC has RequestID (MDC) in Body or Payload section instead of Header.
 282
 283
 284 **Security Notes**
 285
 286 APPC code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The APPC open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25438971>`_.
 287
 288 Additionally, communication over DMaaP currently does not use secure topics in this release. This has dependency on DMaaP to enable.
 289
 290
 291 Quick Links:
 292         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
 293
 294         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
 295
 296         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=25438971>`_
 297
 298 **Other**
 299
 300 - Limitations, Constraints and other worthy notes
 301
 302         - An issue was discovered with usage of AAF in an OOM deployed environment after the Beijing release was created. The issue was twofold (tracked under `APPC-977 <https://jira.onap.org/browse/APPC-977>`_):
 303
 304              - Needed APPC configuration files were missing in Beijing OOM , and
 305              - AAF updated their certificates to require 2way certs, which requires APPC updates
 306
 307           Additionally, in a Heat deployed environment, a manual workaround will be required to authorize with AAF if they are using 2way certificates.  For instruction on workaround steps needed depending on type of deployment, please refer to the following wiki: https://wiki.onap.org/display/DW/AAF+Integration+with+APPC.
 308
 309         - During the testing of the vCPE/vMUX closed loop scenarios in an OOM deployed environment, an issue was encountered where transactions were not being deleted from the TRANSACTION table and was blocking other Restart request from completing successfully (tracked under `APPC-987 <https://jira.onap.org/browse/APPC-987>`_). A workaround is available and documented in the Jira ticket.
 310
 311         - It is impossible for us to test all aspect of the application. Scope of testing done in Beijing is captured on the following wiki:   https://wiki.onap.org/display/DW/APPC+Beijing+Testing+Scope+and+Status
 312
 313         - Currently APPC only supports OpenStack
 314
 315         - OpenStack Hypervisorcheck is turned off by default. If you want to invoke this functionality via the appc.properties, you need to enable it and ensure you have Admin level access to OpenStack.
 316
 317         - Integration with MultiCloud is supported for Standalone Restart (i.e., not via DGOrchestrator). For any other action, such as Stop, Start, etc.. via MultiCloud requires the MultiCloud identity URL to be either passed in the payload or defined in appc.properties.
 318
 319         - APPC needs Admin level access for Tenant level operations.
 320
 321         - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
 322
 323
 324 Version: 1.2.0
 325 --------------
 326
 327 :Release Date: 2017-11-16
 328
 329
 330 **New Features**
 331
 332 The Amsterdam release continued evolving the design driven architecture of and functionality for APPC.
 333 APPC aims to be completely agnostic and make no assumption about the network.
 334
 335 The main goal of the Amsterdam release was to:
 336  - Support the vCPE use case as part of the closed loop action to perform a Restart on the vGMUX
 337  - Demonstrate integration with MultiCloud as a proxy to OpenStack
 338  - Continue supporting the vFW closed loop use case as part of regression from the seed contribution.
 339
 340 Other key features added in this release include:
 341  - Support for Ansible
 342    - The Ansible Extension for APP-C allows management of VNFs that support Ansible. Ansible is a an open-source VNF management framework that provides an almost cli like set of tools in a structured form. APPC supports Ansible through the following three additions: An Ansible server interface, Ansible Adapter, and Ansible Directed Graph.
 343  - Support for Chef
 344    - The Chef Extension for APPC allows management of VNFs that support Chef through the following two additions: a Chef Adapter and Chef Directed Graph.
 345  - LifeCycle Management (LCM) APIs via standalone DGs or via the DGOrchestrator architecture to trigger actions on VMs, VNFs, or VNFCs
 346  - OAM APIs to manage the APPC application itself
 347  - Upgrade of OpenDaylight to Carbon version
 348
 349
 350
 351 **Bug Fixes**
 352
 353         - This is technically the first release of APPC, previous release was the seed code contribution. As such, the defects fixed in this release were raised during the course of the release. Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to `Jira <https://jira.onap.org/issues/?filter=10570&jql=project%20%3D%20APPC%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Closed%20AND%20fixVersion%20%3D%20%22Amsterdam%20Release%22>`_.
 354
 355         - Please also refer to the notes below. Given the timeframe and resource limitations, not all functions of the release could be validated. Items that were validated are documented on the wiki at the link provide below. If you find issues in the course of your work with APPC, please open a defect in the Application Controller project of Jira (jira.onpa.org)
 356
 357 **Known Issues**
 358
 359         - `APPC-312 <https://jira.onap.org/browse/APPC-312>`_ - APPC request is going to wrong request handler and rejecting request. Configure request failing with following error: ``REJECTED Action Configure is not supported on VM level``.
 360
 361         - `APPC-311 <https://jira.onap.org/browse/APPC-311>`_ - The APPC LCM Provider Healthcheck, which does a healthceck on a VNF, is failing. No known workaround at this time.
 362
 363         - `APPC-309 <https://jira.onap.org/browse/APPC-309>`_ - The property: ``appc.LCM.provider.url=http://127.0.0.1:8181/restconf/operations/appc-provider-lcm`` is missing from appc.properties in the appc deployment.  The property can be manually added as a workaround, then bounce the appc container.
 364
 365         - `APPC-307 <https://jira.onap.org/browse/APPC-307>`_ - Missing jackson-annotations dependency in appc-dg-common - This issue results in Rebuild operation via the APPC Provider not to work. Use instead Rebuild via the APPC LCM Provider using DGOrchestrator.
 366
 367         - `APPC-276 <https://jira.onap.org/browse/APPC-276>`_ - A number of junit testcases need to be reworked because they are causing APPC builds to take much  longer to complete. This issue does not cause the build to fail, just take longer. You can comment out these junit in your local build if this is a problem.
 368
 369         - `APPC-248 <https://jira.onap.org/browse/APPC-248>`_ - There is an compatibility issue between PowerMock and Jacoco which causes Sonar coverage not to be captured. There is no functional impact on APPC.
 370
 371         - `APPC-154 <https://jira.onap.org/browse/APPC-154>`_ - Logging issue - Request REST API of APPC has RequestID (MDC) in Body or Payload section instead of Header.
 372
 373
 374 **Security Issues**
 375         - Communication over DMaaP currently does not use secure topics in this release.
 376         - AAF is deactivated by default in this release and was not validated or committed as part of the Amsterdam Release.
 377
 378
 379 **Other**
 380
 381 - Limitations, Constraints and other worthy notes
 382
 383   - LCM Healthcheck and Configure actions do not work.
 384   - The APPC actions validated in this release are captured here: https://wiki.onap.org/display/DW/APPC+Testing+Scope+and+Status
 385   - Currently APPC only supports OpenStack
 386   - OpenStack Hypervisorcheck is turned off by default. If you want to invoke this functionality via the appc.properties, you need to enable it and ensure you have Admin level access to OpenStack.
 387   - Integration with MultiCloud is supported for Standalone Restart (i.e., not via DGOrchestrator). For any other action, such as Stop, Start, etc.. via MultiCloud requires the MultiCloud identity URL to be either passed in the payload or defined in appc.properties.
 388   - APPC needs Admin level access for Tenant level operations.
 389   - Currently, if DGs are modified in appc.git repo, they must be manually moved to the appc/deployment repo.
 390   - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
 391
 392
 393 ===========
 394
 395 End of Release Notes
 396
 397