update appc release note
[appc.git] / docs / release-notes.rst
1 .. ============LICENSE_START==========================================
2 .. ===================================================================
3 .. Copyright © 2017-2019 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.5.3
30 --------------
31
32 :Release Date: 2019-6-19
33
34 **New Features**
35
36 The Dublin release added the following functionality:
37
38          - Upgraded OpenDaylight (ODL) version to Fluorine SR1
39
40          - Migrated CDT docker to node.js base docker image
41
42          - 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):
43
44          - To support in-place software upgrade:
45
46                 - DistributeTrafficCheck
47
48          - Added Multiple standalone ansible servers support
49
50          - Additional contributions as part of Dublin include:
51
52                 - Test Coverage increased to 83.8%
53
54                 - Support for Platform Maturity requirements, including:
55
56                    - Security
57
58                          - Applicaton runs as non-root user in all APPC dockers
59
60                          - Migrated to https for CDT GUI
61
62                    - Stability
63
64                           - 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 )
65
66                    - Resiliency
67
68                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see https://wiki.onap.org/display/DW/APPC+Resiliency for additional details)
69
70
71 **Bug Fixes**
72
73       - `APPC-1242 <https://jira.onap.org/browse/APPC-1242>`_ - vFWCL ModifyConfig only works on one node in an APPC cluster.
74       - `APPC-1263 <https://jira.onap.org/browse/APPC-1263>`_ - Two methods of Artifact Transformer in appc-config-params will always return null.
75       - `APPC-1264 <https://jira.onap.org/browse/APPC-1264>`_ - Errors in unit tests in config-generator package.
76       - `APPC-1270 <https://jira.onap.org/browse/APPC-1270>`_ - Unit tests in ccadaptor code not testing correctly.
77       - `APPC-1274 <https://jira.onap.org/browse/APPC-1274>`_ - APPC DG : RestAdapter plugin : lack of documentation.
78       - `APPC-1303 <https://jira.onap.org/browse/APPC-1303>`_ - DependencyModelParser works toward incorrectly spelled property name.
79       - `APPC-1331 <https://jira.onap.org/browse/APPC-1331>`_ - Test cases in appc-common cause intermittent failures.
80       - `APPC-1367 <https://jira.onap.org/browse/APPC-1367>`_ - APPC returns UnknownHostException during Netconf operations.
81       - `APPC-1435 <https://jira.onap.org/browse/APPC-1435>`_ - APPC Ansible Server keeps crashing.
82       - `APPC-1441 <https://jira.onap.org/browse/APPC-1441>`_ - incompatible cherrypy version in ansible server container.
83       - `APPC-1463 <https://jira.onap.org/browse/APPC-1463>`_ - Error in ControllerImpl class.
84       - `APPC-1472 <https://jira.onap.org/browse/APPC-1472>`_ - Not possible to call ansible healthcheck from SO VnfConfigUpdate workflow.
85       - `APPC-1479 <https://jira.onap.org/browse/APPC-1479>`_ - Logic error in ScheduledPublishingPolicyImpl.
86       - `APPC-1480 <https://jira.onap.org/browse/APPC-1480>`_ - MetricRegistryImpl code has problems with casting.
87       - `APPC-1489 <https://jira.onap.org/browse/APPC-1489>`_ - SO VnfConfigUpdate workflow fails with timeout error.
88       - `APPC-1528 <https://jira.onap.org/browse/APPC-1528>`_ - APPC DB table creation failed.
89       - `APPC-1537 <https://jira.onap.org/browse/APPC-1537>`_ - UNIQUE KEY is too long in DEVICE_AUTHENTICATION.
90       - `APPC-1542 <https://jira.onap.org/browse/APPC-1542>`_ - ExecuteNodeActionImpl is not instatiate.
91       - `APPC-1545 <https://jira.onap.org/browse/APPC-1545>`_ - Problem with Ansible handling in EncryptionToolDGWrapper.
92       - `APPC-1548 <https://jira.onap.org/browse/APPC-1548>`_ - "MariaDB 10.2.4 adds ""ROWS"" as an SQL keyword".
93       - `APPC-1574 <https://jira.onap.org/browse/APPC-1574>`_ - FileParameters not supported for Ansible LCM action.
94       - `APPC-1576 <https://jira.onap.org/browse/APPC-1576>`_ - FileParameters content is wrongly processed.
95       - `APPC-1577 <https://jira.onap.org/browse/APPC-1577>`_ - Ansible Server  playbook execution does not work.
96       - `APPC-1583 <https://jira.onap.org/browse/APPC-1583>`_ - ansible user privileges problem.
97       - `APPC-1584 <https://jira.onap.org/browse/APPC-1584>`_ - Incorrect Package name in Audit Directed Graph.
98       - `APPC-1589 <https://jira.onap.org/browse/APPC-1589>`_ - Cvaas directory is not mounted in docker image.
99       - `APPC-1593 <https://jira.onap.org/browse/APPC-1593>`_ - CDT doesn't push info to DB.
100       - `APPC-1600 <https://jira.onap.org/browse/APPC-1600>`_ - "APPC DB doesn't have any artifact for ""artifact-type""=""APPC-CONFIG""".
101       - `APPC-1604 <https://jira.onap.org/browse/APPC-1604>`_ - APPC Not Picking up Mesasges from Dmaap.
102       - `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.
103       - `APPC-1611 <https://jira.onap.org/browse/APPC-1611>`_ - VNF_DG_MAPPING and PROCESS_FLOW_REFERENCE tables are empty.
104       - `APPC-1612 <https://jira.onap.org/browse/APPC-1612>`_ - InventoryNames parameter support for APPC Ansible LCM.
105
106 **Known Issues**
107
108       - `APPC-1613 <https://jira.onap.org/browse/APPC-1613>`_ - Exception for LCM request with parameter read from A&AI.
109          - to work around this is to switch to the  fixed parameter in the template or passed as configuration parameter in stead of using A&AI that APPC received the value from the request.
110
111 **Security Notes**
112
113 *Fixed Security Issues*
114
115       - `OJSI-146 <https://jira.onap.org/browse/OJSI-146>`_ - In default deployment APPC (appc-cdt) exposes HTTP port 30289 outside of cluster.
116       - `OJSI-104 <https://jira.onap.org/browse/OJSI-104>`_ - In default deployment APPC (appc) exposes HTTP port 30211 outside of cluster.
117
118 *Known Security Issues*
119
120       - CVE-2019-12316 `OJSI-25 <https://jira.onap.org/browse/OJSI-25>`_ - SQL Injection in APPC
121       - `OJSI-29 <https://jira.onap.org/browse/OJSI-29>`_ - Unsecured Swagger UI Interface in AAPC
122       - CVE-2019-12124 `OJSI-63 <https://jira.onap.org/browse/OJSI-63>`_ - APPC exposes Jolokia Interface which allows to read and overwrite any arbitrary file
123       - `OJSI-95 <https://jira.onap.org/browse/OJSI-95>`_ - appc-cdt allows to impersonate any user by setting USER_ID
124       - `OJSI-112 <https://jira.onap.org/browse/OJSI-112>`_ - In default deployment APPC (appc-dgbuilder) exposes HTTP port 30228 outside of cluster.
125       - `OJSI-113 <https://jira.onap.org/browse/OJSI-113>`_ - In default deployment APPC (appc) exposes HTTP port 30230 outside of cluster.
126       - `OJSI-185 <https://jira.onap.org/browse/OJSI-185>`_ - appc exposes ssh service on port 30231
127
128 *Known Vulnerabilities in Used Modules*
129
130 Quick Links:
131
132         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
133
134         - `Passing Level Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
135
136         - `Silver Level Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579?criteria_level=1>`_
137
138         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=51282466>`_
139
140 **Other**
141
142 - Limitations, Constraints and other worthy notes:
143
144         - OpenStack Restriction:
145
146                 - Currently APPC only supports OpenStack.
147
148                 - Admin level access for Tenant level operations.
149
150                 - OpenStack Hypervisorcheck is turned off by default.
151
152
153 Version: 1.4.4
154 --------------
155
156 :Release Date: 2019-1-31
157
158
159 **Bug Fixes**
160
161 The Casablanca maintenance release fixed the following bugs:
162
163         - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
164
165         - `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.
166
167 Special Note for `APPC-1367 <https://jira.onap.org/browse/APPC-1367>`_ - APPC fails healthcheck with 404 error:
168
169        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.
170
171 Version: 1.4.3
172 --------------
173
174 :Release Date: 2018-11-30
175
176
177 **New Features**
178
179 The Casablanca release added the following functionality:
180
181          - Upgraded OpenDaylight (ODL) version to Oxygen
182
183          - Upgraded to Karaf 4.1.5
184
185          - Migrated DB from mysql to maria db with galeira, tested on k8s clustering platform
186
187          - Added an ansible docker container, tested for DistributeTraffic LCM action
188
189          - 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):
190
191                 - To support in-place software upgrade:
192
193                   - DistributeTraffic
194
195                 - To support storage management in OpenStack
196
197                   - Reboot with hard and soft option
198
199          - Additional contributions as part of Casablanca include:
200
201                 - Support for Platform Maturity requirements, including:
202
203                    - Increased security
204
205                           - 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)
206                           - 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 )
207
208                    - Stability
209
210                           - 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 )
211
212                    - Resiliency
213
214                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see https://wiki.onap.org/display/DW/APPC+Resiliency for additional details)
215
216
217 **Bug Fixes**
218
219         - `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.
220
221         - `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.
222
223         - `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.
224
225         - `APPC-1111 <https://jira.onap.org/browse/APPC-1111>`_ - TestDmaapConsumerImpl.testFetch method was taking 130+ seconds to run test. Build time is shorter now.
226
227         - `APPC-1112 <https://jira.onap.org/browse/APPC-1112>`_ - Several unit tests in TimeTest.java had intermittent failures.
228
229         - `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.
230
231         - `APPC-1184 <https://jira.onap.org/browse/APPC-1184>`_ - The APPC LCM API documentation was outdated and did not reflect the correct endpoints.
232
233         - `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.
234
235         - `APPC-1188 <https://jira.onap.org/browse/APPC-1188>`_ - Exception was occurring if force flag was set to false in a request from policy.
236
237         - `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.
238
239         - `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.
240
241         - `APPC-1207 <https://jira.onap.org/browse/APPC-1207>`_ - Logging constants were missing in several features, causing incorrect logging messages.
242
243         - `APPC-1218 <https://jira.onap.org/browse/APPC-1218>`_ - Aai connection had certificate errors and path build exceptions.
244
245         - `APPC-1224 <https://jira.onap.org/browse/APPC-1224>`_ - SubRequestID was not being relayed back to Policy in DMaaP Response messages.
246
247         - `APPC-1226 <https://jira.onap.org/browse/APPC-1226>`_ - Mock code to mimic backend execution for Reboot was causing problems and has been removed.
248
249         - `APPC-1227 <https://jira.onap.org/browse/APPC-1227>`_ - APPC was not able to read VNF templates created with CDT.
250
251         - `APPC-1230 <https://jira.onap.org/browse/APPC-1230>`_ - APPC was using the GenericRestart DG instead of DGOrchestrator.
252
253         - `APPC-1231 <https://jira.onap.org/browse/APPC-1231>`_ - APPC was not updating the TRANSACTIONS table correctly when an operation completed.
254
255         - `APPC-1233 <https://jira.onap.org/browse/APPC-1233>`_ - DGOrchestrator was incorrectly being given an output.payload parameter instead of output-payload.
256
257         - `APPC-1234 <https://jira.onap.org/browse/APPC-1234>`_ - AppC Open Day Light login was responding 401 unauthorized when AAF was enabled.
258
259         - `APPC-1237 <https://jira.onap.org/browse/APPC-1237>`_ - APPC was not properly url-encoding AAF credentials.
260
261         - `APPC-1243 <https://jira.onap.org/browse/APPC-1243>`_ - Container was not preserving mysql data after kubectl edit statefulset.
262
263         - `APPC-1244 <https://jira.onap.org/browse/APPC-1244>`_ - Ansible Server would never start in oom.
264
265 **Known Issues**
266
267         - `APPC-1247 <https://jira.onap.org/browse/APPC-1247>`_ - java.lang.NoClassDefFoundError when publishing DMAAP message
268             - This issue is relevant during the vCPE use case.
269             - Due to this defect, the VM will perform four start/stop sequences, instead of the normal one.
270             - After the four start/stop sequences, the VM will be left in the correct state that it should be in.
271
272         - Work-around required for vCPE use case to correct the error described in: `CCSDK-741 <https://jira.onap.org/browse/CCSDK-741>`_
273             - CCSDK aai adapter doesn't recognize generic-vnf attribute in the response, as it is not defined by aai_schema XSD
274             - To work around this, several steps must be performed as described here:
275
276                 1. Add a restapi template file into the appc docker containers
277                     a. Enter the appc docker container (docker exec... or kubectl exec...)
278                     b. Create a directory: /opt/onap/appc/templates
279                     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
280                 2. Replace the generic restart DG with a new one
281                     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>`_
282                     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.
283                     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)
284                 3. Load the new DG file
285                     a. In the appc docker containers, enter the "/opt/appc/svclogic/bin directory
286                     b. Run install-converted-dgs.sh
287
288 Quick Links:
289
290         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
291
292         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
293
294         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=40927352>`_
295
296 **Other**
297
298 - Limitations, Constraints and other worthy notes:
299
300         - OpenStack Restriction:
301
302                 - Currently APPC only supports OpenStack.
303
304                 - Admin level access for Tenant level operations.
305
306                 - OpenStack Hypervisorcheck is turned off by default.
307
308
309         - 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.
310
311
312
313 Version: 1.3.0
314 --------------
315
316
317 :Release Date: 2018-06-07
318
319
320 **New Features**
321
322 The Beijing release added the following functionality:
323
324          - 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):
325
326                 - To support in-place software upgrade:
327
328                   - QuiesceTraffic
329                   - ResumeTraffic
330                   - UpgradeSoftware
331                   - UpgradePreCheck
332                   - UpgradePostCheck
333                   - UpgradeBackup
334                   - UpgradeBackout
335
336                 - To support storage management in OpenStack
337
338                   - AttachVolume
339                   - DetachVolume
340
341                 - To support Manual Scale Out use case
342
343                   - ConfigScaleOut (more details can be found in teh APPC Epic: `APPC-431 <https://jira.onap.org/browse/APPC-431>`_ )
344
345                 - To support general operations
346
347                   - ActionStatus
348
349
350          - 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.
351
352                 - More details on the APPC CDT can be found in the APPC CDT User Guide in readthedocs.
353                 - 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
354
355          - Additional contributions as part of Beijing include:
356
357                 - Support for Platform Maturity requirements, including:
358
359                    - Increased security
360
361                           - Added security to ODL web-based API access via AAF (see `APPC-404 <https://jira.onap.org/browse/APPC-404>`_ for additional details)
362                           - Addressed critical alerts reported via Nexus IQ to the extent possible (see `APPC-656 <https://jira.onap.org/browse/APPC-656>`_ )
363
364                    - Stability
365
366                           - 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 )
367
368                    - Resiliency
369
370                           - Support for OOM deployment, which enables resiliency via use of Kubernetes (see `APPC-414 <https://jira.onap.org/browse/APPC-414>`_ for additional details)
371
372                 - Upgraded OpenDaylight (ODL) version to Nitrogen
373
374
375
376
377 **Bug Fixes**
378
379 The following defects that were documented as known issues in Amsterdam have been fixed in Beijing release:
380
381         - `APPC-316 <https://jira.onap.org/browse/APPC-316>`_ - Null payload issue for Stop Application
382
383         - `APPC-315 <https://jira.onap.org/browse/APPC-315>`_ - appc-request-handler is giving error java.lang.NoClassDefFoundError
384
385         - `APPC-312 <https://jira.onap.org/browse/APPC-312>`_ - APPC request is going to wrong request handler and rejecting request
386
387         - `APPC-311 <https://jira.onap.org/browse/APPC-311>`_ - The APPC LCM Provider Healthcheck
388
389         - `APPC-309 <https://jira.onap.org/browse/APPC-309>`_ - APPC LCM Provider URL missing in appc.properties.
390
391         - `APPC-307 <https://jira.onap.org/browse/APPC-307>`_ - Embed jackson-annotations dependency in appc-dg-common during run-time
392
393         - `APPC-276 <https://jira.onap.org/browse/APPC-276>`_ - Some Junit are breaking convention causing excessively long build
394
395         - `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.
396
397
398 **Known Issues**
399
400 The following issues remain open at the end of Beijing release. Please refer to Jira for further details and workaround, if available.
401
402         - `APPC-987 <https://jira.onap.org/browse/APPC-987>`_ - APPC Investigate TRANSACTION Table Aging. See **Other** section for further information
403
404         - `APPC-977 <https://jira.onap.org/browse/APPC-977>`_ - Procedures needed for enabling AAF support in OOM. See **Other** section for further information
405
406         - `APPC-973 <https://jira.onap.org/browse/APPC-973>`_ - Fix delimiter string for xml-download CDT action
407
408         - `APPC-940 <https://jira.onap.org/browse/APPC-940>`_ - APPC CDT Tool is not updating appc_southbound.properties with the URL supplied for REST
409
410         - `APPC-929 <https://jira.onap.org/browse/APPC-929>`_ - LCM API - ConfigScaleOut- Payload parameter to be manadatory set to "true"
411
412         - `APPC-912 <https://jira.onap.org/browse/APPC-912>`_ - MalformedChunkCodingException in MDSALStoreImpl.getNodeName
413
414         - `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
415
416         - `APPC-869 <https://jira.onap.org/browse/APPC-869>`_ - VM Snapshot error occurs during image validation.
417
418         - `APPC-814 <https://jira.onap.org/browse/APPC-814>`_ - Update openecomp-tosca-datatype namespace
419
420         - `APPC-340 <https://jira.onap.org/browse/APPC-340>`_ - APPC rejecting request even for decimal of millisecond timestamp difference
421
422         - `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.
423
424
425 **Security Notes**
426
427 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>`_.
428
429 Additionally, communication over DMaaP currently does not use secure topics in this release. This has dependency on DMaaP to enable.
430
431
432 Quick Links:
433         - `APPC project page <https://wiki.onap.org/display/DW/Application+Controller+Project>`_
434
435         - `Passing Badge information for APPC <https://bestpractices.coreinfrastructure.org/en/projects/1579>`_
436
437         - `Project Vulnerability Review Table for APPC <https://wiki.onap.org/pages/viewpage.action?pageId=25438971>`_
438
439 **Other**
440
441 - Limitations, Constraints and other worthy notes
442
443         - 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>`_):
444
445              - Needed APPC configuration files were missing in Beijing OOM , and
446              - AAF updated their certificates to require 2way certs, which requires APPC updates
447
448           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.
449
450         - 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.
451
452         - 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
453
454         - Currently APPC only supports OpenStack
455
456         - 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.
457
458         - 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.
459
460         - APPC needs Admin level access for Tenant level operations.
461
462         - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
463
464
465 Version: 1.2.0
466 --------------
467
468 :Release Date: 2017-11-16
469
470
471 **New Features**
472
473 The Amsterdam release continued evolving the design driven architecture of and functionality for APPC.
474 APPC aims to be completely agnostic and make no assumption about the network.
475
476 The main goal of the Amsterdam release was to:
477  - Support the vCPE use case as part of the closed loop action to perform a Restart on the vGMUX
478  - Demonstrate integration with MultiCloud as a proxy to OpenStack
479  - Continue supporting the vFW closed loop use case as part of regression from the seed contribution.
480
481 Other key features added in this release include:
482  - Support for Ansible
483    - 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.
484  - Support for Chef
485    - The Chef Extension for APPC allows management of VNFs that support Chef through the following two additions: a Chef Adapter and Chef Directed Graph.
486  - LifeCycle Management (LCM) APIs via standalone DGs or via the DGOrchestrator architecture to trigger actions on VMs, VNFs, or VNFCs
487  - OAM APIs to manage the APPC application itself
488  - Upgrade of OpenDaylight to Carbon version
489
490
491
492 **Bug Fixes**
493
494         - 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>`_.
495
496         - 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)
497
498 **Known Issues**
499
500         - `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``.
501
502         - `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.
503
504         - `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.
505
506         - `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.
507
508         - `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.
509
510         - `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.
511
512         - `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.
513
514
515 **Security Issues**
516         - Communication over DMaaP currently does not use secure topics in this release.
517         - AAF is deactivated by default in this release and was not validated or committed as part of the Amsterdam Release.
518
519
520 **Other**
521
522 - Limitations, Constraints and other worthy notes
523
524   - LCM Healthcheck and Configure actions do not work.
525   - The APPC actions validated in this release are captured here: https://wiki.onap.org/display/DW/APPC+Testing+Scope+and+Status
526   - Currently APPC only supports OpenStack
527   - 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.
528   - 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.
529   - APPC needs Admin level access for Tenant level operations.
530   - Currently, if DGs are modified in appc.git repo, they must be manually moved to the appc/deployment repo.
531   - Currently, the "ModifyConfig" API and the implementation in the Master Directed Graph is only designed to work with the vFW Closed-Loop Demo.
532
533
534 ===========
535
536 End of Release Notes