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