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.4
  30 --------------
  31
  32 :Release Date: 2019-1-31
  33
  34
  35 **Bug Fixes**
  36
  37 The Casablanca maintenance release fixed the following bugs:
  38
  39         - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
  40
  41         - `CCSDK-741 <https://jira.onap.org/browse/CCSDK-741>`_ - Removed Work-around required for vCPE use case to correct the error described in CCSDK ticket.
  42
  43
  44 Version: 1.4.3
  45 --------------
  46
  47 :Release Date: 2018-11-30
  48
  49
  50 **New Features**
  51
  52 The Casablanca release added the following functionality:
  53
  54          - Upgraded OpenDaylight (ODL) version to Oxygen
  55
  56          - Upgraded to Karaf 4.1.5
  57
  58          - Migrated DB from mysql to maria db with galeira, tested on k8s clustering platform
  59
  60          - Added an ansible docker container, tested for DistributeTraffic LCM action
  61
  62          - 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):
  63
  64                 - To support in-place software upgrade:
  65
  66                   - DistributeTraffic
  67
  68                 - To support storage management in OpenStack
  69
  70                   - Reboot with hard and soft option
  71
  72          - Additional contributions as part of Casablanca include:
  73
  74                 - Support for Platform Maturity requirements, including:
  75
  76                    - Increased security
  77
  78                           - 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)
  79                           - 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 )
  80
  81                    - Stability
  82
  83                           - 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 )
  84
  85                    - Resiliency
  86
  87                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see https://wiki.onap.org/display/DW/APPC+Resiliency for additional details)
  88
  89
  90 **Bug Fixes**
  91
  92         - `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.
  93
  94         - `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.
  95
  96         - `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.
  97
  98         - `APPC-1111 <https://jira.onap.org/browse/APPC-1111>`_ - TestDmaapConsumerImpl.testFetch method was taking 130+ seconds to run test. Build time is shorter now.
  99
 100         - `APPC-1112 <https://jira.onap.org/browse/APPC-1112>`_ - Several unit tests in TimeTest.java had intermittent failures.
 101
 102         - `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.
 103
 104         - `APPC-1184 <https://jira.onap.org/browse/APPC-1184>`_ - The APPC LCM API documentation was outdated and did not reflect the correct endpoints.
 105
 106         - `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.
 107
 108         - `APPC-1188 <https://jira.onap.org/browse/APPC-1188>`_ - Exception was occurring if force flag was set to false in a request from policy.
 109
 110         - `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.
 111
 112         - `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.
 113
 114         - `APPC-1207 <https://jira.onap.org/browse/APPC-1207>`_ - Logging constants were missing in several features, causing incorrect logging messages.
 115
 116         - `APPC-1218 <https://jira.onap.org/browse/APPC-1218>`_ - Aai connection had certificate errors and path build exceptions.
 117
 118         - `APPC-1224 <https://jira.onap.org/browse/APPC-1224>`_ - SubRequestID was not being relayed back to Policy in DMaaP Response messages.
 119
 120         - `APPC-1226 <https://jira.onap.org/browse/APPC-1226>`_ - Mock code to mimic backend execution for Reboot was causing problems and has been removed.
 121
 122         - `APPC-1227 <https://jira.onap.org/browse/APPC-1227>`_ - APPC was not able to read VNF templates created with CDT.
 123
 124         - `APPC-1230 <https://jira.onap.org/browse/APPC-1230>`_ - APPC was using the GenericRestart DG instead of DGOrchestrator.
 125
 126         - `APPC-1231 <https://jira.onap.org/browse/APPC-1231>`_ - APPC was not updating the TRANSACTIONS table correctly when an operation completed.
 127
 128         - `APPC-1233 <https://jira.onap.org/browse/APPC-1233>`_ - DGOrchestrator was incorrectly being given an output.payload parameter instead of output-payload.
 129
 130         - `APPC-1234 <https://jira.onap.org/browse/APPC-1234>`_ - AppC Open Day Light login was responding 401 unauthorized when AAF was enabled.
 131
 132         - `APPC-1237 <https://jira.onap.org/browse/APPC-1237>`_ - APPC was not properly url-encoding AAF credentials.
 133
 134         - `APPC-1243 <https://jira.onap.org/browse/APPC-1243>`_ - Container was not preserving mysql data after kubectl edit statefulset.
 135
 136         - `APPC-1244 <https://jira.onap.org/browse/APPC-1244>`_ - Ansible Server would never start in oom.
 137
 138 **Known Issues**
 139
 140         - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
 141             - This issue is relevant during the vCPE use case.
 142             - Due to this defect, the VM will perform four start/stop sequences, instead of the normal one.
 143             - After the four start/stop sequences, the VM will be left in the correct state that it should be in.
 144
 145         - Work-around required for vCPE use case to correct the error described in: `CCSDK-741 <https://jira.onap.org/browse/CCSDK-741>`_
 146             - CCSDK aai adapter doesn't recognize generic-vnf attribute in the response, as it is not defined by aai_schema XSD
 147             - To work around this, several steps must be performed as described here:
 148
 149                 1. Add a restapi template file into the appc docker containers
 150                     a. Enter the appc docker container (docker exec... or kubectl exec...)
 151                     b. Create a directory: /opt/onap/appc/templates
 152                     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
 153                 2. Replace the generic restart DG with a new one
 154                     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>`_
 155                     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.
 156                     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)
 157                 3. Load the new DG file
 158                     a. In the appc docker containers, enter the "/opt/appc/svclogic/bin directory
 159                     b. Run install-converted-dgs.sh
 160
 161 Quick Links:
 162
 163         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
 164
 165         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
 166
 167         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=40927352>`_
 168
 169 **Other**
 170
 171 - Limitations, Constraints and other worthy notes:
 172
 173         - OpenStack Restriction:
 174
 175                 - Currently APPC only supports OpenStack.
 176
 177                 - Admin level access for Tenant level operations.
 178
 179                 - OpenStack Hypervisorcheck is turned off by default.
 180
 181                 - OpenStack Hypervisorcheck is turned off by default.
 182
 183         - 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.
 184
 185
 186
 187 Version: 1.3.0
 188 --------------
 189
 190
 191 :Release Date: 2018-06-07
 192
 193
 194 **New Features**
 195
 196 The Beijing release added the following functionality:
 197
 198          - 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):
 199
 200                 - To support in-place software upgrade:
 201
 202                   - QuiesceTraffic
 203                   - ResumeTraffic
 204                   - UpgradeSoftware
 205                   - UpgradePreCheck
 206                   - UpgradePostCheck
 207                   - UpgradeBackup
 208                   - UpgradeBackout
 209
 210                 - To support storage management in OpenStack
 211
 212                   - AttachVolume
 213                   - DetachVolume
 214
 215                 - To support Manual Scale Out use case
 216
 217                   - ConfigScaleOut (more details can be found in teh APPC Epic: `APPC-431 <https://jira.onap.org/browse/APPC-431>`_ )
 218
 219                 - To support general operations
 220
 221                   - ActionStatus
 222
 223
 224          - 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.
 225
 226                 - More details on the APPC CDT can be found in the APPC CDT User Guide in readthedocs.
 227                 - 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
 228
 229          - Additional contributions as part of Beijing include:
 230
 231                 - Support for Platform Maturity requirements, including:
 232
 233                    - Increased security
 234
 235                           - Added security to ODL web-based API access via AAF (see `APPC-404 <https://jira.onap.org/browse/APPC-404>`_ for additional details)
 236                           - Addressed critical alerts reported via Nexus IQ to the extent possible (see `APPC-656 <https://jira.onap.org/browse/APPC-656>`_ )
 237
 238                    - Stability
 239
 240                           - 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 )
 241
 242                    - Resiliency
 243
 244                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see `APPC-414 <https://jira.onap.org/browse/APPC-414>`_ for additional details)
 245
 246                 - Upgraded OpenDaylight (ODL) version to Nitrogen
 247
 248
 249
 250
 251 **Bug Fixes**
 252
 253 The following defects that were documented as known issues in Amsterdam have been fixed in Beijing release:
 254
 255         - `APPC-316 <https://jira.onap.org/browse/APPC-316>`_ - Null payload issue for Stop Application
 256
 257         - `APPC-315 <https://jira.onap.org/browse/APPC-315>`_ - appc-request-handler is giving error java.lang.NoClassDefFoundError
 258
 259         - `APPC-312 <https://jira.onap.org/browse/APPC-312>`_ - APPC request is going to wrong request handler and rejecting request
 260
 261         - `APPC-311 <https://jira.onap.org/browse/APPC-311>`_ - The APPC LCM Provider Healthcheck
 262
 263         - `APPC-309 <https://jira.onap.org/browse/APPC-309>`_ - APPC LCM Provider URL missing in appc.properties.
 264
 265         - `APPC-307 <https://jira.onap.org/browse/APPC-307>`_ - Embed jackson-annotations dependency in appc-dg-common during run-time
 266
 267         - `APPC-276 <https://jira.onap.org/browse/APPC-276>`_ - Some Junit are breaking convention causing excessively long build
 268
 269         - `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.
 270
 271
 272 **Known Issues**
 273
 274 The following issues remain open at the end of Beijing release. Please refer to Jira for further details and workaround, if available.
 275
 276         - `APPC-987 <https://jira.onap.org/browse/APPC-987>`_ - APPC Investigate TRANSACTION Table Aging. See **Other** section for further information
 277
 278         - `APPC-977 <https://jira.onap.org/browse/APPC-977>`_ - Procedures needed for enabling AAF support in OOM. See **Other** section for further information
 279
 280         - `APPC-973 <https://jira.onap.org/browse/APPC-973>`_ - Fix delimiter string for xml-download CDT action
 281
 282         - `APPC-940 <https://jira.onap.org/browse/APPC-940>`_ - APPC CDT Tool is not updating appc_southbound.properties with the URL supplied for REST
 283
 284         - `APPC-929 <https://jira.onap.org/browse/APPC-929>`_ - LCM API - ConfigScaleOut- Payload parameter to be manadatory set to "true"
 285
 286         - `APPC-912 <https://jira.onap.org/browse/APPC-912>`_ - MalformedChunkCodingException in MDSALStoreImpl.getNodeName
 287
 288         - `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
 289
 290         - `APPC-869 <https://jira.onap.org/browse/APPC-869>`_ - VM Snapshot error occurs during image validation.
 291
 292         - `APPC-814 <https://jira.onap.org/browse/APPC-814>`_ - Update openecomp-tosca-datatype namespace
 293
 294         - `APPC-340 <https://jira.onap.org/browse/APPC-340>`_ - APPC rejecting request even for decimal of millisecond timestamp difference
 295
 296         - `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.
 297
 298
 299 **Security Notes**
 300
 301 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>`_.
 302
 303 Additionally, communication over DMaaP currently does not use secure topics in this release. This has dependency on DMaaP to enable.
 304
 305
 306 Quick Links:
 307         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
 308
 309         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
 310
 311         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=25438971>`_
 312
 313 **Other**
 314
 315 - Limitations, Constraints and other worthy notes
 316
 317         - 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>`_):
 318
 319              - Needed APPC configuration files were missing in Beijing OOM , and
 320              - AAF updated their certificates to require 2way certs, which requires APPC updates
 321
 322           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.
 323
 324         - 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.
 325
 326         - 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
 327
 328         - Currently APPC only supports OpenStack
 329
 330         - 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.
 331
 332         - 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.
 333
 334         - APPC needs Admin level access for Tenant level operations.
 335
 336         - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
 337
 338
 339 Version: 1.2.0
 340 --------------
 341
 342 :Release Date: 2017-11-16
 343
 344
 345 **New Features**
 346
 347 The Amsterdam release continued evolving the design driven architecture of and functionality for APPC.
 348 APPC aims to be completely agnostic and make no assumption about the network.
 349
 350 The main goal of the Amsterdam release was to:
 351  - Support the vCPE use case as part of the closed loop action to perform a Restart on the vGMUX
 352  - Demonstrate integration with MultiCloud as a proxy to OpenStack
 353  - Continue supporting the vFW closed loop use case as part of regression from the seed contribution.
 354
 355 Other key features added in this release include:
 356  - Support for Ansible
 357    - 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.
 358  - Support for Chef
 359    - The Chef Extension for APPC allows management of VNFs that support Chef through the following two additions: a Chef Adapter and Chef Directed Graph.
 360  - LifeCycle Management (LCM) APIs via standalone DGs or via the DGOrchestrator architecture to trigger actions on VMs, VNFs, or VNFCs
 361  - OAM APIs to manage the APPC application itself
 362  - Upgrade of OpenDaylight to Carbon version
 363
 364
 365
 366 **Bug Fixes**
 367
 368         - 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>`_.
 369
 370         - 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)
 371
 372 **Known Issues**
 373
 374         - `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``.
 375
 376         - `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.
 377
 378         - `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.
 379
 380         - `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.
 381
 382         - `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.
 383
 384         - `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.
 385
 386         - `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.
 387
 388
 389 **Security Issues**
 390         - Communication over DMaaP currently does not use secure topics in this release.
 391         - AAF is deactivated by default in this release and was not validated or committed as part of the Amsterdam Release.
 392
 393
 394 **Other**
 395
 396 - Limitations, Constraints and other worthy notes
 397
 398   - LCM Healthcheck and Configure actions do not work.
 399   - The APPC actions validated in this release are captured here: https://wiki.onap.org/display/DW/APPC+Testing+Scope+and+Status
 400   - Currently APPC only supports OpenStack
 401   - 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.
 402   - 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.
 403   - APPC needs Admin level access for Tenant level operations.
 404   - Currently, if DGs are modified in appc.git repo, they must be manually moved to the appc/deployment repo.
 405   - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
 406
 407
 408 ===========
 409
 410 End of Release Notes
 411
 412