Update Amsterdam Release Notes
[aai/aai-common.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
4
5
6 AAI Release Notes
7 ==================
8
9 .. note::
10         * This Release Notes must be updated each time the team decides to Release new artifacts.
11         * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
12         * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
13         * 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.
14         * This note must be removed after content has been added.
15                    
16
17 Version: x.y.z
18 --------------
19
20
21 :Release Date: 2017-11-17
22
23
24 **New Features**
25         Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP).  AAI provides ONAP with its logically centralized view of inventory data, taking in updates from orchestrators, controllers, and assurance systems.  AAI provides core REST services for 
26
27         ONAP AAI R1 includes the following components:
28
29 - AAI Data Management
30   - Resources (CRUD operations)
31   - Traversal (Advanced search operations)
32   - Data Router (Route/persist AAI event data for consumption by the UI)
33   - Model Loader (Obtains SDC artifacts and loads them into the A&AI Resources service for storage)
34   - Search Data SErvice (Abstraction layer for searchengine, supporting queries and updates)
35     
36 - Applications
37   - Sparky (AAI User Interface)
38
39 Source code of AAI is released under the following repositories on gerrit.onap.org
40
41 - aai/aai-common
42 - aai/aai-config
43 - aai/aai-data
44 - aai/aai-service
45 - aai/babel
46 - aai/champ
47 - aai/data-router
48 - aai/esr-gui
49 - aai/esr-server
50 - aai/gizmo
51 - aai/logging-service
52 - aai/model-loader
53 - aai/resources
54 - aai/rest-client
55 - aai/router-core
56 - aai/search-data-service
57 - aai/sparky-be
58 - aai/sparky-fe
59 - aai/test-config
60 - aai/traversal
61
62 Epic
63 ^^^^
64         - `AAI-17 <https://jira.onap.org/browse/AAI-17>`_
65           Seed code stabilization
66         - `AAI-20 <https://jira.onap.org/browse/AAI-20>`_
67           Champ Library
68         - `AAI-22 <https://jira.onap.org/browse/AAI-22>`_
69           Amsterdam User Case Schema Updates
70         - `AAI-23 <https://jira.onap.org/browse/AAI-23>`_
71           Model Loader Support for R1
72         - `AAI-58 <https://jira.onap.org/browse/AAI-58>`_
73           Define and build functional test cases for CSIT
74         - `AAI-72 <https://jira.onap.org/browse/AAI-72>`_
75           External System Register
76         - `AAI-254 <https://jira.onap.org/browse/AAI-254`_
77           Documentation of REST APIs, dev guides, onboarding, etc.
78         - `AAI-280 <https://jira.onap.org/browse/AAI-280`_
79           Confguration enhancements
80
81 **Bug Fixes**
82
83 `AAI-11 <https://jira.onap.org/browse/AAI-11`_
84 robot_vm: demo.sh failing - '200' does not match '^(201|412)$' on vanilla openstack
85
86 `AAI-13 <https://jira.onap.org/browse/AAI-13`_
87 VM_init is failing to get sparky
88
89 `AAI-31 <https://jira.onap.org/browse/AAI-31`_
90 Compilation failure in aai-traversal
91
92 `AAI-48 <https://jira.onap.org/browse/AAI-48`_
93 AAI Common REST Client returns an error on a 204 (No Content) server response
94
95 `AAI-49 <https://jira.onap.org/browse/AAI-49`_
96 Health check is failing in DFW 1.1 RS. Connection refused.
97
98 `AAI-62 <https://jira.onap.org/browse/AAI-62`_
99 Search Data Service should not implicitly create indexes on document write...
100
101 `AAI-63 <https://jira.onap.org/browse/AAI-63`_
102 Data Router must handle Search Service document create failures if index does not exit.
103
104 `AAI-73 <https://jira.onap.org/browse/AAI-73`_
105 Sparky sync issues
106
107 `AAI-76 <https://jira.onap.org/browse/AAI-76`_
108 Jenkins stage-site builds failing on resources and traversal
109
110 `AAI-94 <https://jira.onap.org/browse/AAI-94`_
111 AAI Certificate will expire 30 Nov 2017 - fyi
112
113 `AAI-146 <https://jira.onap.org/browse/AAI-146`_
114 Both esr-server and esr-gui Jenkins failed
115
116 `AAI-192 <https://jira.onap.org/browse/AAI-192`_
117 Model Loader depends on httpclient version 4.4.1
118
119 `AAI-205 <https://jira.onap.org/browse/AAI-205`_
120 Having an invalid xml namespace for v11, named-query api returns 500 error, model query return incorrect error message
121
122 `AAI-206 <https://jira.onap.org/browse/AAI-206`_
123 Model based delete is failing
124
125 `AAI-217 <https://jira.onap.org/browse/AAI-217`_
126 Remove internal references from A&AI seed code
127
128 `AAI-222 <https://jira.onap.org/browse/AAI-222`_
129 the version property of esr-server is incorrect
130
131 `AAI-224 <https://jira.onap.org/browse/AAI-224`_
132 aai/esr-gui daily build failed
133
134 `AAI-225 <https://jira.onap.org/browse/AAI-225`_
135 aai/esr-server daily build failed
136
137 `AAI-265 <https://jira.onap.org/browse/AAI-265`_
138 EdgePropertyMap throws NullPointer if edge rule does not include property
139
140 `AAI-266 <https://jira.onap.org/browse/AAI-266`_
141 auth-info edge rule does not include contains-other-v
142
143 `AAI-273 <https://jira.onap.org/browse/AAI-273`_
144 Fix the esr-server setup error issue
145
146 `AAI-278 <https://jira.onap.org/browse/AAI-278`_
147 AAI throws exception about mismatch keys adding esr-system-info to cloud-region
148
149 `AAI-293 <https://jira.onap.org/browse/AAI-293`_
150 Jenkins job failing for aai-sparky-fe-master-release-version-java-daily
151
152 `AAI-377 <https://jira.onap.org/browse/AAI-377`_
153 esr-gui docker build failed
154
155 `AAI-393 <https://jira.onap.org/browse/AAI-393`_
156 The jjb defiend in a error way that cause CSIT build failed.
157
158 `AAI-398 <https://jira.onap.org/browse/AAI-398`_
159 If a cloud-region didn't contain a external system info, there will be an null pointer error
160
161 `AAI-400 <https://jira.onap.org/browse/AAI-400`_
162 Register ServiceTest to microservice
163
164 `AAI-401 <https://jira.onap.org/browse/AAI-401`_
165 Remove DMaaP router duplication
166
167 `AAI-407 <https://jira.onap.org/browse/AAI-407`_
168 There is an error to startup esr-gui docker
169
170 `AAI-412 <https://jira.onap.org/browse/AAI-412`_
171 Replace the type specification in this constructor call with the diamond operator ("<>").
172
173 `AAI-417 <https://jira.onap.org/browse/AAI-417`_
174 Rackspace 20170928 fails to authenticate nexus3 on 10003 during *_init.sh (sdnc for example)
175
176 `AAI-420 <https://jira.onap.org/browse/AAI-420`_
177 Can not get the MSB address in esr-server
178
179 `AAI-422 <https://jira.onap.org/browse/AAI-422`_
180 The esr-server csit failed
181
182 `AAI-424 <https://jira.onap.org/browse/AAI-424`_
183 The integration catalog is not in use, should be removed
184
185 `AAI-425 <https://jira.onap.org/browse/AAI-425`_
186 Fix the artifact of esr-gui
187
188 `AAI-426 <https://jira.onap.org/browse/AAI-426`_
189 Fix the artifact of esr-server
190
191 `AAI-431 <https://jira.onap.org/browse/AAI-431`_
192 esr-gui files did not contained in webapp of tomcat
193
194 `AAI-433 <https://jira.onap.org/browse/AAI-433`_
195 Failed to pre-load vCPE data to AAI. No response from AAI
196
197 `AAI-434 <https://jira.onap.org/browse/AAI-434`_
198 Can not visit ESR portal with demo deployment
199
200 `AAI-435 <https://jira.onap.org/browse/AAI-435`_
201 default tenant need be input to A&AI while register VIM
202
203 `AAI-436 <https://jira.onap.org/browse/AAI-436`_
204 Call the API from MultiCloud failed
205
206 `AAI-440 <https://jira.onap.org/browse/AAI-440`_
207 The version input box should be changed in a more easy to use when register a VIM
208
209 `AAI-441 <https://jira.onap.org/browse/AAI-441`_
210 Can not input the vendor and version information to EMS, but there is a default data for the two parameter
211
212 `AAI-442 <https://jira.onap.org/browse/AAI-442`_
213 Can't instantiate a service
214
215 `AAI-444 <https://jira.onap.org/browse/AAI-444`_
216 Cannot associate multiple service-instances to PNFs
217
218 `AAI-446 <https://jira.onap.org/browse/AAI-446`_
219 vnf to esr-system-info named-query is missing vnfc
220
221 `AAI-448 <https://jira.onap.org/browse/AAI-448`_
222 Remove snapshot dependencies from aai-common, data-router, and rest-client
223
224 `AAI-450 <https://jira.onap.org/browse/AAI-450`_
225 Named Query needs to be updated to return VNFC Info
226
227 `AAI-453 <https://jira.onap.org/browse/AAI-453`_
228 Fix stage-site jenkins job for aai-common
229
230 `AAI-454 <https://jira.onap.org/browse/AAI-454`_
231 LoggingContext.requestId required NULL handling in aai/aai-common (20170607) - during demo.sh init_customer
232
233 **Known Issues**
234         - `AAI-61 <https://jira.onap.org/browse/AAI-61>`_ 
235         AAI cleaned up references to OpenECOMP but in order to keep the release stable for R1, the XML namespace still contains openecomp.
236           
237         Client systems should use http://org.openecomp.aai.inventory/v11 as the XML namespace for ONAP AAI R1
238
239 **Security Issues**
240         See Common Vulnerabilities and Exposures `CVE <https://cve.mitre.org>`_
241
242         ONAP docker images and repos include demo TLS server certificates that are signed by a demo Certificate Authority. DO NOT use the demo certificates in a production environment.
243
244         AAI uses HTTPS Basic Authentication
245
246 **Upgrade Notes**
247
248         This is an initial release
249
250 **Deprecation Notes**
251         AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release.  v11 is the latest and preferred version.
252
253 **Other**
254
255 ===========
256
257 End of Release Notes