Rls notes updates for ojsi
[dcaegen2.git] / docs / sections / 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 (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
4
5 Release Notes
6 =============
7
8 Version: 5.0.1
9 --------------
10
11 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
12
13 Following is summary of updates done for DCAEGEN2
14
15 **Security**
16
17 Following platform components were enabled for HTTPS
18     - ConfigBindingService (CBS)
19       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
20     - Cloudify Manager
21     - InventoryAPI
22     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
23
24 All components interfacing with platform components were modified to support TLS interface
25
26 **Miscellaneous**
27     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
28     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
29     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service 
30     - CBS client libraries updated to remove consul service lookup
31     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler) 
32
33
34
35 With this release, all DCAE platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/DCAE installation.
36     - Platform components
37         - Cloudify Manager (helm chart)
38         - Bootstrap container (helm chart)
39         - Configuration Binding Service (helm chart)
40         - Deployment Handler (helm chart)
41         - Policy Handler (helm chart
42         - Service Change Handler (helm chart)
43         - Inventory API (helm chart)
44         - Dashboard (helm charts)
45     - Service components
46         - VES Collector
47         - SNMP Collector
48         - Threshold Crossing Analytics
49         - HV-VES Collector
50         - PNF-Registration Handler
51         - Holmes Rule Management *
52         - Holmes Engine Management *
53     - Additional resources that DCAE utilizes:
54         - Postgres Database
55         - Redis Cluster Database
56         - Consul Cluster *
57
58     Notes:
59         \*  These components are delivered by external ONAP project.
60
61 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
62
63     - Collectors
64         - RESTConf collector 
65         - DataFile collector
66     - Event Processors
67         - VES Mapper
68         - 3gpp PM-Mapper
69         - BBS Event processor
70     - Analytics/RCA
71         - SON-Handler
72         - Missing Heartbeat Ms 
73     
74 - All DCAE components are designed to support platform maturity requirements.
75
76
77 **Source Code**
78
79 Source code of DCAE components are released under the following repositories on gerrit.onap.org; there is no new component introduced for El-Alto Early-drop.
80     - dcaegen2
81     - dcaegen2.analytics.tca
82     - dcaegen2.collectors.snmptrap
83     - dcaegen2.collectors.ves
84     - dcaegen2.collectors.hv-ves
85     - dcaegen2.collectors.datafile
86     - dcaegen2.collectors.restconf
87     - dcaegen2.deployments
88     - dcaegen2.platform.blueprints
89     - dcaegen2.platform.cli
90     - dcaegen2.platform.configbinding
91     - dcaegen2.platform.deployment-handler
92     - dcaegen2.platform.inventory-api
93     - dcaegen2.platform.plugins
94     - dcaegen2.platform.policy-handler
95     - dcaegen2.platform.servicechange-handler
96     - dcaegen2.services.heartbeat
97     - dcaegen2.services.mapper
98     - dcaegen2.services.pm-mapper
99     - dcaegen2.services.prh
100     - dcaegen2.services.son-handler
101     - dcaegen2.services
102     - dcaegen2.services.sdk
103     - dcaegen2.utils
104     - ccsdk.platform.plugins
105     - ccsdk.dashboard
106
107 **Bug Fixes**
108     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
109     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
110
111
112 **Known Issues**
113     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594) 
114     
115 **Security Notes**
116
117 *Fixed Security Issues*
118     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
119     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
120     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
121     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
122
123 *Known Security Issues*
124
125     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
126     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
127     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
128     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
129     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
130     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
131
132 *Known Vulnerabilities in Used Modules*
133
134 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
135
136 Quick Links:
137         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
138
139         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
140
141         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
142
143
144 **Upgrade Notes**
145
146 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
147     - K8S Bootstrap container:
148        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
149        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
150     - Configuration Binding Service:
151        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
152        - Description: HTTPS support, Image optimization and non-root user
153     - Inventory API
154        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
155        - Description: HTTPS support, container optmization and non-root user
156     - DataFile Collector
157        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
158        - Description : Code optimization, bug fixes, dmaap plugin integration
159     - SON Handler MS
160        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
161        - Description : Image optimization, bug fixes, CBS integration
162     - VES Adapter/Mapper MS
163        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
164        - Description : Image optimization & CBS periodic polling
165     - PRH MS
166        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
167        - Description : Code optimization, bug fixes and SDK alignment
168     - HV-VES MS
169        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
170        - Description : Code optimization, bug fixes and SDK alignment
171
172 Version: 5.0.0
173 --------------
174
175 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
176
177 Following is summary of updates done for DCAEGEN2
178
179 **Security**
180
181 Following platform components were enabled for HTTPS
182     - ConfigBindingService (CBS)
183       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
184     - Cloudify Manager
185     - InventoryAPI
186
187 All components interfacing with platform components were modified to support TLS interface
188
189 **Miscellaneous**
190     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
191     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
192     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service 
193     - CBS client libraries updated to remove consul service lookup
194
195
196
197 **Bug Fixes**
198     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
199     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
200
201
202 **Known Issues**
203     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594) 
204     
205
206 **Security Notes**
207
208 *Fixed Security Issues*
209
210 *Known Security Issues*
211
212     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
213     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
214     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
215     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
216     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
217     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
218     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
219     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
220     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
221     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
222
223 *Known Vulnerabilities in Used Modules*
224
225 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
226
227 Quick Links:
228         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
229
230         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
231
232         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
233
234
235 **Upgrade Notes**
236
237 The following components are upgraded from Dublin/R4.
238     - Cloudify Manager:
239        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
240        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5. The container was updated to support TLS.
241     - K8S Bootstrap container:
242        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
243        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
244     - Configuration Binding Service:
245        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
246        - Description: HTTPS support, Image optimization and non-root user
247     - Deployment Handler
248        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
249        - Description: Update to node10, uninstall workflow updates
250     - Service Change Handler
251        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
252        - Description: HTTPS inventoryAPI support, container optmization and non-root user
253     - Inventory API
254        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
255        - Description: HTTPS support, container optmization and non-root user
256     - DataFile Collector
257        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
258        - Description : Code optimization, bug fixes, dmaap plugin integration
259     - 3gpp PM-Mapper
260        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
261        - Description: Code optimization, bug fixes, dmaap plugin integration
262
263
264
265 Version: 4.0.0
266 --------------
267
268 :Release Date: 2019-06-06
269
270 **New Features**
271
272 DCAE R4 improves upon previous release with the following new features:
273
274 - DCAE Platform Enhancement
275     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
276     - Support helm chart deployment in DCAE using new Helm cloudify plugin
277     - DCAE Healthcheck enhancement to cover static and dynamic deployments
278     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
279     - Dashboard Integration (UI for deployment/verification)
280     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
281     - Blueprint generator tool to simplify deployment artifact creation
282     - Cloudify Manager resiliency
283
284 - Following new services are delivered with Dublin
285     - Collectors
286         - RESTConf collector 
287     - Event Processors
288         - VES Mapper
289         - 3gpp PM-Mapper
290         - BBS Event processor
291     - Analytics/RCA
292         - SON-Handler
293         - Heartbeat MS
294
295 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
296     - Platform components
297         - Cloudify Manager (helm chart)
298         - Bootstrap container (helm chart)
299         - Configuration Binding Service (helm chart)
300         - Deployment Handler (helm chart)
301         - Policy Handler (helm chart
302         - Service Change Handler (helm chart)
303         - Inventory API (helm chart)
304         - Dashboard (Cloudify Blueprint)
305     - Service components
306         - VES Collector
307         - SNMP Collector
308         - Threshold Crossing Analytics
309         - HV-VES Collector
310         - PNF-Registration Handler
311         - Holmes Rule Management *
312         - Holmes Engine Management *
313     - Additional resources that DCAE utilizes:
314         - Postgres Database
315         - Redis Cluster Database
316         - Consul Cluster *
317
318     Notes:
319         \*  These components are delivered by the Holmes project.
320
321
322 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE R3 includes enhancement to Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
323
324 - All DCAE components are designed to support platform maturity requirements.
325
326
327 **Source Code**
328
329 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
330     - dcaegen2
331     - dcaegen2.analytics.tca
332     - dcaegen2.collectors.snmptrap
333     - dcaegen2.collectors.ves
334     - dcaegen2.collectors.hv-ves
335     - dcaegen2.collectors.datafile
336     - dcaegen2.collectors.restconf
337     - dcaegen2.deployments
338     - dcaegen2.platform.blueprints
339     - dcaegen2.platform.cli
340     - dcaegen2.platform.configbinding
341     - dcaegen2.platform.deployment-handler
342     - dcaegen2.platform.inventory-api
343     - dcaegen2.platform.plugins
344     - dcaegen2.platform.policy-handler
345     - dcaegen2.platform.servicechange-handler
346     - dcaegen2.services.heartbeat
347     - dcaegen2.services.mapper
348     - dcaegen2.services.pm-mapper
349     - dcaegen2.services.prh
350     - dcaegen2.services.son-handler
351     - dcaegen2.services
352     - dcaegen2.services.sdk
353     - dcaegen2.utils
354     - ccsdk.platform.plugins
355     - ccsdk.dashboard
356
357 **Bug Fixes**
358
359 **Known Issues**
360     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594) 
361     
362
363 **Security Notes**
364
365 *Fixed Security Issues*
366
367 *Known Security Issues*
368
369     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
370     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
371     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
372     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
373     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
374     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
375     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
376     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
377     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
378     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
379
380 *Known Vulnerabilities in Used Modules*
381
382 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
383
384 Quick Links:
385         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
386
387         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
388
389         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
390
391
392 **New component Notes**
393 The following components are introduced in R4
394
395     - Dashboard
396        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
397        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
398     - Blueprint generator
399        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
400        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
401     - RESTConf collector 
402        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
403        - Description: Provides RESTConf interfaces to events from external domain controllers
404     - VES/Universal Mapper
405        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
406        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
407     - 3gpp PM-Mapper
408        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
409        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
410     - BBS Event processor
411        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
412        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
413     - SON-Handler
414        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
415        - Description: Supports PC-ANR optimization analysis and generating CL events output
416     - Heartbeat MS
417        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
418        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
419
420
421 **Upgrade Notes**
422
423 The following components are upgraded from R3
424     - Cloudify Manager:
425        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
426        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
427     - K8S Bootstrap container:
428        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
429        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
430     - Configuration Binding Service:
431        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
432        - Description: Code optimization and bug fixes
433     - Deployment Handler
434        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
435        - Include updates for health and service endpoint check and bug fixes
436     - Policy Handler
437        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
438        - Description: Policy Handler supports the new lifecycle API's from Policy framework
439     - Service Change Handler
440        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
441        - Description: No update from R3
442     - Inventory API
443        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
444        - Description: Refactoring and updates for health and service endpoint check
445     - VES Collector
446        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
447        - Description : Authentication enhancement, refactoring and bug-fixes
448     - Threshold Crossing Analytics
449        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
450        - Description: Config updates. Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
451     - DataFile Collector
452        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
453        - Description : Code optimization, bug fixes, logging and performance improvement
454     - PNF Registrator handler
455        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
456        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
457     - HV-VES Collector
458        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
459        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
460     - SNMP Trap Collector
461        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
462        - Description : Code coverage improvements
463
464
465
466
467 Version: 3.0.1
468 --------------
469
470 :Release Date: 2019-01-31
471
472 DCAE R3 Maintenance release includes following fixes
473
474 **Bug Fixes**
475
476 - DataFileCollector
477      - DCAEGEN2-940
478        Larger files of size 100Kb publish to DR
479      - DCAEGEN2-941
480        DFC error after running over 12 hours
481      - DCAEGEN2-1001
482        Multiple Fileready notification not handled
483
484 - HighVolume VES Collector (protobuf/tcp)
485      - DCAEGEN2-976
486        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
487
488 - VESCollector (http)
489      - DCAEGEN2-1035
490        Issue with VES batch event publish
491
492 - Heat deployment
493      - DCAEGEN2-1007
494        Removing obsolete services configuration
495
496
497 The following containers are updated in R3.0.1
498
499     - DataFile Collector
500        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
501     - HV-VES Collector
502        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
503     - VES Collector
504        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
505
506 **Known Issues**
507
508 - An issue related to VESCollector basic authentication was noted and tracked under DCAEGEN2-1130. This configuration is not enabled by default for R3.0.1; and fix will be handled in Dublin
509
510 - Certificates under onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 has expired March'2019 and impacting CL deployment from CLAMP. Follow below workaround to update the certificate
511     kubectl get deployments -n onap | grep deployment-handler
512     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
513     Search and change tag onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 to onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3
514
515
516
517
518 Version: 3.0.0
519 --------------
520
521 :Release Date: 2018-11-30
522
523 **New Features**
524
525 DCAE R3 improves upon previous release with the following new features:
526
527 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
528     - Platform components
529         - Cloudify Manager
530         - Bootstrap container
531         - Configuration Binding Service
532         - Deployment Handler
533         - Policy Handler
534         - Service Change Handler
535         - Inventory API
536     - Service components
537         - VES Collector
538         - SNMP Collector
539         - Threshold Crossing Analytics
540         - Holmes Rule Management *
541         - Holmes Engine Management *
542     - Additional resources that DCAE utilizes:
543         - Postgres Database
544         - Redis Cluster Database
545         - Consul Cluster
546
547     Notes:
548         \*  These components are delivered by the Holmes project.
549
550 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
551
552     - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
553     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
554
555 - DCAE R3 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
556
557 - All DCAE components are designed to support platform maturity requirements.
558
559
560 **Source Code**
561
562 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
563     - dcaegen2
564     - dcaegen2.analytics
565     - dcaegen2.analytics.tca
566     - dcaegen2.collectors
567     - dcaegen2.collectors.snmptrap
568     - dcaegen2.collectors.ves
569     - dcaegen2.collectors.hv-ves
570     - dcaegen2.collectors.datafile
571     - dcaegen2.deployments
572     - dcaegen2.platform
573     - dcaegen2.platform.blueprints
574     - dcaegen2.platform.cli
575     - dcaegen2.platform.configbinding
576     - dcaegen2.platform.deployment-handler
577     - dcaegen2.platform.inventory-api
578     - dcaegen2.platform.plugins
579     - dcaegen2.platform.policy-handler
580     - dcaegen2.platform.servicechange-handler
581     - dcaegen2.services.heartbeat
582     - dcaegen2.services.mapper
583     - dcaegen2.services.prh
584     - dcaegen2.utils
585
586 **Bug Fixes**
587
588 **Known Issues**
589
590 - DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine.  Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image.  DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
591
592 **Security Notes**
593
594 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
595
596 Quick Links:
597         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
598
599         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
600
601         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
602
603
604 **New component Notes**
605 The following components are introduced in R3
606
607     - DataFile Collector
608        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
609        - Description : Bulk data file collector to fetch non-realtime PM data
610     - PNF Registrator handler
611        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
612        - Description : Recieves VES registration event and updates AAI and SO
613     - HV-VES Collector
614        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
615        - Description : High Volume VES Collector for fetching real-time PM measurement data
616     - SNMP Trap Collector
617        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
618        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
619
620
621 **Upgrade Notes**
622
623 The following components are upgraded from R2:
624     - Cloudify Manager:
625        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
626        - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.7.23, which is based on Cloudify Manager 4.3.
627     - Bootstrap container:
628        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
629        - Description: R3 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications.  The bootstrap is for OOM (Kubernetes) based deployment.
630     - Configuration Binding Service:
631        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
632        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
633     - Deployment Handler
634        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
635     - Policy Handler
636        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
637        - Description: Policy Handler now supports the new configuration policy format and support for TLS
638     - Service Change Handler
639        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
640        - Description: Refactoring.
641     - Inventory API
642        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
643        - Description: Refactoring.
644     - VES Collector
645        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
646        - Description : Refactoring
647     - Threshold Crossing Analytics
648        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
649        - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
650
651
652
653
654 Version: 2.0.0
655 --------------
656
657 :Release Date: 2018-06-07
658
659 **New Features**
660
661 DCAE R2 improves upon previous release with the following new features:
662
663 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
664     - Platform components
665         - Cloudify Manager
666         - Bootstrap container
667         - Configuration Binding Service
668         - Deployment Handler
669         - Policy Handler
670         - Service Change Handler
671         - Inventory API
672     - Service components
673         - VES Collector
674         - SNMP Collector
675         - Threshold Crossing Analytics
676         - Holmes Rule Management *
677         - Holmes Engine Management *
678     - Additional resources that DCAE utilizes:
679         - Postgres Database
680         - Redis Cluster Database
681         - Consul Cluster
682
683     Notes:
684         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
685
686 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
687
688     - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
689     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
690
691 - DCAE R2 includes a new Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
692
693 - All DCAE components are designed to support platform maturity requirements.
694
695
696 **Source Code**
697
698 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
699     - dcaegen2
700     - dcaegen2.analytics
701     - dcaegen2.analytics.tca
702     - dcaegen2.collectors
703     - dcaegen2.collectors.snmptrap
704     - dcaegen2.collectors.ves
705     - dcaegen2.deployments
706     - dcaegen2.platform
707     - dcaegen2.platform.blueprints
708     - dcaegen2.platform.cli
709     - dcaegen2.platform.configbinding
710     - dcaegen2.platform.deployment-handler
711     - dcaegen2.platform.inventory-api
712     - dcaegen2.platform.plugins
713     - dcaegen2.platform.policy-handler
714     - dcaegen2.platform.servicechange-handler
715     - dcaegen2.services.heartbeat
716     - dcaegen2.services.mapper
717     - dcaegen2.services.prh
718     - dcaegen2.utils
719
720 **Bug Fixes**
721
722 **Known Issues**
723
724 - DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine.  Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image.  DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
725
726 **Security Notes**
727
728 DCAE 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 DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
729
730 Quick Links:
731         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
732
733         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
734
735         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
736
737
738
739 **Upgrade Notes**
740
741 The following components are upgraded from R1:
742     - Cloudify Manager:
743        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
744        - Description: R2 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
745     - Bootstrap container:
746        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
747        - Description: R2 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications.  The bootstrap is for OOM (Kubernetes) based deployment.
748     - Configuration Binding Service:
749        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
750        - Description: Configuration Binding Sevice now supports the new configuration policy format.
751     - Deployment Handler
752        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
753     - Policy Handler
754        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
755        - Description: Policy Handler now supports the new configuration policy format.
756     - Service Change Handler
757        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
758        - Description: Refactoring.
759     - Inventory API
760        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
761        - Description: Refactoring.
762     - VES Collector
763        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
764     - Threshold Crossing Analytics
765        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
766        - Description: Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
767
768
769
770 Version: 1.0.0
771 --------------
772
773 :Release Date: 2017-11-16
774
775
776 **New Features**
777
778 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
779 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
780 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
781 vDNS, vCPU, and vVoLTE.
782
783 Specifically, DCAE R1 includes the following components:
784
785 - Core platform
786     - Cloudify manager
787     - Consul cluster
788 - Extended platform
789     - Platform component docker host
790     - Service component docker host
791     - CDAP cluster
792     - PostgreSQL database (*)
793 - Platform docker container components
794     - Configuration binding service
795     - Deployment handler
796     - Service change handler
797     - Inventory
798     - Policy handler
799     - CDAP broker
800 - Service components
801     - Docker container components
802         - VNF Event Streaming (VES) collector
803         - Holmes (engine and rule management) **
804     - CDAP analytics component
805         - Threshold Crossing Analytics (TCA)
806
807 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
808 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
809 other deployment configurations not used in the R1 demos.)
810 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
811 in R1.
812
813 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
814
815 - dcaegen2
816 - dcaegen2/analytics
817 - dcaegen2/analytics/tca
818 - dcaegen2/collectors
819 - dcaegen2/collectors/snmptrap
820 - dcaegen2/collectors/ves
821 - dcaegen2/deployments
822 - dcaegen2/platform
823 - dcaegen2/platform/blueprints
824 - dcaegen2/platform/cdapbroker
825 - dcaegen2/platform/cli
826 - dcaegen2/platform/configbinding
827 - dcaegen2/platform/deployment-handler
828 - dcaegen2/platform/inventory-api
829 - dcaegen2/platform/plugins
830 - dcaegen2/platform/policy-handler
831 - dcaegen2/platform/servicechange-handler
832 - dcaegen2/utils
833
834
835 **Bug Fixes**
836
837 This is the initial release.
838
839
840 **Known Issues**
841
842 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
843 - Need to provide a dev configuration DCAE.
844
845
846 **Security Issues**
847
848 - The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches.  This key is currently passed in as a Heat template parameter.  Tracked by JIRA `DCAEGEN2-178 <https://jira.onap.org/browse/DCAEGEN2-178>`_.>`_.
849 - The RESTful API calls are generally not secure.  That is, they are either over http, or https without certificate verification.  Once there is an ONAP wide solution for handling certificates, DCAE will switch to https.
850
851
852 **Upgrade Notes**
853
854 This is the initial release.
855
856
857 **Deprecation Notes**
858
859 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
860 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
861 following Gerrit repos are voided and already locked as read-only.
862
863 - dcae
864 - dcae/apod
865 - dcae/apod/analytics
866 - dcae/apod/buildtools
867 - dcae/apod/cdap
868 - dcae/collectors
869 - dcae/collectors/ves
870 - dcae/controller
871 - dcae/controller/analytics
872 - dcae/dcae-inventory
873 - dcae/demo
874 - dcae/demo/startup
875 - dcae/demo/startup/aaf
876 - dcae/demo/startup/controller
877 - dcae/demo/startup/message-router
878 - dcae/dmaapbc
879 - dcae/operation
880 - dcae/operation/utils
881 - dcae/orch-dispatcher
882 - dcae/pgaas
883 - dcae/utils
884 - dcae/utils/buildtools
885 - ncomp
886 - ncomp/cdap
887 - ncomp/core
888 - ncomp/docker
889 - ncomp/maven
890 - ncomp/openstack
891 - ncomp/sirius
892 - ncomp/sirius/manager
893 - ncomp/utils
894
895
896 **Other**
897
898 SNMP trap collector is seed code delivery only.