blob: 138038261f01a7fb1b40f064b0877ee61fae3c0c [file] [log] [blame]
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
Vijay VK5e1694c2019-10-09 17:11:04 +01002.. http://creativecommons.org/licenses/by/4.0
VENKATESH KUMARcfb11092020-04-02 12:27:00 -04003.. Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved.
Aric Gardner9fc74a62020-04-09 10:51:40 -07004.. _release_notes:
Lusheng Ji72c4fba2017-10-10 18:12:22 +00005
VENKATESH KUMAR64559742020-04-29 18:53:53 -04006
7
8==================
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -04009DCAE Release Notes
10==================
Lusheng Ji72c4fba2017-10-10 18:12:22 +000011
VENKATESH KUMAR64559742020-04-29 18:53:53 -040012.. contents::
13 :depth: 2
14..
15
VENKATESH KUMARa052dac2020-08-18 17:43:04 -040016
VENKATESH KUMAR647eade2020-10-29 11:30:28 -040017.. ========================
18.. * * * GUILIN * * *
19.. ========================
20
21
22Version: 7.0.0
23==============
24
25
26Abstract
27--------
28
29This document provides the release notes for Guilin release.
30
31Summary
32-------
33
34Following DCAE components are available with default ONAP/DCAE installation.
35
36 - Platform components
37
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 (helm chart)
46
47 - Service components
48
49 - VES Collector
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
63Below 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 - DataLake Handler (Admin and Feeder)
75 - Slice Analysis
VENKATESH KUMARe21c8482020-11-12 15:00:02 -050076 - Data Extraction Service
VENKATESH KUMAR647eade2020-10-29 11:30:28 -040077
78 Notes:
79
80 \* These components are delivered by the Holmes project.
81
82
83
84Under OOM (Kubernetes) 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.
85
86
87Release Data
88------------
89
90+--------------------------------------+--------------------------------------------------------+
91| **DCAE Project** | |
92| | |
93+--------------------------------------+--------------------------------------------------------+
VENKATESH KUMARe21c8482020-11-12 15:00:02 -050094| **Docker images** | Refer :any:`Deliverable <guilin_deliverable>` |
VENKATESH KUMAR647eade2020-10-29 11:30:28 -040095| | |
96+--------------------------------------+--------------------------------------------------------+
97| **Release designation** | 7.0.0 Guilin |
98| | |
99+--------------------------------------+--------------------------------------------------------+
100| **Release date** | 2020-11-19 |
101| | |
102+--------------------------------------+--------------------------------------------------------+
103
104
105New features
106------------
107
108- DCAE Enhancement
109
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500110 - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262)
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400111 - Bootstrap container optimization (DCAEGEN2-1791)
112 - MOD/Runtime – Enable configuration for dynamic topic support (DCAEGEN2-1996)
113 - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221)
114 - DCAE Dashboard UI Optimization and bugfixes (DCAEGEN2-2223, DCAEGEN2-2364,DCAEGEN2-1638,DCAEGEN2-2298, DCAEGEN2-1857)
115 - Blueprint generator tool and K8Splugin enhancement to support External Certificate (DCAEGEN2-2250)
116 - K8S v1.17 support through DCAE Cloudify K8S plugins (DCAEGEN2-2309)
117 - Python 3.8 support enabled for several DCAE components - Heartbeat mS, PMSH mS, MOD/DistriubtorAPI mS, MOD/OnboardingAPI mS, Policy Library (DCAEGEN2-2292)
118 - Java 11 upgrade complete for following modules - RESTConf, PM-Mapper, DFC, VES-Mapper, SON-handler, TCA-gen2, DL-Feeder, InventoryAPI, ServiceChangeHandler, MOD/RuntimeAPI, MOD/Bp-gen (DCAEGEN2-2223)
119 - Hardcoded password removed from OOM charts - Cloudify, Bootstrap, DeploymentHandler, Dashboard; now managed dynamically through K8S secret (DCAEGEN2-1972, DCAEGEN2-1975)
120 - Best practice compliance
121 - STDOUT log compliance for DCAE Containers (DCAEGEN2-2324)
122 - No more than one main process (DCAEGEN2-2327/REQ-365)
123 - Container must crash when failure is noted (DCAEGEN2-2326/REQ-366)
124 - All containers must run as non-root (REQ-362)
125 - Code coverage >55% (DCAEGEN2-2333)
126 - All Vulnerability identified by SECCOM has been resolved (DCAEGEN2-2242)
127
128
129- Following new services are delivered this release
130
131 - Event Processors
132 - DataExposure Service
133
134 - Analytics/RCA
135 - Slice Analysis MS
136
137.. _guilin_deliverable:
138
139Deliverables
140------------
141
142Software Deliverables
143
144.. csv-table::
145 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
146 :widths: auto
147
148 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
149 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.4.3"
150 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
151 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.2"
152 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
153 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.8"
154 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:3.3.4"
155 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
156 "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
157 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
158 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
159 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
160 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.3"
161 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
162 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
163 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
164 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
165 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
166 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.1.1"
167 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.3"
168 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:2.1.8"
169 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
170 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
171 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.1"
172 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
173 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
174 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
175 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
176 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
177 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
178 "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.1"
179 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
180 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
181 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0"
182 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.4.1"
183 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.4"
184 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.2"
185 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.5.2 (jar)"
186 "dcaegen2/services/sdk", "", "DCAE SDK 1.4.3 (jar)"
187 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
188
189
190Known Limitations, Issues and Workarounds
191-----------------------------------------
192
193 * BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
194 * Ves Collector is down because of java heap space (DCAEGEN2-2495)
195
196
197
198*System Limitations*
199
200None
201
202*Known Vulnerabilities*
203
204None
205
206*Workarounds*
207
208Documented under corresponding jira if applicable.
209
210Security Notes
211--------------
212
213*Fixed Security Issues*
214 Listed above
215
216*Known Security Issues*
217
218 None
219
220
221*Known Vulnerabilities in Used Modules*
222
223 None
224
225DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
226
227Test Results
228------------
229
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500230 - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
231 - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400232
233
234References
235----------
236
237For more information on the ONAP Guilin release, please see:
238
239#. `ONAP Home Page`_
240#. `ONAP Documentation`_
241#. `ONAP Release Downloads`_
242#. `ONAP Wiki Page`_
243
244
245.. _`ONAP Home Page`: https://www.onap.org
246.. _`ONAP Wiki Page`: https://wiki.onap.org
247.. _`ONAP Documentation`: https://docs.onap.org
248.. _`ONAP Release Downloads`: https://git.onap.org
249
250Quick Links:
251
252 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
253 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
254
255
256
257
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400258.. ======================================
259.. * * * EL-ALTO MAINTENANCE * * *
260.. ======================================
261
262
263Version: 5.0.2
264==============
265
266Abstract
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500267--------
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400268
269This document provides the release notes for the El-Alto Maintenance release
270
271
272Summary
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500273-------
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400274
275This maintenance release is primarily to update expired certificates
276from original El-Alto released TLS-init container.
277
278This patch is not required for Frankfurt release (and beyond) as certificates are dynamically
279retrieved from AAF at deployment time for all DCAE components.
280
281Release Data
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500282------------
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400283
284+--------------------------------------+--------------------------------------+
285| **Project** | DCAE |
286| | |
287+--------------------------------------+--------------------------------------+
288| **Docker images** | onap/org.onap.dcaegen2.deployments |
289| | .tls-init-container:1.0.4 |
290+--------------------------------------+--------------------------------------+
291| **Release designation** | El-Alto Maintenance Release |
292| | |
293+--------------------------------------+--------------------------------------+
294| **Release date** | 2020/08/24 |
295| | |
296+--------------------------------------+--------------------------------------+
297
298New features
299------------
300
301None
302
303**Bug fixes**
304
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500305- `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400306
307**Known Issues**
308Same as El-Alto Release
309
310
311
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400312.. ======================================
313.. * * * FRANKFURT MAINTENANCE * * *
314.. ======================================
315
316
317Version: 6.0.1
318==============
319
320Abstract
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500321--------
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400322
323This document provides the release notes for the Frankfurt Maintenance release
324
325
326Summary
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500327-------
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400328
329The focus of this release is to correct issues found on Frankfurt release.
330
331Release Data
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500332------------
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400333
334+--------------------------------------+--------------------------------------+
335| **Project** | DCAE |
336| | |
337+--------------------------------------+--------------------------------------+
338| **Docker images** | onap/org.onap.dcaegen2.services. |
339| | son-handler:2.0.4 |
340+--------------------------------------+--------------------------------------+
341| **Release designation** | Frankfurt Maintenance Release 1 |
342| | |
343+--------------------------------------+--------------------------------------+
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400344| **Release date** | 2020/08/17 |
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400345| | |
346+--------------------------------------+--------------------------------------+
347
348New features
349------------
350
351None
352
353**Bug fixes**
354
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500355- `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof
356- `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification to align with policy component updates
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400357
358**Known Issues**
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500359
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400360Same as Frankfurt Release
361
362
363
364
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400365.. ===========================
366.. * * * FRANKFURT * * *
367.. ===========================
368
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400369
370Version: 6.0.0
371==============
372
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400373
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400374Abstract
375--------
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400376
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400377This document provides the release notes for the Frankfurt release.
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400378
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400379Summary
380-------
381
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400382Following DCAE components are available with default ONAP/DCAE installation.
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400383
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400384 - Platform components
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400385
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400386 - Cloudify Manager (helm chart)
387 - Bootstrap container (helm chart)
388 - Configuration Binding Service (helm chart)
389 - Deployment Handler (helm chart)
390 - Policy Handler (helm chart
391 - Service Change Handler (helm chart)
392 - Inventory API (helm chart)
393 - Dashboard (helm chart)
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400394
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400395 - Service components
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400396
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400397 - VES Collector
398 - Threshold Crossing Analytics (TCA/CDAP)
399 - HV-VES Collector
400 - PNF-Registration Handler
401 - Docker based Threshold Crossing Analytics (TCA-Gen2)
402 - Holmes Rule Management *
403 - Holmes Engine Management *
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400404
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400405 - Additional resources that DCAE utilizes deployed using ONAP common charts:
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400406
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400407 - Postgres Database
408 - Mongo Database
409 - Redis Cluster Database
410 - Consul Cluster
411
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400412Below service components (mS) are available to be deployed on-demand.
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400413
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -0400414 - SNMPTrap Collector
415 - RESTConf Collector
416 - DataFile Collector
417 - PM-Mapper
418 - BBS-EventProcessor
419 - VES Mapper
420 - Heartbeat mS
421 - SON-Handler
422 - PM-Subscription Handler
423
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400424 Notes:
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400425
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400426 \* These components are delivered by the Holmes project.
427
428
429
430Under 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.
431
432
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400433Release Data
434------------
435
436+--------------------------------------+--------------------------------------------------------+
437| **DCAE Project** | |
438| | |
439+--------------------------------------+--------------------------------------------------------+
440| **Docker images** |Refer :any:`Deliverable <frankfurt_deliverable>` |
441| | |
442+--------------------------------------+--------------------------------------------------------+
443| **Release designation** | 6.0.0 frankfurt |
444| | |
445+--------------------------------------+--------------------------------------------------------+
446| **Release date** | 2020-06-04 |
447| | |
448+--------------------------------------+--------------------------------------------------------+
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400449
450
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400451New features
452------------
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400453
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400454- DCAE Platform Enhancement
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400455
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400456 - Introduction of Microservice and Onboarding Design (MOD) platform
457 - Policy Notification support for DCAE components
458 - Dynamic AAF certificate creation during component instantiation
459 - Helm chart optimization to control each platform component separate
460 - Dashboard Optimization
461 - Blueprint generator tool to simplify deployment artifact creation
462
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400463
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400464- Following new services are delivered this release
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400465
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400466 - Event Processors
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400467
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400468 - PM Subscription Handler
469 - DataLake Handlers
470 - Analytics/RCA
471
472 - TCA-GEN2
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400473
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400474 - Acumos Adapter (PoC)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400475
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400476.. _frankfurt_deliverable:
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400477
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400478Deliverables
479------------
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400480
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400481Software Deliverables
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400482
483.. csv-table::
484 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
485 :widths: auto
486
487 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
488 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
489 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
490 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
491 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
492 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
493 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
494 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
495 "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400496 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400497 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
498 "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
499 "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
500 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
501 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
502 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
503 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
504 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
505 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
506 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400507 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
VENKATESH KUMARa2aa5162020-05-11 18:16:51 -0400508 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400509 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
510 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
511 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
512 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
513 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400514 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
515 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400516 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
517 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
518 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
519 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
520 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
521 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400522 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
523 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400524 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
525 "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
526 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400527
528
529Known Limitations, Issues and Workarounds
530-----------------------------------------
531
532 * Blueprint generator escape char issue (DCAEGEN2-2140)
533 * TCAgen2 Policy configuration support (DCAEGEN2-2198)
534 * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
535
536
537
538*System Limitations*
539
540None
541
542*Known Vulnerabilities*
543
544None
545
546*Workarounds*
547
548Documented under corresponding jira if applicable.
549
550Security Notes
551--------------
552
553*Fixed Security Issues*
554
555 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
556 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
557 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
558 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
559 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
560
561
562*Known Security Issues*
563
564 None
565
566
567*Known Vulnerabilities in Used Modules*
568
569 None
570
571DCAE 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>`_.
572
573Test Results
574------------
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400575
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500576 - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
577 - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400578
579
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400580References
581----------
582
583For more information on the ONAP Frankfurt release, please see:
584
585#. `ONAP Home Page`_
586#. `ONAP Documentation`_
587#. `ONAP Release Downloads`_
588#. `ONAP Wiki Page`_
589
590
591.. _`ONAP Home Page`: https://www.onap.org
592.. _`ONAP Wiki Page`: https://wiki.onap.org
593.. _`ONAP Documentation`: https://docs.onap.org
594.. _`ONAP Release Downloads`: https://git.onap.org
595
596Quick Links:
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400597
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400598 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
599 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400600
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400601
602.. =========================
603.. * * * EL-ALTO * * *
604.. =========================
605
606
Vijay VK09589ca2019-10-08 04:47:17 +0100607Version: 5.0.1
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400608==============
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400609
Vijay VK09589ca2019-10-08 04:47:17 +0100610The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400611
612Following is summary of updates done for DCAEGEN2
613
614**Security**
615
616Following platform components were enabled for HTTPS
617 - ConfigBindingService (CBS)
618 - 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>`_
619 - Cloudify Manager
620 - InventoryAPI
Vijay VK09589ca2019-10-08 04:47:17 +0100621 - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400622
623All components interfacing with platform components were modified to support TLS interface
624
625**Miscellaneous**
626 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
627 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200628 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400629 - CBS client libraries updated to remove consul service lookup
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200630 - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
Vijay VK09589ca2019-10-08 04:47:17 +0100631
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400632
633
634With 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.
635 - Platform components
636 - Cloudify Manager (helm chart)
637 - Bootstrap container (helm chart)
638 - Configuration Binding Service (helm chart)
639 - Deployment Handler (helm chart)
640 - Policy Handler (helm chart
641 - Service Change Handler (helm chart)
642 - Inventory API (helm chart)
643 - Dashboard (helm charts)
644 - Service components
645 - VES Collector
646 - SNMP Collector
647 - Threshold Crossing Analytics
648 - HV-VES Collector
649 - PNF-Registration Handler
650 - Holmes Rule Management *
651 - Holmes Engine Management *
652 - Additional resources that DCAE utilizes:
653 - Postgres Database
654 - Redis Cluster Database
655 - Consul Cluster *
656
657 Notes:
658 \* These components are delivered by external ONAP project.
659
660DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
661
662 - Collectors
663 - RESTConf collector 
664 - DataFile collector
665 - Event Processors
666 - VES Mapper
667 - 3gpp PM-Mapper
668 - BBS Event processor
669 - Analytics/RCA
670 - SON-Handler
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200671 - Missing Heartbeat Ms
672
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400673- All DCAE components are designed to support platform maturity requirements.
674
675
676**Source Code**
677
678Source 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.
679 - dcaegen2
680 - dcaegen2.analytics.tca
681 - dcaegen2.collectors.snmptrap
682 - dcaegen2.collectors.ves
683 - dcaegen2.collectors.hv-ves
684 - dcaegen2.collectors.datafile
685 - dcaegen2.collectors.restconf
686 - dcaegen2.deployments
687 - dcaegen2.platform.blueprints
688 - dcaegen2.platform.cli
689 - dcaegen2.platform.configbinding
690 - dcaegen2.platform.deployment-handler
691 - dcaegen2.platform.inventory-api
692 - dcaegen2.platform.plugins
693 - dcaegen2.platform.policy-handler
694 - dcaegen2.platform.servicechange-handler
695 - dcaegen2.services.heartbeat
696 - dcaegen2.services.mapper
697 - dcaegen2.services.pm-mapper
698 - dcaegen2.services.prh
699 - dcaegen2.services.son-handler
700 - dcaegen2.services
701 - dcaegen2.services.sdk
702 - dcaegen2.utils
703 - ccsdk.platform.plugins
704 - ccsdk.dashboard
705
706**Bug Fixes**
707 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
708 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
709
710
711**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200712 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
713
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400714**Security Notes**
715
716*Fixed Security Issues*
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200717 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Vijay VK5e1694c2019-10-09 17:11:04 +0100718 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
719 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
720 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
721 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
Vijay VK09589ca2019-10-08 04:47:17 +0100722
723*Known Security Issues*
Vijay VK09589ca2019-10-08 04:47:17 +0100724 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
725 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
Vijay VK09589ca2019-10-08 04:47:17 +0100726 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
727 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
728 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
729
730*Known Vulnerabilities in Used Modules*
731
732DCAE 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>`_.
733
734Quick Links:
735 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
736
737 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
738
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500739 - `Project Vulnerability Review Table for DCAE (El-Alto Maintenance) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
Vijay VK09589ca2019-10-08 04:47:17 +0100740
741
742**Upgrade Notes**
743
744The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
745 - K8S Bootstrap container:
746 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
747 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
748 - Configuration Binding Service:
749 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
750 - Description: HTTPS support, Image optimization and non-root user
751 - Inventory API
752 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
753 - Description: HTTPS support, container optmization and non-root user
754 - DataFile Collector
755 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
756 - Description : Code optimization, bug fixes, dmaap plugin integration
757 - SON Handler MS
758 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
759 - Description : Image optimization, bug fixes, CBS integration
760 - VES Adapter/Mapper MS
761 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
762 - Description : Image optimization & CBS periodic polling
763 - PRH MS
764 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
765 - Description : Code optimization, bug fixes and SDK alignment
766 - HV-VES MS
767 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
768 - Description : Code optimization, bug fixes and SDK alignment
769
770Version: 5.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400771==============
Vijay VK09589ca2019-10-08 04:47:17 +0100772
773El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
774
775Following is summary of updates done for DCAEGEN2
776
777**Security**
778
779Following platform components were enabled for HTTPS
780 - ConfigBindingService (CBS)
781 - 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>`_
782 - Cloudify Manager
783 - InventoryAPI
784
785All components interfacing with platform components were modified to support TLS interface
786
787**Miscellaneous**
788 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
789 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200790 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
Vijay VK09589ca2019-10-08 04:47:17 +0100791 - CBS client libraries updated to remove consul service lookup
792
793
794
795**Bug Fixes**
796 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
797 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
798
799
800**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200801 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
802
Vijay VK09589ca2019-10-08 04:47:17 +0100803
804**Security Notes**
805
806*Fixed Security Issues*
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400807
808*Known Security Issues*
809
810 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
811 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
812 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
813 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
814 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
815 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
816 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
817 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
818 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
819 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
820
821*Known Vulnerabilities in Used Modules*
822
823DCAE 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>`_.
824
825Quick Links:
826 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
827
828 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
829
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500830 - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400831
832
833**Upgrade Notes**
834
835The following components are upgraded from Dublin/R4.
836 - Cloudify Manager:
837 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
838 - 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.
839 - K8S Bootstrap container:
840 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
841 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
842 - Configuration Binding Service:
843 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
844 - Description: HTTPS support, Image optimization and non-root user
845 - Deployment Handler
846 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
847 - Description: Update to node10, uninstall workflow updates
848 - Service Change Handler
849 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
850 - Description: HTTPS inventoryAPI support, container optmization and non-root user
851 - Inventory API
852 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
853 - Description: HTTPS support, container optmization and non-root user
854 - DataFile Collector
855 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
856 - Description : Code optimization, bug fixes, dmaap plugin integration
857 - 3gpp PM-Mapper
858 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
859 - Description: Code optimization, bug fixes, dmaap plugin integration
860
861
862
Vijay VK6b0fa462019-05-20 16:06:11 +0100863Version: 4.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400864==============
Vijay VK6b0fa462019-05-20 16:06:11 +0100865
866:Release Date: 2019-06-06
867
868**New Features**
869
870DCAE R4 improves upon previous release with the following new features:
871
872- DCAE Platform Enhancement
873 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
874 - Support helm chart deployment in DCAE using new Helm cloudify plugin
875 - DCAE Healthcheck enhancement to cover static and dynamic deployments
876 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
877 - Dashboard Integration (UI for deployment/verification)
878 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
879 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200880 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +0100881
882- Following new services are delivered with Dublin
883 - Collectors
884 - RESTConf collector 
885 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +0100886 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +0100887 - 3gpp PM-Mapper
888 - BBS Event processor
889 - Analytics/RCA
890 - SON-Handler
891 - Heartbeat MS
892
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200893Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
Vijay VK6b0fa462019-05-20 16:06:11 +0100894 - Platform components
895 - Cloudify Manager (helm chart)
896 - Bootstrap container (helm chart)
897 - Configuration Binding Service (helm chart)
898 - Deployment Handler (helm chart)
899 - Policy Handler (helm chart
900 - Service Change Handler (helm chart)
901 - Inventory API (helm chart)
902 - Dashboard (Cloudify Blueprint)
903 - Service components
904 - VES Collector
905 - SNMP Collector
906 - Threshold Crossing Analytics
907 - HV-VES Collector
908 - PNF-Registration Handler
909 - Holmes Rule Management *
910 - Holmes Engine Management *
911 - Additional resources that DCAE utilizes:
912 - Postgres Database
913 - Redis Cluster Database
914 - Consul Cluster *
915
916 Notes:
917 \* These components are delivered by the Holmes project.
918
919
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200920Under 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.
Vijay VK6b0fa462019-05-20 16:06:11 +0100921
922- All DCAE components are designed to support platform maturity requirements.
923
924
925**Source Code**
926
927Source code of DCAE components are released under the following repositories on gerrit.onap.org:
928 - dcaegen2
929 - dcaegen2.analytics.tca
930 - dcaegen2.collectors.snmptrap
931 - dcaegen2.collectors.ves
932 - dcaegen2.collectors.hv-ves
933 - dcaegen2.collectors.datafile
934 - dcaegen2.collectors.restconf
935 - dcaegen2.deployments
936 - dcaegen2.platform.blueprints
937 - dcaegen2.platform.cli
938 - dcaegen2.platform.configbinding
939 - dcaegen2.platform.deployment-handler
940 - dcaegen2.platform.inventory-api
941 - dcaegen2.platform.plugins
942 - dcaegen2.platform.policy-handler
943 - dcaegen2.platform.servicechange-handler
944 - dcaegen2.services.heartbeat
945 - dcaegen2.services.mapper
946 - dcaegen2.services.pm-mapper
947 - dcaegen2.services.prh
948 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200949 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +0100950 - dcaegen2.services.sdk
951 - dcaegen2.utils
952 - ccsdk.platform.plugins
953 - ccsdk.dashboard
954
955**Bug Fixes**
956
957**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200958 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
959
Vijay VK6b0fa462019-05-20 16:06:11 +0100960
961**Security Notes**
962
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200963*Fixed Security Issues*
964
965*Known Security Issues*
966
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200967 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200968 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200969 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
Krzysztof Opasiakf38f8392019-05-27 18:11:02 +0200970 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
Krzysztof Opasiak01a58302019-05-27 18:11:28 +0200971 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
Krzysztof Opasiak7c269dc2019-05-30 23:57:24 +0200972 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
Krzysztof Opasiakf0b14642019-05-27 18:13:16 +0200973 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
Krzysztof Opasiak1f224ee2019-05-30 17:43:06 +0200974 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
Krzysztof Opasiak61cf8dc2019-05-30 17:43:51 +0200975 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
Krzysztof Opasiakbb8dea82019-05-30 17:44:35 +0200976 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200977
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200978*Known Vulnerabilities in Used Modules*
979
Vijay VK6b0fa462019-05-20 16:06:11 +0100980DCAE 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>`_.
981
982Quick Links:
983 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
984
985 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
986
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500987 - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
Vijay VK6b0fa462019-05-20 16:06:11 +0100988
989
990**New component Notes**
991The following components are introduced in R4
992
993 - Dashboard
994 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
995 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
996 - Blueprint generator
997 - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200998 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100999 - RESTConf collector 
1000 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
1001 - Description: Provides RESTConf interfaces to events from external domain controllers
1002 - VES/Universal Mapper
1003 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001004 - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
Vijay VK6b0fa462019-05-20 16:06:11 +01001005 - 3gpp PM-Mapper
1006 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001007 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +01001008 - BBS Event processor
1009 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001010 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +01001011 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +01001012 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001013 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +01001014 - Heartbeat MS
1015 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
1016 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001017
Vijay VK6b0fa462019-05-20 16:06:11 +01001018
1019**Upgrade Notes**
1020
1021The following components are upgraded from R3
1022 - Cloudify Manager:
1023 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
1024 - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001025 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +01001026 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001027 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
1028 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +01001029 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
1030 - Description: Code optimization and bug fixes
1031 - Deployment Handler
1032 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
1033 - Include updates for health and service endpoint check and bug fixes
1034 - Policy Handler
1035 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
1036 - Description: Policy Handler supports the new lifecycle API's from Policy framework
1037 - Service Change Handler
1038 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1039 - Description: No update from R3
1040 - Inventory API
1041 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
1042 - Description: Refactoring and updates for health and service endpoint check
1043 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +01001044 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001045 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +01001046 - Threshold Crossing Analytics
1047 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
1048 - 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.
1049 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +01001050 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +01001051 - Description : Code optimization, bug fixes, logging and performance improvement
1052 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +01001053 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001054 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +01001055 - HV-VES Collector
1056 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
1057 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
1058 - SNMP Trap Collector
1059 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001060 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +01001061
1062
1063
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001064
1065Version: 3.0.1
VENKATESH KUMAR64559742020-04-29 18:53:53 -04001066==============
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001067
1068:Release Date: 2019-01-31
1069
1070DCAE R3 Maintenance release includes following fixes
1071
1072**Bug Fixes**
1073
1074- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001075 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001076 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001077 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001078 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001079 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001080 Multiple Fileready notification not handled
1081
1082- HighVolume VES Collector (protobuf/tcp)
1083 - DCAEGEN2-976
1084 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
1085
1086- VESCollector (http)
1087 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001088 Issue with VES batch event publish
1089
1090- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001091 - DCAEGEN2-1007
1092 Removing obsolete services configuration
1093
1094
1095The following containers are updated in R3.0.1
1096
1097 - DataFile Collector
1098 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
1099 - HV-VES Collector
1100 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
1101 - VES Collector
1102 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
1103
VENKATESH KUMARb81c2972019-01-31 14:19:18 -05001104**Known Issues**
1105
1106- 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
1107
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001108- 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
Vijay VK6b0fa462019-05-20 16:06:11 +01001109 kubectl get deployments -n onap | grep deployment-handler
1110 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
1111 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
1112
1113
VENKATESH KUMARb81c2972019-01-31 14:19:18 -05001114
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001115
Vijay VK2648c6d2018-09-19 04:30:37 +01001116Version: 3.0.0
1117--------------
1118
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -08001119:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +01001120
1121**New Features**
1122
1123DCAE R3 improves upon previous release with the following new features:
1124
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001125- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +01001126 - Platform components
1127 - Cloudify Manager
1128 - Bootstrap container
1129 - Configuration Binding Service
1130 - Deployment Handler
1131 - Policy Handler
1132 - Service Change Handler
1133 - Inventory API
1134 - Service components
1135 - VES Collector
1136 - SNMP Collector
1137 - Threshold Crossing Analytics
1138 - Holmes Rule Management *
1139 - Holmes Engine Management *
1140 - Additional resources that DCAE utilizes:
1141 - Postgres Database
1142 - Redis Cluster Database
1143 - Consul Cluster
1144
1145 Notes:
Vijay VKab471f62018-11-26 17:49:43 +00001146 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +01001147
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001148- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +01001149
1150 - 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".
1151 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1152
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001153- 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.
Vijay VK2648c6d2018-09-19 04:30:37 +01001154
1155- All DCAE components are designed to support platform maturity requirements.
1156
1157
1158**Source Code**
1159
1160Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1161 - dcaegen2
1162 - dcaegen2.analytics
1163 - dcaegen2.analytics.tca
1164 - dcaegen2.collectors
1165 - dcaegen2.collectors.snmptrap
1166 - dcaegen2.collectors.ves
1167 - dcaegen2.collectors.hv-ves
1168 - dcaegen2.collectors.datafile
1169 - dcaegen2.deployments
1170 - dcaegen2.platform
1171 - dcaegen2.platform.blueprints
1172 - dcaegen2.platform.cli
1173 - dcaegen2.platform.configbinding
1174 - dcaegen2.platform.deployment-handler
1175 - dcaegen2.platform.inventory-api
1176 - dcaegen2.platform.plugins
1177 - dcaegen2.platform.policy-handler
1178 - dcaegen2.platform.servicechange-handler
1179 - dcaegen2.services.heartbeat
1180 - dcaegen2.services.mapper
1181 - dcaegen2.services.prh
1182 - dcaegen2.utils
1183
1184**Bug Fixes**
1185
1186**Known Issues**
1187
1188- 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.
1189
1190**Security Notes**
1191
1192DCAE 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>`_.
1193
1194Quick Links:
1195 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1196
1197 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1198
VENKATESH KUMARe21c8482020-11-12 15:00:02 -05001199 - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +01001200
1201
Vijay VKf6659fc2018-11-02 05:07:27 +01001202**New component Notes**
1203The following components are introduced in R3
1204
1205 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +00001206 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +01001207 - Description : Bulk data file collector to fetch non-realtime PM data
1208 - PNF Registrator handler
1209 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001210 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +01001211 - HV-VES Collector
1212 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
1213 - Description : High Volume VES Collector for fetching real-time PM measurement data
1214 - SNMP Trap Collector
1215 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001216 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +01001217
Vijay VK2648c6d2018-09-19 04:30:37 +01001218
1219**Upgrade Notes**
1220
1221The following components are upgraded from R2:
1222 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +01001223 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +01001224 - 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.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001225 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +01001226 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +01001227 - 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.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001228 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +01001229 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
1230 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
1231 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +01001232 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +01001233 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +01001234 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +01001235 - Description: Policy Handler now supports the new configuration policy format and support for TLS
1236 - Service Change Handler
1237 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1238 - Description: Refactoring.
1239 - Inventory API
1240 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
1241 - Description: Refactoring.
1242 - VES Collector
1243 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001244 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +01001245 - Threshold Crossing Analytics
1246 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1247 - 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.
1248
1249
1250
1251
Lusheng Jib2a561b2018-03-27 23:24:33 -04001252Version: 2.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -04001253==============
Lusheng Jib2a561b2018-03-27 23:24:33 -04001254
Gildas Lanilis82799c72018-05-30 13:22:48 -07001255:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -04001256
1257**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -04001258
Lusheng Jib2a561b2018-03-27 23:24:33 -04001259DCAE R2 improves upon previous release with the following new features:
1260
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001261- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001262 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -04001263 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -04001264 - Bootstrap container
1265 - Configuration Binding Service
1266 - Deployment Handler
1267 - Policy Handler
1268 - Service Change Handler
1269 - Inventory API
1270 - Service components
1271 - VES Collector
1272 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -04001273 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -04001274 - Holmes Rule Management *
1275 - Holmes Engine Management *
1276 - Additional resources that DCAE utilizes:
1277 - Postgres Database
1278 - Redis Cluster Database
1279 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -04001280
Lusheng Ji768421b2018-06-01 16:36:54 -04001281 Notes:
1282 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001283
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001284- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001285
Lusheng Ji768421b2018-06-01 16:36:54 -04001286 - 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".
Lusheng Jieaac78d2018-06-06 00:20:03 -04001287 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001288
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001289- 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.
Lusheng Ji768421b2018-06-01 16:36:54 -04001290
1291- All DCAE components are designed to support platform maturity requirements.
1292
1293
1294**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -04001295
1296Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1297 - dcaegen2
1298 - dcaegen2.analytics
1299 - dcaegen2.analytics.tca
1300 - dcaegen2.collectors
1301 - dcaegen2.collectors.snmptrap
1302 - dcaegen2.collectors.ves
1303 - dcaegen2.deployments
1304 - dcaegen2.platform
1305 - dcaegen2.platform.blueprints
1306 - dcaegen2.platform.cli
1307 - dcaegen2.platform.configbinding
1308 - dcaegen2.platform.deployment-handler
1309 - dcaegen2.platform.inventory-api
1310 - dcaegen2.platform.plugins
1311 - dcaegen2.platform.policy-handler
1312 - dcaegen2.platform.servicechange-handler
1313 - dcaegen2.services.heartbeat
1314 - dcaegen2.services.mapper
1315 - dcaegen2.services.prh
1316 - dcaegen2.utils
1317
1318**Bug Fixes**
1319
1320**Known Issues**
1321
Lusheng Ji768421b2018-06-01 16:36:54 -04001322- 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.
1323
Gildas Lanilis82799c72018-05-30 13:22:48 -07001324**Security Notes**
1325
1326DCAE 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>`_.
1327
1328Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -04001329 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1330
1331 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1332
VENKATESH KUMARe21c8482020-11-12 15:00:02 -05001333 - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
Lusheng Ji768421b2018-06-01 16:36:54 -04001334
1335
Lusheng Jib2a561b2018-03-27 23:24:33 -04001336
1337**Upgrade Notes**
1338
Lusheng Ji768421b2018-06-01 16:36:54 -04001339The following components are upgraded from R1:
1340 - Cloudify Manager:
1341 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
1342 - 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.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001343 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -04001344 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -04001345 - 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.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001346 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -04001347 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
1348 - Description: Configuration Binding Sevice now supports the new configuration policy format.
1349 - Deployment Handler
1350 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
1351 - Policy Handler
1352 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
1353 - Description: Policy Handler now supports the new configuration policy format.
1354 - Service Change Handler
1355 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
1356 - Description: Refactoring.
1357 - Inventory API
1358 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
1359 - Description: Refactoring.
1360 - VES Collector
1361 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
1362 - Threshold Crossing Analytics
1363 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1364 - 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.
1365
Lusheng Jib2a561b2018-03-27 23:24:33 -04001366
1367
Lusheng Ji8fafa432017-11-06 21:52:26 -05001368Version: 1.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -04001369==============
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001370
Lusheng Ji8fafa432017-11-06 21:52:26 -05001371:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001372
1373
1374**New Features**
1375
Lusheng Ji8fafa432017-11-06 21:52:26 -05001376DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
1377sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
1378DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
1379vDNS, vCPU, and vVoLTE.
1380
1381Specifically, DCAE R1 includes the following components:
1382
1383- Core platform
1384 - Cloudify manager
1385 - Consul cluster
1386- Extended platform
1387 - Platform component docker host
1388 - Service component docker host
1389 - CDAP cluster
1390 - PostgreSQL database (*)
1391- Platform docker container components
1392 - Configuration binding service
1393 - Deployment handler
1394 - Service change handler
1395 - Inventory
1396 - Policy handler
1397 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001398- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -05001399 - Docker container components
1400 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +00001401 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -05001402 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +00001403 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -05001404
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001405(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
1406VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -05001407other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001408(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -05001409in R1.
1410
1411Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1412
1413- dcaegen2
1414- dcaegen2/analytics
1415- dcaegen2/analytics/tca
1416- dcaegen2/collectors
1417- dcaegen2/collectors/snmptrap
1418- dcaegen2/collectors/ves
1419- dcaegen2/deployments
1420- dcaegen2/platform
1421- dcaegen2/platform/blueprints
1422- dcaegen2/platform/cdapbroker
1423- dcaegen2/platform/cli
1424- dcaegen2/platform/configbinding
1425- dcaegen2/platform/deployment-handler
1426- dcaegen2/platform/inventory-api
1427- dcaegen2/platform/plugins
1428- dcaegen2/platform/policy-handler
1429- dcaegen2/platform/servicechange-handler
1430- dcaegen2/utils
1431
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001432
1433**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001434
1435This is the initial release.
1436
1437
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001438**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001439
1440- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1441- Need to provide a dev configuration DCAE.
1442
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001443
1444**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001445
ankatare30c4cb42018-09-28 14:26:59 +05301446- 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>`_.>`_.
Lusheng Jieaac78d2018-06-06 00:20:03 -04001447- 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.
1448
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001449
1450**Upgrade Notes**
1451
Lusheng Ji8fafa432017-11-06 21:52:26 -05001452This is the initial release.
1453
1454
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001455**Deprecation Notes**
1456
Lusheng Ji8fafa432017-11-06 21:52:26 -05001457There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
1458DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
1459following Gerrit repos are voided and already locked as read-only.
1460
1461- dcae
1462- dcae/apod
1463- dcae/apod/analytics
1464- dcae/apod/buildtools
1465- dcae/apod/cdap
1466- dcae/collectors
1467- dcae/collectors/ves
1468- dcae/controller
1469- dcae/controller/analytics
1470- dcae/dcae-inventory
1471- dcae/demo
1472- dcae/demo/startup
1473- dcae/demo/startup/aaf
1474- dcae/demo/startup/controller
1475- dcae/demo/startup/message-router
1476- dcae/dmaapbc
1477- dcae/operation
1478- dcae/operation/utils
1479- dcae/orch-dispatcher
1480- dcae/pgaas
1481- dcae/utils
1482- dcae/utils/buildtools
1483- ncomp
1484- ncomp/cdap
1485- ncomp/core
1486- ncomp/docker
1487- ncomp/maven
1488- ncomp/openstack
1489- ncomp/sirius
1490- ncomp/sirius/manager
1491- ncomp/utils
1492
1493
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001494**Other**
1495
Vijay0fbc6732017-11-08 13:55:01 +00001496SNMP trap collector is seed code delivery only.