APPC release note update
[appc.git] / docs / release-notes.rst
index aecad10..ff0566c 100644 (file)
@@ -1,6 +1,6 @@
 .. ============LICENSE_START==========================================
 .. ===================================================================
-.. Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
+.. Copyright © 2017-2019 AT&T Intellectual Property. All rights reserved.
 .. ===================================================================
 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.  (the "License");
 .. you may not use this documentation except in compliance with the License.
@@ -26,6 +26,269 @@ Release Notes
 ..     * This note must be removed after content has been added.
 
 
+Version: 1.5.2
+--------------
+
+:Release Date: 2019-6-6
+
+**New Features**
+
+The Dublin release added the following functionality:
+
+        - Upgraded OpenDaylight (ODL) version to Fluorine SR1
+
+        - Migrated CDT docker to node.js base docker image
+
+        - 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):
+        
+        - To support in-place software upgrade:
+               
+               - DistributeTrafficCheck
+
+        - Added Multiple standalone ansible servers support
+
+        - Additional contributions as part of Dublin include:
+        
+               - Test Coverage increased to 83.8%
+
+               - Support for Platform Maturity requirements, including:
+               
+                  - Security
+                  
+                        - Applicaton runs as non-root user in all APPC dockers
+
+                        - Migrated to https for CDT GUI
+                         
+                  - Stability
+                  
+                         - 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+Dublin )
+                         
+                  - Resiliency
+                  
+                         - Support for OOM deployment, which enables resiliency via use of Kubernetes (see https://wiki.onap.org/display/DW/APPC+Resiliency for additional details)
+                         
+
+**Bug Fixes**
+
+      - `APPC-1263 <https://jira.onap.org/browse/APPC-1263>`_ - Two methods of Artifact Transformer in appc-config-params will always return null.
+      - `APPC-1264 <https://jira.onap.org/browse/APPC-1264>`_ - Errors in unit tests in config-generator package.
+      - `APPC-1270 <https://jira.onap.org/browse/APPC-1270>`_ - Unit tests in ccadaptor code not testing correctly.
+      - `APPC-1274 <https://jira.onap.org/browse/APPC-1274>`_ - APPC DG : RestAdapter plugin : lack of documentation.
+      - `APPC-1303 <https://jira.onap.org/browse/APPC-1303>`_ - DependencyModelParser works toward incorrectly spelled property name.
+      - `APPC-1331 <https://jira.onap.org/browse/APPC-1331>`_ - Test cases in appc-common cause intermittent failures.
+      - `APPC-1367 <https://jira.onap.org/browse/APPC-1367>`_ - APPC returns UnknownHostException during Netconf operations.
+      - `APPC-1435 <https://jira.onap.org/browse/APPC-1435>`_ - APPC Ansible Server keeps crashing.
+      - `APPC-1441 <https://jira.onap.org/browse/APPC-1441>`_ - incompatible cherrypy version in ansible server container.
+      - `APPC-1463 <https://jira.onap.org/browse/APPC-1463>`_ - Error in ControllerImpl class.
+      - `APPC-1472 <https://jira.onap.org/browse/APPC-1472>`_ - Not possible to call ansible healthcheck from SO VnfConfigUpdate workflow.
+      - `APPC-1479 <https://jira.onap.org/browse/APPC-1479>`_ - Logic error in ScheduledPublishingPolicyImpl.
+      - `APPC-1480 <https://jira.onap.org/browse/APPC-1480>`_ - MetricRegistryImpl code has problems with casting.
+      - `APPC-1489 <https://jira.onap.org/browse/APPC-1489>`_ - SO VnfConfigUpdate workflow fails with timeout error.
+      - `APPC-1528 <https://jira.onap.org/browse/APPC-1528>`_ - APPC DB table creation failed.
+      - `APPC-1537 <https://jira.onap.org/browse/APPC-1537>`_ - UNIQUE KEY is too long in DEVICE_AUTHENTICATION.
+      - `APPC-1542 <https://jira.onap.org/browse/APPC-1542>`_ - ExecuteNodeActionImpl is not instatiate.
+      - `APPC-1545 <https://jira.onap.org/browse/APPC-1545>`_ - Problem with Ansible handling in EncryptionToolDGWrapper.
+      - `APPC-1548 <https://jira.onap.org/browse/APPC-1548>`_ - "MariaDB 10.2.4 adds ""ROWS"" as an SQL keyword".
+      - `APPC-1574 <https://jira.onap.org/browse/APPC-1574>`_ - FileParameters not supported for Ansible LCM action.
+      - `APPC-1576 <https://jira.onap.org/browse/APPC-1576>`_ - FileParameters content is wrongly processed.
+      - `APPC-1577 <https://jira.onap.org/browse/APPC-1577>`_ - Ansible Server  playbook execution does not work.
+      - `APPC-1583 <https://jira.onap.org/browse/APPC-1583>`_ - ansible user privileges problem.
+      - `APPC-1584 <https://jira.onap.org/browse/APPC-1584>`_ - Incorrect Package name in Audit Directed Graph.
+      - `APPC-1589 <https://jira.onap.org/browse/APPC-1589>`_ - Cvaas directory is not mounted in docker image.
+      - `APPC-1593 <https://jira.onap.org/browse/APPC-1593>`_ - CDT doesn't push info to DB.
+      - `APPC-1600 <https://jira.onap.org/browse/APPC-1600>`_ - "APPC DB doesn't have any artifact for ""artifact-type""=""APPC-CONFIG""".
+      - `APPC-1604 <https://jira.onap.org/browse/APPC-1604>`_ - APPC Not Picking up Mesasges from Dmaap.
+      - `APPC-1610 <https://jira.onap.org/browse/APPC-1610>`_ - Config vFW Netconf URI should be stream-count:stream-count intead of sample-plugin:pg-streams.
+      - `APPC-1611 <https://jira.onap.org/browse/APPC-1611>`_ - VNF_DG_MAPPING and PROCESS_FLOW_REFERENCE tables are empty.
+      - `APPC-1612 <https://jira.onap.org/browse/APPC-1612>`_ - InventoryNames parameter support for APPC Ansible LCM.
+
+**Known Issues**
+
+      - `APPC-1613 <https://jira.onap.org/browse/APPC-1613>`_ - Exception for LCM request with parameter read from A&AI.
+
+Quick Links:
+
+       - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
+       - `Passing Level Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
+
+       - `Silver Level Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579?criteria_level=1>`_
+
+       - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=51282466>`_
+
+**Other**
+
+- Limitations, Constraints and other worthy notes:
+
+       - OpenStack Restriction:
+
+               - Currently APPC only supports OpenStack.
+
+               - Admin level access for Tenant level operations.
+
+               - OpenStack Hypervisorcheck is turned off by default.
+
+
+Version: 1.4.4
+--------------
+
+:Release Date: 2019-1-31
+
+
+**Bug Fixes**
+
+The Casablanca maintenance release fixed the following bugs:
+
+       - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
+
+       - `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.
+Special Note for `APPC-1367 <https://jira.onap.org/browse/APPC-1367>`_ - APPC fails healthcheck with 404 error:
+
+       During testing, we found there is a timing issue. When using OOM to deploy to k8s environment the clustered MariaDB database is not accessible at the time when the APPC pod is trying to insert the DG into MariaDb. This would cause the healthcheck issue. The workaround to solve this issue is redeploying the APPC pod.
+
+Version: 1.4.3
+--------------
+
+:Release Date: 2018-11-30
+
+
+**New Features**
+
+The Casablanca release added the following functionality:
+
+        - Upgraded OpenDaylight (ODL) version to Oxygen 
+
+        - Upgraded to Karaf 4.1.5
+
+        - Migrated DB from mysql to maria db with galeira, tested on k8s clustering platform
+
+        - Added an ansible docker container, tested for DistributeTraffic LCM action
+
+        - 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): 
+        
+               - To support in-place software upgrade:
+               
+                 - DistributeTraffic
+                 
+               - To support storage management in OpenStack
+               
+                 - Reboot with hard and soft option
+                 
+        - Additional contributions as part of Casablanca include: 
+        
+               - Support for Platform Maturity requirements, including:
+               
+                  - Increased security
+                  
+                         - 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)
+                         - 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 )
+                         
+                  - Stability
+                  
+                         - 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 )
+                         
+                  - Resiliency
+                  
+                         - Support for OOM deployment, which enables resiliency via use of Kubernetes (see https://wiki.onap.org/display/DW/APPC+Resiliency for additional details) 
+                         
+
+**Bug Fixes**
+
+       - `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.
+
+       - `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.
+  
+       - `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.
+
+       - `APPC-1111 <https://jira.onap.org/browse/APPC-1111>`_ - TestDmaapConsumerImpl.testFetch method was taking 130+ seconds to run test. Build time is shorter now.
+
+       - `APPC-1112 <https://jira.onap.org/browse/APPC-1112>`_ - Several unit tests in TimeTest.java had intermittent failures.
+
+       - `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.
+
+       - `APPC-1184 <https://jira.onap.org/browse/APPC-1184>`_ - The APPC LCM API documentation was outdated and did not reflect the correct endpoints.
+
+       - `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.
+
+       - `APPC-1188 <https://jira.onap.org/browse/APPC-1188>`_ - Exception was occurring if force flag was set to false in a request from policy.
+
+       - `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.
+
+       - `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.
+
+       - `APPC-1207 <https://jira.onap.org/browse/APPC-1207>`_ - Logging constants were missing in several features, causing incorrect logging messages.
+
+       - `APPC-1218 <https://jira.onap.org/browse/APPC-1218>`_ - Aai connection had certificate errors and path build exceptions.
+
+       - `APPC-1224 <https://jira.onap.org/browse/APPC-1224>`_ - SubRequestID was not being relayed back to Policy in DMaaP Response messages.
+
+       - `APPC-1226 <https://jira.onap.org/browse/APPC-1226>`_ - Mock code to mimic backend execution for Reboot was causing problems and has been removed.
+
+       - `APPC-1227 <https://jira.onap.org/browse/APPC-1227>`_ - APPC was not able to read VNF templates created with CDT.
+
+       - `APPC-1230 <https://jira.onap.org/browse/APPC-1230>`_ - APPC was using the GenericRestart DG instead of DGOrchestrator.
+
+       - `APPC-1231 <https://jira.onap.org/browse/APPC-1231>`_ - APPC was not updating the TRANSACTIONS table correctly when an operation completed.
+
+       - `APPC-1233 <https://jira.onap.org/browse/APPC-1233>`_ - DGOrchestrator was incorrectly being given an output.payload parameter instead of output-payload.
+
+       - `APPC-1234 <https://jira.onap.org/browse/APPC-1234>`_ - AppC Open Day Light login was responding 401 unauthorized when AAF was enabled.
+
+       - `APPC-1237 <https://jira.onap.org/browse/APPC-1237>`_ - APPC was not properly url-encoding AAF credentials.
+
+       - `APPC-1243 <https://jira.onap.org/browse/APPC-1243>`_ - Container was not preserving mysql data after kubectl edit statefulset.
+
+       - `APPC-1244 <https://jira.onap.org/browse/APPC-1244>`_ - Ansible Server would never start in oom.
+
+**Known Issues**
+
+       - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
+           - This issue is relevant during the vCPE use case.
+           - Due to this defect, the VM will perform four start/stop sequences, instead of the normal one.
+           - After the four start/stop sequences, the VM will be left in the correct state that it should be in.
+       
+       - Work-around required for vCPE use case to correct the error described in: `CCSDK-741 <https://jira.onap.org/browse/CCSDK-741>`_
+           - CCSDK aai adapter doesn't recognize generic-vnf attribute in the response, as it is not defined by aai_schema XSD
+           - To work around this, several steps must be performed as described here:
+               
+               1. Add a restapi template file into the appc docker containers
+                   a. Enter the appc docker container (docker exec... or kubectl exec...)
+                   b. Create a directory: /opt/onap/appc/templates
+                   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
+               2. Replace the generic restart DG with a new one
+                   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>`_
+                   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.
+                   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)
+               3. Load the new DG file
+                   a. In the appc docker containers, enter the "/opt/appc/svclogic/bin directory
+                   b. Run install-converted-dgs.sh
+
+Quick Links:
+
+       - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
+       
+       - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
+       
+       - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=40927352>`_
+
+**Other**
+
+- Limitations, Constraints and other worthy notes:
+
+       - OpenStack Restriction:
+
+               - Currently APPC only supports OpenStack.
+
+               - Admin level access for Tenant level operations.
+
+               - OpenStack Hypervisorcheck is turned off by default.
+
+
+       - 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.
+       
+
+
 Version: 1.3.0
 --------------