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.3.0
  30 --------------
  31
  32
  33 :Release Date: 2018-06-07
  34
  35
  36 **New Features**
  37
  38 The Beijing release added the following functionality:
  39
  40          - 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):
  41
  42                 - To support in-place software upgrade:
  43
  44                   - QuiesceTraffic
  45                   - ResumeTraffic
  46                   - UpgradeSoftware
  47                   - UpgradePreCheck
  48                   - UpgradePostCheck
  49                   - UpgradeBackup
  50                   - UpgradeBackout
  51
  52                 - To support storage management in OpenStack
  53
  54                   - AttachVolume
  55                   - DetachVolume
  56
  57                 - To support Manual Scale Out use case
  58
  59                   - ConfigScaleOut (more details can be found in teh APPC Epic: `APPC-431 <https://jira.onap.org/browse/APPC-431>`_ )
  60
  61                 - To support general operations
  62
  63                   - ActionStatus
  64
  65
  66          - 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.
  67
  68                 - More details on the APPC CDT can be found in the APPC CDT User Guide in readthedocs.
  69                 - 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
  70
  71          - Additional contributions as part of Beijing include:
  72
  73                 - Support for Platform Maturity requirements, including:
  74
  75                    - Increased security
  76
  77                           - Added security to ODL web-based API access via AAF (see `APPC-404 <https://jira.onap.org/browse/APPC-404>`_ for additional details)
  78                           - Addressed critical alerts reported via Nexus IQ to the extent possible (see `APPC-656 <https://jira.onap.org/browse/APPC-656>`_ )
  79
  80                    - Stability
  81
  82                           - 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 )
  83
  84                    - Resiliency
  85
  86                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see `APPC-414 <https://jira.onap.org/browse/APPC-414>`_ for additional details)
  87
  88                 - Upgraded OpenDaylight (ODL) version to Nitrogen
  89
  90
  91
  92
  93 **Bug Fixes**
  94
  95 The following defects that were documented as known issues in Amsterdam have been fixed in Beijing release:
  96
  97         - `APPC-316 <https://jira.onap.org/browse/APPC-316>`_ - Null payload issue for Stop Application
  98
  99         - `APPC-315 <https://jira.onap.org/browse/APPC-315>`_ - appc-request-handler is giving error java.lang.NoClassDefFoundError
 100
 101         - `APPC-312 <https://jira.onap.org/browse/APPC-312>`_ - APPC request is going to wrong request handler and rejecting request.
 102
 103         - `APPC-311 <https://jira.onap.org/browse/APPC-311>`_ - The APPC LCM Provider Healthcheck
 104
 105         - `APPC-309 <https://jira.onap.org/browse/APPC-309>`_ - APPC LCM Provider URL missing in appc.properties.
 106
 107         - `APPC-307 <https://jira.onap.org/browse/APPC-307>`_ - Embed jackson-annotations dependency in appc-dg-common during run-time
 108
 109         - `APPC-276 <https://jira.onap.org/browse/APPC-276>`_ - Some Junit are breaking convention causing excessively long build
 110
 111         - `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.
 112
 113
 114 **Known Issues**
 115
 116 The following issues remain open at the end of Beijing release. Please refer to Jira for further details and workaround, if available.
 117
 118     - `APPC-940 <https://jira.onap.org/browse/APPC-940>`_ - APPC CDT Tool is not updating appc_southbound.properties with the URL supplied for REST
 119
 120     - `APPC-929 <https://jira.onap.org/browse/APPC-929>`_ - LCM API - ConfigScaleOut- Payload parameter to be manadatory - "true"
 121
 122         - `APPC-912 <https://jira.onap.org/browse/APPC-912>`_ - MalformedChunkCodingException in MDSALStoreImpl.getNodeName
 123
 124         - `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
 125
 126         - `APPC-869 <https://jira.onap.org/browse/APPC-869>`_ - VM Snapshot error occurs during image validation.
 127
 128         - `APPC-814 <https://jira.onap.org/browse/APPC-814>`_ - Update openecomp-tosca-datatype namespace
 129
 130         - `APPC-340 <https://jira.onap.org/browse/APPC-340>`_ - APPC rejecting request even for decimal of millisecond timestamp difference
 131
 132         - `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.
 133
 134
 135 **Security Notes**
 136
 137 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>`_.
 138
 139 Additionally, communication over DMaaP currently does not use secure topics in this release. This has dependency on DMaaP to enable.
 140
 141
 142 Quick Links:
 143         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
 144
 145         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
 146
 147         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=25438971>`_
 148
 149 **Other**
 150
 151 - Limitations, Constraints and other worthy notes
 152
 153           - 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
 154           - Currently APPC only supports OpenStack
 155           - 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.
 156           - 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.
 157           - APPC needs Admin level access for Tenant level operations.
 158           - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
 159
 160
 161
 162 ===========
 163
 164 End of Release Notes