Merge "Align to new rls template"
[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-2020 AT&T Intellectual Property. All rights reserved.
4 .. _release_notes:
5
6
7
8 ==================
9 DCAE Release Notes
10 ==================
11
12 .. contents::
13     :depth: 2
14 ..
15
16 ..      ===========================
17 ..      * * *    FRANKFURT    * * *
18 ..      ===========================
19
20
21 Version: 6.0.0
22 ==============
23
24
25 Abstract
26 --------
27
28 This document provides the release notes for the Frankfurt release.
29
30 Summary
31 -------
32
33 Following DCAE components are available with default ONAP/DCAE installation.
34
35     - Platform components
36
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 chart)
45
46     - Service components
47
48         - VES Collector
49         - Threshold Crossing Analytics (TCA/CDAP)
50         - HV-VES Collector
51         - PNF-Registration Handler
52         - Docker based Threshold Crossing Analytics (TCA-Gen2)
53         - Holmes Rule Management *
54         - Holmes Engine Management *
55
56     - Additional resources that DCAE utilizes deployed using ONAP common charts:
57     
58         - Postgres Database
59         - Mongo Database
60         - Redis Cluster Database
61         - Consul Cluster 
62
63 Below service components (mS) are available to be deployed on-demand.
64
65         - SNMPTrap Collector
66         - RESTConf Collector
67         - DataFile Collector
68         - PM-Mapper 
69         - BBS-EventProcessor
70         - VES Mapper
71         - Heartbeat mS
72         - SON-Handler
73         - PM-Subscription Handler
74
75     Notes:
76
77         \*  These components are delivered by the Holmes project.
78
79
80
81 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
82
83
84 Release Data
85 ------------
86
87 +--------------------------------------+--------------------------------------------------------+
88 | **DCAE Project**                     |                                                        |
89 |                                      |                                                        |
90 +--------------------------------------+--------------------------------------------------------+
91 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
92 |                                      |                                                        |
93 +--------------------------------------+--------------------------------------------------------+
94 | **Release designation**              | 6.0.0 frankfurt                                        |
95 |                                      |                                                        |
96 +--------------------------------------+--------------------------------------------------------+
97 | **Release date**                     | 2020-06-04                                             |
98 |                                      |                                                        |
99 +--------------------------------------+--------------------------------------------------------+
100
101
102 New features
103 ------------
104
105 - DCAE Platform Enhancement
106
107     - Introduction of Microservice and Onboarding Design (MOD) platform 
108     - Policy Notification support for DCAE components
109     - Dynamic AAF certificate creation during component instantiation
110     - Helm chart optimization to control each platform component separate
111     - Dashboard Optimization 
112     - Blueprint generator tool to simplify deployment artifact creation
113    
114
115 - Following new services are delivered this release
116
117     - Event Processors
118     
119         - PM Subscription Handler
120         - DataLake Handlers 
121     - Analytics/RCA
122     
123         - TCA-GEN2
124         
125         - Acumos Adapter (PoC)
126
127 .. _frankfurt_deliverable:
128
129 Deliverables
130 ------------
131
132 Software Deliverables
133
134 .. csv-table::
135    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
136    :widths: auto
137
138    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
139    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
140    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
141    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
142    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
143    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
144    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
145    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
146    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
147    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
148    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
149    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
150    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
151    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
152    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
153    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
154    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
155    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
156    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
157    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
158    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
159    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6" 
160    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
161    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
162    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"  
163    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
164    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
165    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
166    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
167    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
168    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
169    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
170    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
171    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
172    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
173    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
174    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
175    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
176    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
177    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
178         
179
180 Known Limitations, Issues and Workarounds
181 -----------------------------------------
182
183     * Blueprint generator escape char issue (DCAEGEN2-2140)
184     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
185     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
186
187
188
189 *System Limitations*
190
191 None
192
193 *Known Vulnerabilities*
194
195 None
196
197 *Workarounds*
198
199 Documented under corresponding jira if applicable.
200
201 Security Notes
202 --------------
203
204 *Fixed Security Issues*
205
206     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
207     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
208     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
209     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
210     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
211
212     
213 *Known Security Issues*
214
215         None
216         
217         
218 *Known Vulnerabilities in Used Modules*
219
220         None
221         
222 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>`_.
223
224 Test Results
225 ------------
226
227  - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
228  - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
229
230
231 References
232 ----------
233
234 For more information on the ONAP Frankfurt release, please see:
235
236 #. `ONAP Home Page`_
237 #. `ONAP Documentation`_
238 #. `ONAP Release Downloads`_
239 #. `ONAP Wiki Page`_
240
241
242 .. _`ONAP Home Page`: https://www.onap.org
243 .. _`ONAP Wiki Page`: https://wiki.onap.org
244 .. _`ONAP Documentation`: https://docs.onap.org
245 .. _`ONAP Release Downloads`: https://git.onap.org
246
247 Quick Links:
248
249         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
250         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
251
252
253 ..      =========================
254 ..      * * *    EL-ALTO    * * *
255 ..      =========================
256
257
258 Version: 5.0.1
259 ==============
260
261 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
262
263 Following is summary of updates done for DCAEGEN2
264
265 **Security**
266
267 Following platform components were enabled for HTTPS
268     - ConfigBindingService (CBS)
269       -   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>`_
270     - Cloudify Manager
271     - InventoryAPI
272     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
273
274 All components interfacing with platform components were modified to support TLS interface
275
276 **Miscellaneous**
277     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
278     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
279     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
280     - CBS client libraries updated to remove consul service lookup
281     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
282
283
284
285 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.
286     - Platform components
287         - Cloudify Manager (helm chart)
288         - Bootstrap container (helm chart)
289         - Configuration Binding Service (helm chart)
290         - Deployment Handler (helm chart)
291         - Policy Handler (helm chart
292         - Service Change Handler (helm chart)
293         - Inventory API (helm chart)
294         - Dashboard (helm charts)
295     - Service components
296         - VES Collector
297         - SNMP Collector
298         - Threshold Crossing Analytics
299         - HV-VES Collector
300         - PNF-Registration Handler
301         - Holmes Rule Management *
302         - Holmes Engine Management *
303     - Additional resources that DCAE utilizes:
304         - Postgres Database
305         - Redis Cluster Database
306         - Consul Cluster *
307
308     Notes:
309         \*  These components are delivered by external ONAP project.
310
311 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
312
313     - Collectors
314         - RESTConf collector 
315         - DataFile collector
316     - Event Processors
317         - VES Mapper
318         - 3gpp PM-Mapper
319         - BBS Event processor
320     - Analytics/RCA
321         - SON-Handler
322         - Missing Heartbeat Ms
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; there is no new component introduced for El-Alto Early-drop.
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     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
359     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
360
361
362 **Known Issues**
363     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
364
365 **Security Notes**
366
367 *Fixed Security Issues*
368     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
369     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
370     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
371     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
372     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
373
374 *Known Security Issues*
375     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
376     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
377     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
378     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
379     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
380
381 *Known Vulnerabilities in Used Modules*
382
383 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>`_.
384
385 Quick Links:
386         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
387
388         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
389
390         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
391
392
393 **Upgrade Notes**
394
395 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
396     - K8S Bootstrap container:
397        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
398        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
399     - Configuration Binding Service:
400        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
401        - Description: HTTPS support, Image optimization and non-root user
402     - Inventory API
403        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
404        - Description: HTTPS support, container optmization and non-root user
405     - DataFile Collector
406        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
407        - Description : Code optimization, bug fixes, dmaap plugin integration
408     - SON Handler MS
409        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
410        - Description : Image optimization, bug fixes, CBS integration
411     - VES Adapter/Mapper MS
412        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
413        - Description : Image optimization & CBS periodic polling
414     - PRH MS
415        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
416        - Description : Code optimization, bug fixes and SDK alignment
417     - HV-VES MS
418        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
419        - Description : Code optimization, bug fixes and SDK alignment
420
421 Version: 5.0.0
422 ==============
423
424 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
425
426 Following is summary of updates done for DCAEGEN2
427
428 **Security**
429
430 Following platform components were enabled for HTTPS
431     - ConfigBindingService (CBS)
432       -   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>`_
433     - Cloudify Manager
434     - InventoryAPI
435
436 All components interfacing with platform components were modified to support TLS interface
437
438 **Miscellaneous**
439     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
440     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
441     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
442     - CBS client libraries updated to remove consul service lookup
443
444
445
446 **Bug Fixes**
447     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
448     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
449
450
451 **Known Issues**
452     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
453
454
455 **Security Notes**
456
457 *Fixed Security Issues*
458
459 *Known Security Issues*
460
461     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
462     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
463     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
464     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
465     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
466     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
467     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
468     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
469     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
470     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
471
472 *Known Vulnerabilities in Used Modules*
473
474 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>`_.
475
476 Quick Links:
477         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
478
479         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
480
481         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
482
483
484 **Upgrade Notes**
485
486 The following components are upgraded from Dublin/R4.
487     - Cloudify Manager:
488        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
489        - 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.
490     - K8S Bootstrap container:
491        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
492        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
493     - Configuration Binding Service:
494        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
495        - Description: HTTPS support, Image optimization and non-root user
496     - Deployment Handler
497        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
498        - Description: Update to node10, uninstall workflow updates
499     - Service Change Handler
500        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
501        - Description: HTTPS inventoryAPI support, container optmization and non-root user
502     - Inventory API
503        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
504        - Description: HTTPS support, container optmization and non-root user
505     - DataFile Collector
506        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
507        - Description : Code optimization, bug fixes, dmaap plugin integration
508     - 3gpp PM-Mapper
509        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
510        - Description: Code optimization, bug fixes, dmaap plugin integration
511
512
513
514 Version: 4.0.0
515 ==============
516
517 :Release Date: 2019-06-06
518
519 **New Features**
520
521 DCAE R4 improves upon previous release with the following new features:
522
523 - DCAE Platform Enhancement
524     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
525     - Support helm chart deployment in DCAE using new Helm cloudify plugin
526     - DCAE Healthcheck enhancement to cover static and dynamic deployments
527     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
528     - Dashboard Integration (UI for deployment/verification)
529     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
530     - Blueprint generator tool to simplify deployment artifact creation
531     - Cloudify Manager resiliency
532
533 - Following new services are delivered with Dublin
534     - Collectors
535         - RESTConf collector 
536     - Event Processors
537         - VES Mapper
538         - 3gpp PM-Mapper
539         - BBS Event processor
540     - Analytics/RCA
541         - SON-Handler
542         - Heartbeat MS
543
544 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
545     - Platform components
546         - Cloudify Manager (helm chart)
547         - Bootstrap container (helm chart)
548         - Configuration Binding Service (helm chart)
549         - Deployment Handler (helm chart)
550         - Policy Handler (helm chart
551         - Service Change Handler (helm chart)
552         - Inventory API (helm chart)
553         - Dashboard (Cloudify Blueprint)
554     - Service components
555         - VES Collector
556         - SNMP Collector
557         - Threshold Crossing Analytics
558         - HV-VES Collector
559         - PNF-Registration Handler
560         - Holmes Rule Management *
561         - Holmes Engine Management *
562     - Additional resources that DCAE utilizes:
563         - Postgres Database
564         - Redis Cluster Database
565         - Consul Cluster *
566
567     Notes:
568         \*  These components are delivered by the Holmes project.
569
570
571 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.
572
573 - All DCAE components are designed to support platform maturity requirements.
574
575
576 **Source Code**
577
578 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
579     - dcaegen2
580     - dcaegen2.analytics.tca
581     - dcaegen2.collectors.snmptrap
582     - dcaegen2.collectors.ves
583     - dcaegen2.collectors.hv-ves
584     - dcaegen2.collectors.datafile
585     - dcaegen2.collectors.restconf
586     - dcaegen2.deployments
587     - dcaegen2.platform.blueprints
588     - dcaegen2.platform.cli
589     - dcaegen2.platform.configbinding
590     - dcaegen2.platform.deployment-handler
591     - dcaegen2.platform.inventory-api
592     - dcaegen2.platform.plugins
593     - dcaegen2.platform.policy-handler
594     - dcaegen2.platform.servicechange-handler
595     - dcaegen2.services.heartbeat
596     - dcaegen2.services.mapper
597     - dcaegen2.services.pm-mapper
598     - dcaegen2.services.prh
599     - dcaegen2.services.son-handler
600     - dcaegen2.services
601     - dcaegen2.services.sdk
602     - dcaegen2.utils
603     - ccsdk.platform.plugins
604     - ccsdk.dashboard
605
606 **Bug Fixes**
607
608 **Known Issues**
609     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
610
611
612 **Security Notes**
613
614 *Fixed Security Issues*
615
616 *Known Security Issues*
617
618     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
619     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
620     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
621     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
622     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
623     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
624     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
625     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
626     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
627     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
628
629 *Known Vulnerabilities in Used Modules*
630
631 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>`_.
632
633 Quick Links:
634         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
635
636         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
637
638         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
639
640
641 **New component Notes**
642 The following components are introduced in R4
643
644     - Dashboard
645        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
646        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
647     - Blueprint generator
648        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
649        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
650     - RESTConf collector 
651        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
652        - Description: Provides RESTConf interfaces to events from external domain controllers
653     - VES/Universal Mapper
654        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
655        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
656     - 3gpp PM-Mapper
657        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
658        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
659     - BBS Event processor
660        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
661        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
662     - SON-Handler
663        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
664        - Description: Supports PC-ANR optimization analysis and generating CL events output
665     - Heartbeat MS
666        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
667        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
668
669
670 **Upgrade Notes**
671
672 The following components are upgraded from R3
673     - Cloudify Manager:
674        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
675        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
676     - K8S Bootstrap container:
677        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
678        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
679     - Configuration Binding Service:
680        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
681        - Description: Code optimization and bug fixes
682     - Deployment Handler
683        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
684        - Include updates for health and service endpoint check and bug fixes
685     - Policy Handler
686        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
687        - Description: Policy Handler supports the new lifecycle API's from Policy framework
688     - Service Change Handler
689        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
690        - Description: No update from R3
691     - Inventory API
692        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
693        - Description: Refactoring and updates for health and service endpoint check
694     - VES Collector
695        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
696        - Description : Authentication enhancement, refactoring and bug-fixes
697     - Threshold Crossing Analytics
698        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
699        - 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.
700     - DataFile Collector
701        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
702        - Description : Code optimization, bug fixes, logging and performance improvement
703     - PNF Registrator handler
704        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
705        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
706     - HV-VES Collector
707        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
708        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
709     - SNMP Trap Collector
710        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
711        - Description : Code coverage improvements
712
713
714
715
716 Version: 3.0.1
717 ==============
718
719 :Release Date: 2019-01-31
720
721 DCAE R3 Maintenance release includes following fixes
722
723 **Bug Fixes**
724
725 - DataFileCollector
726      - DCAEGEN2-940
727        Larger files of size 100Kb publish to DR
728      - DCAEGEN2-941
729        DFC error after running over 12 hours
730      - DCAEGEN2-1001
731        Multiple Fileready notification not handled
732
733 - HighVolume VES Collector (protobuf/tcp)
734      - DCAEGEN2-976
735        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
736
737 - VESCollector (http)
738      - DCAEGEN2-1035
739        Issue with VES batch event publish
740
741 - Heat deployment
742      - DCAEGEN2-1007
743        Removing obsolete services configuration
744
745
746 The following containers are updated in R3.0.1
747
748     - DataFile Collector
749        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
750     - HV-VES Collector
751        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
752     - VES Collector
753        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
754
755 **Known Issues**
756
757 - 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
758
759 - 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
760     kubectl get deployments -n onap | grep deployment-handler
761     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
762     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
763
764
765
766
767 Version: 3.0.0
768 --------------
769
770 :Release Date: 2018-11-30
771
772 **New Features**
773
774 DCAE R3 improves upon previous release with the following new features:
775
776 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
777     - Platform components
778         - Cloudify Manager
779         - Bootstrap container
780         - Configuration Binding Service
781         - Deployment Handler
782         - Policy Handler
783         - Service Change Handler
784         - Inventory API
785     - Service components
786         - VES Collector
787         - SNMP Collector
788         - Threshold Crossing Analytics
789         - Holmes Rule Management *
790         - Holmes Engine Management *
791     - Additional resources that DCAE utilizes:
792         - Postgres Database
793         - Redis Cluster Database
794         - Consul Cluster
795
796     Notes:
797         \*  These components are delivered by the Holmes project.
798
799 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
800
801     - 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".
802     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
803
804 - 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.
805
806 - All DCAE components are designed to support platform maturity requirements.
807
808
809 **Source Code**
810
811 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
812     - dcaegen2
813     - dcaegen2.analytics
814     - dcaegen2.analytics.tca
815     - dcaegen2.collectors
816     - dcaegen2.collectors.snmptrap
817     - dcaegen2.collectors.ves
818     - dcaegen2.collectors.hv-ves
819     - dcaegen2.collectors.datafile
820     - dcaegen2.deployments
821     - dcaegen2.platform
822     - dcaegen2.platform.blueprints
823     - dcaegen2.platform.cli
824     - dcaegen2.platform.configbinding
825     - dcaegen2.platform.deployment-handler
826     - dcaegen2.platform.inventory-api
827     - dcaegen2.platform.plugins
828     - dcaegen2.platform.policy-handler
829     - dcaegen2.platform.servicechange-handler
830     - dcaegen2.services.heartbeat
831     - dcaegen2.services.mapper
832     - dcaegen2.services.prh
833     - dcaegen2.utils
834
835 **Bug Fixes**
836
837 **Known Issues**
838
839 - 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.
840
841 **Security Notes**
842
843 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>`_.
844
845 Quick Links:
846         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
847
848         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
849
850         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
851
852
853 **New component Notes**
854 The following components are introduced in R3
855
856     - DataFile Collector
857        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
858        - Description : Bulk data file collector to fetch non-realtime PM data
859     - PNF Registrator handler
860        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
861        - Description : Recieves VES registration event and updates AAI and SO
862     - HV-VES Collector
863        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
864        - Description : High Volume VES Collector for fetching real-time PM measurement data
865     - SNMP Trap Collector
866        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
867        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
868
869
870 **Upgrade Notes**
871
872 The following components are upgraded from R2:
873     - Cloudify Manager:
874        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
875        - 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.
876     - Bootstrap container:
877        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
878        - 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.
879     - Configuration Binding Service:
880        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
881        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
882     - Deployment Handler
883        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
884     - Policy Handler
885        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
886        - Description: Policy Handler now supports the new configuration policy format and support for TLS
887     - Service Change Handler
888        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
889        - Description: Refactoring.
890     - Inventory API
891        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
892        - Description: Refactoring.
893     - VES Collector
894        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
895        - Description : Refactoring
896     - Threshold Crossing Analytics
897        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
898        - 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.
899
900
901
902
903 Version: 2.0.0
904 ==============
905
906 :Release Date: 2018-06-07
907
908 **New Features**
909
910 DCAE R2 improves upon previous release with the following new features:
911
912 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
913     - Platform components
914         - Cloudify Manager
915         - Bootstrap container
916         - Configuration Binding Service
917         - Deployment Handler
918         - Policy Handler
919         - Service Change Handler
920         - Inventory API
921     - Service components
922         - VES Collector
923         - SNMP Collector
924         - Threshold Crossing Analytics
925         - Holmes Rule Management *
926         - Holmes Engine Management *
927     - Additional resources that DCAE utilizes:
928         - Postgres Database
929         - Redis Cluster Database
930         - Consul Cluster
931
932     Notes:
933         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
934
935 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
936
937     - 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".
938     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
939
940 - 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.
941
942 - All DCAE components are designed to support platform maturity requirements.
943
944
945 **Source Code**
946
947 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
948     - dcaegen2
949     - dcaegen2.analytics
950     - dcaegen2.analytics.tca
951     - dcaegen2.collectors
952     - dcaegen2.collectors.snmptrap
953     - dcaegen2.collectors.ves
954     - dcaegen2.deployments
955     - dcaegen2.platform
956     - dcaegen2.platform.blueprints
957     - dcaegen2.platform.cli
958     - dcaegen2.platform.configbinding
959     - dcaegen2.platform.deployment-handler
960     - dcaegen2.platform.inventory-api
961     - dcaegen2.platform.plugins
962     - dcaegen2.platform.policy-handler
963     - dcaegen2.platform.servicechange-handler
964     - dcaegen2.services.heartbeat
965     - dcaegen2.services.mapper
966     - dcaegen2.services.prh
967     - dcaegen2.utils
968
969 **Bug Fixes**
970
971 **Known Issues**
972
973 - 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.
974
975 **Security Notes**
976
977 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>`_.
978
979 Quick Links:
980         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
981
982         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
983
984         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
985
986
987
988 **Upgrade Notes**
989
990 The following components are upgraded from R1:
991     - Cloudify Manager:
992        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
993        - 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.
994     - Bootstrap container:
995        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
996        - 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.
997     - Configuration Binding Service:
998        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
999        - Description: Configuration Binding Sevice now supports the new configuration policy format.
1000     - Deployment Handler
1001        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
1002     - Policy Handler
1003        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
1004        - Description: Policy Handler now supports the new configuration policy format.
1005     - Service Change Handler
1006        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
1007        - Description: Refactoring.
1008     - Inventory API
1009        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
1010        - Description: Refactoring.
1011     - VES Collector
1012        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
1013     - Threshold Crossing Analytics
1014        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1015        - 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.
1016
1017
1018
1019 Version: 1.0.0
1020 ==============
1021
1022 :Release Date: 2017-11-16
1023
1024
1025 **New Features**
1026
1027 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
1028 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
1029 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
1030 vDNS, vCPU, and vVoLTE.
1031
1032 Specifically, DCAE R1 includes the following components:
1033
1034 - Core platform
1035     - Cloudify manager
1036     - Consul cluster
1037 - Extended platform
1038     - Platform component docker host
1039     - Service component docker host
1040     - CDAP cluster
1041     - PostgreSQL database (*)
1042 - Platform docker container components
1043     - Configuration binding service
1044     - Deployment handler
1045     - Service change handler
1046     - Inventory
1047     - Policy handler
1048     - CDAP broker
1049 - Service components
1050     - Docker container components
1051         - VNF Event Streaming (VES) collector
1052         - Holmes (engine and rule management) **
1053     - CDAP analytics component
1054         - Threshold Crossing Analytics (TCA)
1055
1056 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
1057 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
1058 other deployment configurations not used in the R1 demos.)
1059 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
1060 in R1.
1061
1062 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1063
1064 - dcaegen2
1065 - dcaegen2/analytics
1066 - dcaegen2/analytics/tca
1067 - dcaegen2/collectors
1068 - dcaegen2/collectors/snmptrap
1069 - dcaegen2/collectors/ves
1070 - dcaegen2/deployments
1071 - dcaegen2/platform
1072 - dcaegen2/platform/blueprints
1073 - dcaegen2/platform/cdapbroker
1074 - dcaegen2/platform/cli
1075 - dcaegen2/platform/configbinding
1076 - dcaegen2/platform/deployment-handler
1077 - dcaegen2/platform/inventory-api
1078 - dcaegen2/platform/plugins
1079 - dcaegen2/platform/policy-handler
1080 - dcaegen2/platform/servicechange-handler
1081 - dcaegen2/utils
1082
1083
1084 **Bug Fixes**
1085
1086 This is the initial release.
1087
1088
1089 **Known Issues**
1090
1091 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1092 - Need to provide a dev configuration DCAE.
1093
1094
1095 **Security Issues**
1096
1097 - 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>`_.>`_.
1098 - 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.
1099
1100
1101 **Upgrade Notes**
1102
1103 This is the initial release.
1104
1105
1106 **Deprecation Notes**
1107
1108 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
1109 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
1110 following Gerrit repos are voided and already locked as read-only.
1111
1112 - dcae
1113 - dcae/apod
1114 - dcae/apod/analytics
1115 - dcae/apod/buildtools
1116 - dcae/apod/cdap
1117 - dcae/collectors
1118 - dcae/collectors/ves
1119 - dcae/controller
1120 - dcae/controller/analytics
1121 - dcae/dcae-inventory
1122 - dcae/demo
1123 - dcae/demo/startup
1124 - dcae/demo/startup/aaf
1125 - dcae/demo/startup/controller
1126 - dcae/demo/startup/message-router
1127 - dcae/dmaapbc
1128 - dcae/operation
1129 - dcae/operation/utils
1130 - dcae/orch-dispatcher
1131 - dcae/pgaas
1132 - dcae/utils
1133 - dcae/utils/buildtools
1134 - ncomp
1135 - ncomp/cdap
1136 - ncomp/core
1137 - ncomp/docker
1138 - ncomp/maven
1139 - ncomp/openstack
1140 - ncomp/sirius
1141 - ncomp/sirius/manager
1142 - ncomp/utils
1143
1144
1145 **Other**
1146
1147 SNMP trap collector is seed code delivery only.