Document OJSI-161 vulnerability
[dcaegen2.git] / docs / sections / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Release Notes
4 =============
5
6 Version: 4.0.0
7 --------------
8
9 :Release Date: 2019-06-06
10
11 **New Features**
12
13 DCAE R4 improves upon previous release with the following new features:
14
15 - DCAE Platform Enhancement
16     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
17     - Support helm chart deployment in DCAE using new Helm cloudify plugin
18     - DCAE Healthcheck enhancement to cover static and dynamic deployments
19     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
20     - Dashboard Integration (UI for deployment/verification)
21     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
22     - Blueprint generator tool to simplify deployment artifact creation
23     - Cloudify Manager resiliency
24
25 - Following new services are delivered with Dublin
26     - Collectors
27         - RESTConf collector 
28     - Event Processors
29         - VES Mapper
30         - 3gpp PM-Mapper
31         - BBS Event processor
32     - Analytics/RCA
33         - SON-Handler
34         - Heartbeat MS
35
36 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
37     - Platform components
38         - Cloudify Manager (helm chart)
39         - Bootstrap container (helm chart)
40         - Configuration Binding Service (helm chart)
41         - Deployment Handler (helm chart)
42         - Policy Handler (helm chart
43         - Service Change Handler (helm chart)
44         - Inventory API (helm chart)
45         - Dashboard (Cloudify Blueprint)
46     - Service components
47         - VES Collector
48         - SNMP Collector
49         - Threshold Crossing Analytics
50         - HV-VES Collector
51         - PNF-Registration Handler
52         - Holmes Rule Management *
53         - Holmes Engine Management *
54     - Additional resources that DCAE utilizes:
55         - Postgres Database
56         - Redis Cluster Database
57         - Consul Cluster *
58
59     Notes:
60         \*  These components are delivered by the Holmes project.
61
62
63 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.
64
65 - All DCAE components are designed to support platform maturity requirements.
66
67
68 **Source Code**
69
70 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
71     - dcaegen2
72     - dcaegen2.analytics.tca
73     - dcaegen2.collectors.snmptrap
74     - dcaegen2.collectors.ves
75     - dcaegen2.collectors.hv-ves
76     - dcaegen2.collectors.datafile
77     - dcaegen2.collectors.restconf
78     - dcaegen2.deployments
79     - dcaegen2.platform.blueprints
80     - dcaegen2.platform.cli
81     - dcaegen2.platform.configbinding
82     - dcaegen2.platform.deployment-handler
83     - dcaegen2.platform.inventory-api
84     - dcaegen2.platform.plugins
85     - dcaegen2.platform.policy-handler
86     - dcaegen2.platform.servicechange-handler
87     - dcaegen2.services.heartbeat
88     - dcaegen2.services.mapper
89     - dcaegen2.services.pm-mapper
90     - dcaegen2.services.prh
91     - dcaegen2.services.son-handler
92     - dcaegen2.services
93     - dcaegen2.services.sdk
94     - dcaegen2.utils
95     - ccsdk.platform.plugins
96     - ccsdk.dashboard
97
98 **Bug Fixes**
99
100 **Known Issues**
101
102 **Security Notes**
103
104 *Fixed Security Issues*
105
106 *Known Security Issues*
107
108     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
109     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
110     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
111     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
112     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
113
114 *Known Vulnerabilities in Used Modules*
115
116 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>`_.
117
118 Quick Links:
119         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
120
121         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
122
123         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
124
125
126 **New component Notes**
127 The following components are introduced in R4
128
129     - Dashboard
130        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
131        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
132     - Blueprint generator
133        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
134        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
135     - RESTConf collector 
136        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
137        - Description: Provides RESTConf interfaces to events from external domain controllers
138     - VES/Universal Mapper
139        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
140        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
141     - 3gpp PM-Mapper
142        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
143        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
144     - BBS Event processor
145        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
146        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
147     - SON-Handler
148        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2
149        - Description: Supports PC-ANR optimization analysis and generating CL events output
150     - Heartbeat MS
151        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
152        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
153
154
155 **Upgrade Notes**
156
157 The following components are upgraded from R3
158     - Cloudify Manager:
159        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
160        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
161     - K8S Bootstrap container:
162        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
163        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
164     - Configuration Binding Service:
165        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
166        - Description: Code optimization and bug fixes
167     - Deployment Handler
168        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
169        - Include updates for health and service endpoint check and bug fixes
170     - Policy Handler
171        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
172        - Description: Policy Handler supports the new lifecycle API's from Policy framework
173     - Service Change Handler
174        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
175        - Description: No update from R3
176     - Inventory API
177        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
178        - Description: Refactoring and updates for health and service endpoint check
179     - VES Collector
180        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4
181        - Description : Authentication enhancement, refactoring and bug-fixes
182     - Threshold Crossing Analytics
183        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
184        - 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.
185     - DataFile Collector
186        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
187        - Description : Code optimization, bug fixes, logging and performance improvement
188     - PNF Registrator handler
189        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3
190        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
191     - HV-VES Collector
192        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
193        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
194     - SNMP Trap Collector
195        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
196        - Description : Code coverage improvements
197
198
199
200
201 Version: 3.0.1
202 --------------
203
204 :Release Date: 2019-01-31
205
206 DCAE R3 Maintenance release includes following fixes
207
208 **Bug Fixes**
209
210 - DataFileCollector
211      - DCAEGEN2-940
212        Larger files of size 100Kb publish to DR
213      - DCAEGEN2-941
214        DFC error after running over 12 hours
215      - DCAEGEN2-1001
216        Multiple Fileready notification not handled
217
218 - HighVolume VES Collector (protobuf/tcp)
219      - DCAEGEN2-976
220        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
221
222 - VESCollector (http)
223      - DCAEGEN2-1035
224        Issue with VES batch event publish
225
226 - Heat deployment
227      - DCAEGEN2-1007
228        Removing obsolete services configuration
229
230
231 The following containers are updated in R3.0.1
232
233     - DataFile Collector
234        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
235     - HV-VES Collector
236        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
237     - VES Collector
238        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
239
240 **Known Issues**
241
242 - 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
243
244 - 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
245     kubectl get deployments -n onap | grep deployment-handler
246     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
247     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
248
249
250
251
252 Version: 3.0.0
253 --------------
254
255 :Release Date: 2018-11-30
256
257 **New Features**
258
259 DCAE R3 improves upon previous release with the following new features:
260
261 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
262     - Platform components
263         - Cloudify Manager
264         - Bootstrap container
265         - Configuration Binding Service
266         - Deployment Handler
267         - Policy Handler
268         - Service Change Handler
269         - Inventory API
270     - Service components
271         - VES Collector
272         - SNMP Collector
273         - Threshold Crossing Analytics
274         - Holmes Rule Management *
275         - Holmes Engine Management *
276     - Additional resources that DCAE utilizes:
277         - Postgres Database
278         - Redis Cluster Database
279         - Consul Cluster
280
281     Notes:
282         \*  These components are delivered by the Holmes project.
283
284 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
285
286     - 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".
287     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
288
289 - 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.
290
291 - All DCAE components are designed to support platform maturity requirements.
292
293
294 **Source Code**
295
296 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
297     - dcaegen2
298     - dcaegen2.analytics
299     - dcaegen2.analytics.tca
300     - dcaegen2.collectors
301     - dcaegen2.collectors.snmptrap
302     - dcaegen2.collectors.ves
303     - dcaegen2.collectors.hv-ves
304     - dcaegen2.collectors.datafile
305     - dcaegen2.deployments
306     - dcaegen2.platform
307     - dcaegen2.platform.blueprints
308     - dcaegen2.platform.cli
309     - dcaegen2.platform.configbinding
310     - dcaegen2.platform.deployment-handler
311     - dcaegen2.platform.inventory-api
312     - dcaegen2.platform.plugins
313     - dcaegen2.platform.policy-handler
314     - dcaegen2.platform.servicechange-handler
315     - dcaegen2.services.heartbeat
316     - dcaegen2.services.mapper
317     - dcaegen2.services.prh
318     - dcaegen2.utils
319
320 **Bug Fixes**
321
322 **Known Issues**
323
324 - 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.
325
326 **Security Notes**
327
328 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>`_.
329
330 Quick Links:
331         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
332
333         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
334
335         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
336
337
338 **New component Notes**
339 The following components are introduced in R3
340
341     - DataFile Collector
342        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
343        - Description : Bulk data file collector to fetch non-realtime PM data
344     - PNF Registrator handler
345        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
346        - Description : Recieves VES registration event and updates AAI and SO
347     - HV-VES Collector
348        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
349        - Description : High Volume VES Collector for fetching real-time PM measurement data
350     - SNMP Trap Collector
351        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
352        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
353
354
355 **Upgrade Notes**
356
357 The following components are upgraded from R2:
358     - Cloudify Manager:
359        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
360        - 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.
361     - Bootstrap container:
362        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
363        - 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.
364     - Configuration Binding Service:
365        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
366        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
367     - Deployment Handler
368        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
369     - Policy Handler
370        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
371        - Description: Policy Handler now supports the new configuration policy format and support for TLS
372     - Service Change Handler
373        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
374        - Description: Refactoring.
375     - Inventory API
376        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
377        - Description: Refactoring.
378     - VES Collector
379        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
380        - Description : Refactoring
381     - Threshold Crossing Analytics
382        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
383        - 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.
384
385
386
387
388 Version: 2.0.0
389 --------------
390
391 :Release Date: 2018-06-07
392
393 **New Features**
394
395 DCAE R2 improves upon previous release with the following new features:
396
397 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
398     - Platform components
399         - Cloudify Manager
400         - Bootstrap container
401         - Configuration Binding Service
402         - Deployment Handler
403         - Policy Handler
404         - Service Change Handler
405         - Inventory API
406     - Service components
407         - VES Collector
408         - SNMP Collector
409         - Threshold Crossing Analytics
410         - Holmes Rule Management *
411         - Holmes Engine Management *
412     - Additional resources that DCAE utilizes:
413         - Postgres Database
414         - Redis Cluster Database
415         - Consul Cluster
416
417     Notes:
418         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
419
420 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
421
422     - 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".
423     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
424
425 - 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.
426
427 - All DCAE components are designed to support platform maturity requirements.
428
429
430 **Source Code**
431
432 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
433     - dcaegen2
434     - dcaegen2.analytics
435     - dcaegen2.analytics.tca
436     - dcaegen2.collectors
437     - dcaegen2.collectors.snmptrap
438     - dcaegen2.collectors.ves
439     - dcaegen2.deployments
440     - dcaegen2.platform
441     - dcaegen2.platform.blueprints
442     - dcaegen2.platform.cli
443     - dcaegen2.platform.configbinding
444     - dcaegen2.platform.deployment-handler
445     - dcaegen2.platform.inventory-api
446     - dcaegen2.platform.plugins
447     - dcaegen2.platform.policy-handler
448     - dcaegen2.platform.servicechange-handler
449     - dcaegen2.services.heartbeat
450     - dcaegen2.services.mapper
451     - dcaegen2.services.prh
452     - dcaegen2.utils
453
454 **Bug Fixes**
455
456 **Known Issues**
457
458 - 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.
459
460 **Security Notes**
461
462 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>`_.
463
464 Quick Links:
465         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
466
467         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
468
469         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
470
471
472
473 **Upgrade Notes**
474
475 The following components are upgraded from R1:
476     - Cloudify Manager:
477        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
478        - 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.
479     - Bootstrap container:
480        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
481        - 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.
482     - Configuration Binding Service:
483        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
484        - Description: Configuration Binding Sevice now supports the new configuration policy format.
485     - Deployment Handler
486        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
487     - Policy Handler
488        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
489        - Description: Policy Handler now supports the new configuration policy format.
490     - Service Change Handler
491        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
492        - Description: Refactoring.
493     - Inventory API
494        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
495        - Description: Refactoring.
496     - VES Collector
497        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
498     - Threshold Crossing Analytics
499        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
500        - 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.
501
502
503
504 Version: 1.0.0
505 --------------
506
507 :Release Date: 2017-11-16
508
509
510 **New Features**
511
512 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
513 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
514 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
515 vDNS, vCPU, and vVoLTE.
516
517 Specifically, DCAE R1 includes the following components:
518
519 - Core platform
520     - Cloudify manager
521     - Consul cluster
522 - Extended platform
523     - Platform component docker host
524     - Service component docker host
525     - CDAP cluster
526     - PostgreSQL database (*)
527 - Platform docker container components
528     - Configuration binding service
529     - Deployment handler
530     - Service change handler
531     - Inventory
532     - Policy handler
533     - CDAP broker
534 - Service components
535     - Docker container components
536         - VNF Event Streaming (VES) collector
537         - Holmes (engine and rule management) **
538     - CDAP analytics component
539         - Threshold Crossing Analytics (TCA)
540
541 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
542 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
543 other deployment configurations not used in the R1 demos.)
544 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
545 in R1.
546
547 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
548
549 - dcaegen2
550 - dcaegen2/analytics
551 - dcaegen2/analytics/tca
552 - dcaegen2/collectors
553 - dcaegen2/collectors/snmptrap
554 - dcaegen2/collectors/ves
555 - dcaegen2/deployments
556 - dcaegen2/platform
557 - dcaegen2/platform/blueprints
558 - dcaegen2/platform/cdapbroker
559 - dcaegen2/platform/cli
560 - dcaegen2/platform/configbinding
561 - dcaegen2/platform/deployment-handler
562 - dcaegen2/platform/inventory-api
563 - dcaegen2/platform/plugins
564 - dcaegen2/platform/policy-handler
565 - dcaegen2/platform/servicechange-handler
566 - dcaegen2/utils
567
568
569 **Bug Fixes**
570
571 This is the initial release.
572
573
574 **Known Issues**
575
576 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
577 - Need to provide a dev configuration DCAE.
578
579
580 **Security Issues**
581
582 - 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>`_.>`_.
583 - 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.
584
585
586 **Upgrade Notes**
587
588 This is the initial release.
589
590
591 **Deprecation Notes**
592
593 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
594 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
595 following Gerrit repos are voided and already locked as read-only.
596
597 - dcae
598 - dcae/apod
599 - dcae/apod/analytics
600 - dcae/apod/buildtools
601 - dcae/apod/cdap
602 - dcae/collectors
603 - dcae/collectors/ves
604 - dcae/controller
605 - dcae/controller/analytics
606 - dcae/dcae-inventory
607 - dcae/demo
608 - dcae/demo/startup
609 - dcae/demo/startup/aaf
610 - dcae/demo/startup/controller
611 - dcae/demo/startup/message-router
612 - dcae/dmaapbc
613 - dcae/operation
614 - dcae/operation/utils
615 - dcae/orch-dispatcher
616 - dcae/pgaas
617 - dcae/utils
618 - dcae/utils/buildtools
619 - ncomp
620 - ncomp/cdap
621 - ncomp/core
622 - ncomp/docker
623 - ncomp/maven
624 - ncomp/openstack
625 - ncomp/sirius
626 - ncomp/sirius/manager
627 - ncomp/utils
628
629
630 **Other**
631
632 SNMP trap collector is seed code delivery only.