blob: c282adc6ae01fcc0ac8c459e02304c183c7fbc8c [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
Kai6c9735a2020-11-13 17:03:52 +080076 - DataLake 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
VENKATESH KUMAR9d4f9c72020-11-16 09:37:31 -0500108- DCAE Enhancements
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400109
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
Kai6c9735a2020-11-13 17:03:52 +0800132 - DataLake Extraction Service
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400133
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"
VENKATESH KUMAR9d4f9c72020-11-16 09:37:31 -0500153 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9"
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400154 "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)
VENKATESH KUMAR9d4f9c72020-11-16 09:37:31 -0500194 * Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400195
196
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400197*System Limitations*
198
199None
200
201*Known Vulnerabilities*
202
203None
204
205*Workarounds*
206
207Documented under corresponding jira if applicable.
208
209Security Notes
210--------------
211
212*Fixed Security Issues*
213 Listed above
214
215*Known Security Issues*
216
217 None
218
219
220*Known Vulnerabilities in Used Modules*
221
222 None
223
224DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
225
226Test Results
227------------
228
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500229 - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
230 - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
VENKATESH KUMAR647eade2020-10-29 11:30:28 -0400231
232
233References
234----------
235
236For more information on the ONAP Guilin release, please see:
237
238#. `ONAP Home Page`_
239#. `ONAP Documentation`_
240#. `ONAP Release Downloads`_
241#. `ONAP Wiki Page`_
242
243
244.. _`ONAP Home Page`: https://www.onap.org
245.. _`ONAP Wiki Page`: https://wiki.onap.org
246.. _`ONAP Documentation`: https://docs.onap.org
247.. _`ONAP Release Downloads`: https://git.onap.org
248
249Quick Links:
250
251 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
252 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
253
254
255
256
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400257.. ======================================
258.. * * * EL-ALTO MAINTENANCE * * *
259.. ======================================
260
261
262Version: 5.0.2
263==============
264
265Abstract
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500266--------
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400267
268This document provides the release notes for the El-Alto Maintenance release
269
270
271Summary
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500272-------
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400273
274This maintenance release is primarily to update expired certificates
275from original El-Alto released TLS-init container.
276
277This patch is not required for Frankfurt release (and beyond) as certificates are dynamically
278retrieved from AAF at deployment time for all DCAE components.
279
280Release Data
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500281------------
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400282
283+--------------------------------------+--------------------------------------+
284| **Project** | DCAE |
285| | |
286+--------------------------------------+--------------------------------------+
287| **Docker images** | onap/org.onap.dcaegen2.deployments |
288| | .tls-init-container:1.0.4 |
289+--------------------------------------+--------------------------------------+
290| **Release designation** | El-Alto Maintenance Release |
291| | |
292+--------------------------------------+--------------------------------------+
293| **Release date** | 2020/08/24 |
294| | |
295+--------------------------------------+--------------------------------------+
296
297New features
298------------
299
300None
301
302**Bug fixes**
303
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500304- `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400305
306**Known Issues**
307Same as El-Alto Release
308
309
310
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400311.. ======================================
312.. * * * FRANKFURT MAINTENANCE * * *
313.. ======================================
314
315
316Version: 6.0.1
317==============
318
319Abstract
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500320--------
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400321
322This document provides the release notes for the Frankfurt Maintenance release
323
324
325Summary
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500326-------
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400327
328The focus of this release is to correct issues found on Frankfurt release.
329
330Release Data
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500331------------
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400332
333+--------------------------------------+--------------------------------------+
334| **Project** | DCAE |
335| | |
336+--------------------------------------+--------------------------------------+
337| **Docker images** | onap/org.onap.dcaegen2.services. |
338| | son-handler:2.0.4 |
339+--------------------------------------+--------------------------------------+
340| **Release designation** | Frankfurt Maintenance Release 1 |
341| | |
342+--------------------------------------+--------------------------------------+
VENKATESH KUMARa052dac2020-08-18 17:43:04 -0400343| **Release date** | 2020/08/17 |
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400344| | |
345+--------------------------------------+--------------------------------------+
346
347New features
348------------
349
350None
351
352**Bug fixes**
353
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500354- `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof
355- `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 -0400356
357**Known Issues**
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500358
VENKATESH KUMARb938a122020-07-23 17:41:31 -0400359Same as Frankfurt Release
360
361
362
363
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400364.. ===========================
365.. * * * FRANKFURT * * *
366.. ===========================
367
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400368
369Version: 6.0.0
370==============
371
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400372
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400373Abstract
374--------
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400375
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400376This document provides the release notes for the Frankfurt release.
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400377
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400378Summary
379-------
380
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400381Following DCAE components are available with default ONAP/DCAE installation.
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400382
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400383 - Platform components
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400384
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400385 - Cloudify Manager (helm chart)
386 - Bootstrap container (helm chart)
387 - Configuration Binding Service (helm chart)
388 - Deployment Handler (helm chart)
389 - Policy Handler (helm chart
390 - Service Change Handler (helm chart)
391 - Inventory API (helm chart)
392 - Dashboard (helm chart)
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400393
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400394 - Service components
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400395
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400396 - VES Collector
397 - Threshold Crossing Analytics (TCA/CDAP)
398 - HV-VES Collector
399 - PNF-Registration Handler
400 - Docker based Threshold Crossing Analytics (TCA-Gen2)
401 - Holmes Rule Management *
402 - Holmes Engine Management *
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400403
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400404 - Additional resources that DCAE utilizes deployed using ONAP common charts:
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400405
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400406 - Postgres Database
407 - Mongo Database
408 - Redis Cluster Database
409 - Consul Cluster
410
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400411Below service components (mS) are available to be deployed on-demand.
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400412
VENKATESH KUMARc790dcb2020-04-02 23:39:28 -0400413 - SNMPTrap Collector
414 - RESTConf Collector
415 - DataFile Collector
416 - PM-Mapper
417 - BBS-EventProcessor
418 - VES Mapper
419 - Heartbeat mS
420 - SON-Handler
421 - PM-Subscription Handler
422
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400423 Notes:
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400424
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400425 \* These components are delivered by the Holmes project.
426
427
428
429Under 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.
430
431
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400432Release Data
433------------
434
435+--------------------------------------+--------------------------------------------------------+
436| **DCAE Project** | |
437| | |
438+--------------------------------------+--------------------------------------------------------+
439| **Docker images** |Refer :any:`Deliverable <frankfurt_deliverable>` |
440| | |
441+--------------------------------------+--------------------------------------------------------+
442| **Release designation** | 6.0.0 frankfurt |
443| | |
444+--------------------------------------+--------------------------------------------------------+
445| **Release date** | 2020-06-04 |
446| | |
447+--------------------------------------+--------------------------------------------------------+
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400448
449
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400450New features
451------------
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400452
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400453- DCAE Platform Enhancement
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400454
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400455 - Introduction of Microservice and Onboarding Design (MOD) platform
456 - Policy Notification support for DCAE components
457 - Dynamic AAF certificate creation during component instantiation
458 - Helm chart optimization to control each platform component separate
459 - Dashboard Optimization
460 - Blueprint generator tool to simplify deployment artifact creation
461
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400462
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400463- Following new services are delivered this release
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400464
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400465 - Event Processors
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400466
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400467 - PM Subscription Handler
468 - DataLake Handlers
469 - Analytics/RCA
470
471 - TCA-GEN2
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400472
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400473 - Acumos Adapter (PoC)
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400474
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400475.. _frankfurt_deliverable:
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400476
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400477Deliverables
478------------
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400479
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400480Software Deliverables
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400481
482.. csv-table::
483 :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
484 :widths: auto
485
486 "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
487 "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
488 "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
489 "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
490 "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
491 "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
492 "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
493 "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
494 "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 -0400495 "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400496 "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
497 "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
498 "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
499 "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
500 "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
501 "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
502 "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
503 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
504 "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
505 "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400506 "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
VENKATESH KUMARa2aa5162020-05-11 18:16:51 -0400507 "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400508 "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
509 "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
510 "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
511 "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
512 "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
VENKATESH KUMARe64d2d62020-04-06 18:55:10 -0400513 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
514 "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400515 "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
516 "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
517 "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
518 "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
519 "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
520 "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400521 "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
522 "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400523 "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
524 "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
525 "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400526
527
528Known Limitations, Issues and Workarounds
529-----------------------------------------
530
531 * Blueprint generator escape char issue (DCAEGEN2-2140)
532 * TCAgen2 Policy configuration support (DCAEGEN2-2198)
533 * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
534
535
536
537*System Limitations*
538
539None
540
541*Known Vulnerabilities*
542
543None
544
545*Workarounds*
546
547Documented under corresponding jira if applicable.
548
549Security Notes
550--------------
551
552*Fixed Security Issues*
553
554 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
555 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
556 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
557 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
558 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
559
560
561*Known Security Issues*
562
563 None
564
565
566*Known Vulnerabilities in Used Modules*
567
568 None
569
570DCAE 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>`_.
571
572Test Results
573------------
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400574
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500575 - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
576 - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400577
578
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400579References
580----------
581
582For more information on the ONAP Frankfurt release, please see:
583
584#. `ONAP Home Page`_
585#. `ONAP Documentation`_
586#. `ONAP Release Downloads`_
587#. `ONAP Wiki Page`_
588
589
590.. _`ONAP Home Page`: https://www.onap.org
591.. _`ONAP Wiki Page`: https://wiki.onap.org
592.. _`ONAP Documentation`: https://docs.onap.org
593.. _`ONAP Release Downloads`: https://git.onap.org
594
595Quick Links:
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400596
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -0400597 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
598 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
VENKATESH KUMARcfb11092020-04-02 12:27:00 -0400599
VENKATESH KUMAR3e2bb4c2020-05-13 16:21:54 -0400600
601.. =========================
602.. * * * EL-ALTO * * *
603.. =========================
604
605
Vijay VK09589ca2019-10-08 04:47:17 +0100606Version: 5.0.1
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400607==============
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400608
Vijay VK09589ca2019-10-08 04:47:17 +0100609The 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 -0400610
611Following is summary of updates done for DCAEGEN2
612
613**Security**
614
615Following platform components were enabled for HTTPS
616 - ConfigBindingService (CBS)
617 - 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>`_
618 - Cloudify Manager
619 - InventoryAPI
Vijay VK09589ca2019-10-08 04:47:17 +0100620 - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400621
622All components interfacing with platform components were modified to support TLS interface
623
624**Miscellaneous**
625 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
626 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200627 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400628 - CBS client libraries updated to remove consul service lookup
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200629 - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
Vijay VK09589ca2019-10-08 04:47:17 +0100630
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400631
632
633With 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.
634 - Platform components
635 - Cloudify Manager (helm chart)
636 - Bootstrap container (helm chart)
637 - Configuration Binding Service (helm chart)
638 - Deployment Handler (helm chart)
639 - Policy Handler (helm chart
640 - Service Change Handler (helm chart)
641 - Inventory API (helm chart)
642 - Dashboard (helm charts)
643 - Service components
644 - VES Collector
645 - SNMP Collector
646 - Threshold Crossing Analytics
647 - HV-VES Collector
648 - PNF-Registration Handler
649 - Holmes Rule Management *
650 - Holmes Engine Management *
651 - Additional resources that DCAE utilizes:
652 - Postgres Database
653 - Redis Cluster Database
654 - Consul Cluster *
655
656 Notes:
657 \* These components are delivered by external ONAP project.
658
659DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
660
661 - Collectors
662 - RESTConf collector 
663 - DataFile collector
664 - Event Processors
665 - VES Mapper
666 - 3gpp PM-Mapper
667 - BBS Event processor
668 - Analytics/RCA
669 - SON-Handler
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200670 - Missing Heartbeat Ms
671
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400672- All DCAE components are designed to support platform maturity requirements.
673
674
675**Source Code**
676
677Source 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.
678 - dcaegen2
679 - dcaegen2.analytics.tca
680 - dcaegen2.collectors.snmptrap
681 - dcaegen2.collectors.ves
682 - dcaegen2.collectors.hv-ves
683 - dcaegen2.collectors.datafile
684 - dcaegen2.collectors.restconf
685 - dcaegen2.deployments
686 - dcaegen2.platform.blueprints
687 - dcaegen2.platform.cli
688 - dcaegen2.platform.configbinding
689 - dcaegen2.platform.deployment-handler
690 - dcaegen2.platform.inventory-api
691 - dcaegen2.platform.plugins
692 - dcaegen2.platform.policy-handler
693 - dcaegen2.platform.servicechange-handler
694 - dcaegen2.services.heartbeat
695 - dcaegen2.services.mapper
696 - dcaegen2.services.pm-mapper
697 - dcaegen2.services.prh
698 - dcaegen2.services.son-handler
699 - dcaegen2.services
700 - dcaegen2.services.sdk
701 - dcaegen2.utils
702 - ccsdk.platform.plugins
703 - ccsdk.dashboard
704
705**Bug Fixes**
706 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
707 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
708
709
710**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200711 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
712
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400713**Security Notes**
714
715*Fixed Security Issues*
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200716 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Vijay VK5e1694c2019-10-09 17:11:04 +0100717 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
718 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
719 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
720 * 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 +0100721
722*Known Security Issues*
Vijay VK09589ca2019-10-08 04:47:17 +0100723 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
724 * 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 +0100725 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
726 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
727 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
728
729*Known Vulnerabilities in Used Modules*
730
731DCAE 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>`_.
732
733Quick Links:
734 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
735
736 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
737
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500738 - `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 +0100739
740
741**Upgrade Notes**
742
743The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
744 - K8S Bootstrap container:
745 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
746 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
747 - Configuration Binding Service:
748 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
749 - Description: HTTPS support, Image optimization and non-root user
750 - Inventory API
751 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
752 - Description: HTTPS support, container optmization and non-root user
753 - DataFile Collector
754 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
755 - Description : Code optimization, bug fixes, dmaap plugin integration
756 - SON Handler MS
757 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
758 - Description : Image optimization, bug fixes, CBS integration
759 - VES Adapter/Mapper MS
760 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
761 - Description : Image optimization & CBS periodic polling
762 - PRH MS
763 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
764 - Description : Code optimization, bug fixes and SDK alignment
765 - HV-VES MS
766 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
767 - Description : Code optimization, bug fixes and SDK alignment
768
769Version: 5.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400770==============
Vijay VK09589ca2019-10-08 04:47:17 +0100771
772El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
773
774Following is summary of updates done for DCAEGEN2
775
776**Security**
777
778Following platform components were enabled for HTTPS
779 - ConfigBindingService (CBS)
780 - 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>`_
781 - Cloudify Manager
782 - InventoryAPI
783
784All components interfacing with platform components were modified to support TLS interface
785
786**Miscellaneous**
787 - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
788 - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200789 - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
Vijay VK09589ca2019-10-08 04:47:17 +0100790 - CBS client libraries updated to remove consul service lookup
791
792
793
794**Bug Fixes**
795 * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
796 * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
797
798
799**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200800 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
801
Vijay VK09589ca2019-10-08 04:47:17 +0100802
803**Security Notes**
804
805*Fixed Security Issues*
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400806
807*Known Security Issues*
808
809 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
810 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
811 * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
812 * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
813 * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
814 * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
815 * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
816 * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
817 * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
818 * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
819
820*Known Vulnerabilities in Used Modules*
821
822DCAE 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>`_.
823
824Quick Links:
825 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
826
827 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
828
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500829 - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
VENKATESH KUMAR2d6bc192019-08-18 22:08:00 -0400830
831
832**Upgrade Notes**
833
834The following components are upgraded from Dublin/R4.
835 - Cloudify Manager:
836 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
837 - 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.
838 - K8S Bootstrap container:
839 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
840 - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
841 - Configuration Binding Service:
842 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
843 - Description: HTTPS support, Image optimization and non-root user
844 - Deployment Handler
845 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
846 - Description: Update to node10, uninstall workflow updates
847 - Service Change Handler
848 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
849 - Description: HTTPS inventoryAPI support, container optmization and non-root user
850 - Inventory API
851 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
852 - Description: HTTPS support, container optmization and non-root user
853 - DataFile Collector
854 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
855 - Description : Code optimization, bug fixes, dmaap plugin integration
856 - 3gpp PM-Mapper
857 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
858 - Description: Code optimization, bug fixes, dmaap plugin integration
859
860
861
Vijay VK6b0fa462019-05-20 16:06:11 +0100862Version: 4.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -0400863==============
Vijay VK6b0fa462019-05-20 16:06:11 +0100864
865:Release Date: 2019-06-06
866
867**New Features**
868
869DCAE R4 improves upon previous release with the following new features:
870
871- DCAE Platform Enhancement
872 - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
873 - Support helm chart deployment in DCAE using new Helm cloudify plugin
874 - DCAE Healthcheck enhancement to cover static and dynamic deployments
875 - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
876 - Dashboard Integration (UI for deployment/verification)
877 - PolicyHandler Enhancement to support new Policy Lifecycle API’s
878 - Blueprint generator tool to simplify deployment artifact creation
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200879 - Cloudify Manager resiliency
Vijay VK6b0fa462019-05-20 16:06:11 +0100880
881- Following new services are delivered with Dublin
882 - Collectors
883 - RESTConf collector 
884 - Event Processors
Vijay VKf9e43442019-05-22 22:10:29 +0100885 - VES Mapper
Vijay VK6b0fa462019-05-20 16:06:11 +0100886 - 3gpp PM-Mapper
887 - BBS Event processor
888 - Analytics/RCA
889 - SON-Handler
890 - Heartbeat MS
891
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200892Most 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 +0100893 - Platform components
894 - Cloudify Manager (helm chart)
895 - Bootstrap container (helm chart)
896 - Configuration Binding Service (helm chart)
897 - Deployment Handler (helm chart)
898 - Policy Handler (helm chart
899 - Service Change Handler (helm chart)
900 - Inventory API (helm chart)
901 - Dashboard (Cloudify Blueprint)
902 - Service components
903 - VES Collector
904 - SNMP Collector
905 - Threshold Crossing Analytics
906 - HV-VES Collector
907 - PNF-Registration Handler
908 - Holmes Rule Management *
909 - Holmes Engine Management *
910 - Additional resources that DCAE utilizes:
911 - Postgres Database
912 - Redis Cluster Database
913 - Consul Cluster *
914
915 Notes:
916 \* These components are delivered by the Holmes project.
917
918
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200919Under 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 +0100920
921- All DCAE components are designed to support platform maturity requirements.
922
923
924**Source Code**
925
926Source code of DCAE components are released under the following repositories on gerrit.onap.org:
927 - dcaegen2
928 - dcaegen2.analytics.tca
929 - dcaegen2.collectors.snmptrap
930 - dcaegen2.collectors.ves
931 - dcaegen2.collectors.hv-ves
932 - dcaegen2.collectors.datafile
933 - dcaegen2.collectors.restconf
934 - dcaegen2.deployments
935 - dcaegen2.platform.blueprints
936 - dcaegen2.platform.cli
937 - dcaegen2.platform.configbinding
938 - dcaegen2.platform.deployment-handler
939 - dcaegen2.platform.inventory-api
940 - dcaegen2.platform.plugins
941 - dcaegen2.platform.policy-handler
942 - dcaegen2.platform.servicechange-handler
943 - dcaegen2.services.heartbeat
944 - dcaegen2.services.mapper
945 - dcaegen2.services.pm-mapper
946 - dcaegen2.services.prh
947 - dcaegen2.services.son-handler
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200948 - dcaegen2.services
Vijay VK6b0fa462019-05-20 16:06:11 +0100949 - dcaegen2.services.sdk
950 - dcaegen2.utils
951 - ccsdk.platform.plugins
952 - ccsdk.dashboard
953
954**Bug Fixes**
955
956**Known Issues**
Krzysztof Opasiak4c97a552019-10-23 21:52:36 +0200957 * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
958
Vijay VK6b0fa462019-05-20 16:06:11 +0100959
960**Security Notes**
961
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200962*Fixed Security Issues*
963
964*Known Security Issues*
965
Krzysztof Opasiak07fa5872019-05-30 17:40:07 +0200966 * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
Krzysztof Opasiakf2a8c6e2019-05-30 17:42:37 +0200967 * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
Krzysztof Opasiakd9e8b342019-05-27 18:06:32 +0200968 * 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 +0200969 * 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 +0200970 * 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 +0200971 * 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 +0200972 * 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 +0200973 * 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 +0200974 * 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 +0200975 * 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 +0200976
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +0200977*Known Vulnerabilities in Used Modules*
978
Vijay VK6b0fa462019-05-20 16:06:11 +0100979DCAE 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>`_.
980
981Quick Links:
982 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
983
984 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
985
VENKATESH KUMARe21c8482020-11-12 15:00:02 -0500986 - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
Vijay VK6b0fa462019-05-20 16:06:11 +0100987
988
989**New component Notes**
990The following components are introduced in R4
991
992 - Dashboard
993 - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
994 - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
995 - Blueprint generator
996 - 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 +0200997 - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
Vijay VK6b0fa462019-05-20 16:06:11 +0100998 - RESTConf collector 
999 - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
1000 - Description: Provides RESTConf interfaces to events from external domain controllers
1001 - VES/Universal Mapper
1002 - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001003 - 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 +01001004 - 3gpp PM-Mapper
1005 - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001006 - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
Vijay VK6b0fa462019-05-20 16:06:11 +01001007 - BBS Event processor
1008 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001009 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
Vijay VK6b0fa462019-05-20 16:06:11 +01001010 - SON-Handler
Vijay VKa46f7fe2019-06-10 15:57:41 +01001011 - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001012 - Description: Supports PC-ANR optimization analysis and generating CL events output
Vijay VK6b0fa462019-05-20 16:06:11 +01001013 - Heartbeat MS
1014 - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
1015 - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001016
Vijay VK6b0fa462019-05-20 16:06:11 +01001017
1018**Upgrade Notes**
1019
1020The following components are upgraded from R3
1021 - Cloudify Manager:
1022 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
1023 - 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 +02001024 - K8S Bootstrap container:
Vijay VK6b0fa462019-05-20 16:06:11 +01001025 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001026 - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
1027 - Configuration Binding Service:
Vijay VK6b0fa462019-05-20 16:06:11 +01001028 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
1029 - Description: Code optimization and bug fixes
1030 - Deployment Handler
1031 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
1032 - Include updates for health and service endpoint check and bug fixes
1033 - Policy Handler
1034 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
1035 - Description: Policy Handler supports the new lifecycle API's from Policy framework
1036 - Service Change Handler
1037 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1038 - Description: No update from R3
1039 - Inventory API
1040 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
1041 - Description: Refactoring and updates for health and service endpoint check
1042 - VES Collector
Vijay VKa46f7fe2019-06-10 15:57:41 +01001043 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001044 - Description : Authentication enhancement, refactoring and bug-fixes
Vijay VK6b0fa462019-05-20 16:06:11 +01001045 - Threshold Crossing Analytics
1046 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
1047 - 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.
1048 - DataFile Collector
Vijay VKf9e43442019-05-22 22:10:29 +01001049 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
Vijay VK6b0fa462019-05-20 16:06:11 +01001050 - Description : Code optimization, bug fixes, logging and performance improvement
1051 - PNF Registrator handler
Vijay VKa46f7fe2019-06-10 15:57:41 +01001052 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001053 - Description : Code optimization, SDK integration, PNF-UPDATE flow support
Vijay VK6b0fa462019-05-20 16:06:11 +01001054 - HV-VES Collector
1055 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
1056 - Description : Code optimization, bug fixes, and enables SASL for kafka interface
1057 - SNMP Trap Collector
1058 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001059 - Description : Code coverage improvements
Vijay VK6b0fa462019-05-20 16:06:11 +01001060
1061
1062
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001063
1064Version: 3.0.1
VENKATESH KUMAR64559742020-04-29 18:53:53 -04001065==============
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001066
1067:Release Date: 2019-01-31
1068
1069DCAE R3 Maintenance release includes following fixes
1070
1071**Bug Fixes**
1072
1073- DataFileCollector
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001074 - DCAEGEN2-940
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001075 Larger files of size 100Kb publish to DR
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001076 - DCAEGEN2-941
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001077 DFC error after running over 12 hours
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001078 - DCAEGEN2-1001
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001079 Multiple Fileready notification not handled
1080
1081- HighVolume VES Collector (protobuf/tcp)
1082 - DCAEGEN2-976
1083 HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
1084
1085- VESCollector (http)
1086 - DCAEGEN2-1035
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001087 Issue with VES batch event publish
1088
1089- Heat deployment
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001090 - DCAEGEN2-1007
1091 Removing obsolete services configuration
1092
1093
1094The following containers are updated in R3.0.1
1095
1096 - DataFile Collector
1097 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
1098 - HV-VES Collector
1099 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
1100 - VES Collector
1101 - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
1102
VENKATESH KUMARb81c2972019-01-31 14:19:18 -05001103**Known Issues**
1104
1105- 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
1106
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001107- 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 +01001108 kubectl get deployments -n onap | grep deployment-handler
1109 kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
1110 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
1111
1112
VENKATESH KUMARb81c2972019-01-31 14:19:18 -05001113
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001114
Vijay VK2648c6d2018-09-19 04:30:37 +01001115Version: 3.0.0
1116--------------
1117
Gildas Lanilisa05d7fe2018-11-28 15:33:44 -08001118:Release Date: 2018-11-30
Vijay VK2648c6d2018-09-19 04:30:37 +01001119
1120**New Features**
1121
1122DCAE R3 improves upon previous release with the following new features:
1123
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001124- All DCAE R3 components are delivered as Docker container images. The list of components is as follows.
Vijay VK2648c6d2018-09-19 04:30:37 +01001125 - Platform components
1126 - Cloudify Manager
1127 - Bootstrap container
1128 - Configuration Binding Service
1129 - Deployment Handler
1130 - Policy Handler
1131 - Service Change Handler
1132 - Inventory API
1133 - Service components
1134 - VES Collector
1135 - SNMP Collector
1136 - Threshold Crossing Analytics
1137 - Holmes Rule Management *
1138 - Holmes Engine Management *
1139 - Additional resources that DCAE utilizes:
1140 - Postgres Database
1141 - Redis Cluster Database
1142 - Consul Cluster
1143
1144 Notes:
Vijay VKab471f62018-11-26 17:49:43 +00001145 \* These components are delivered by the Holmes project.
Vijay VK2648c6d2018-09-19 04:30:37 +01001146
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001147- DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Vijay VK2648c6d2018-09-19 04:30:37 +01001148
1149 - 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".
1150 - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1151
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001152- 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 +01001153
1154- All DCAE components are designed to support platform maturity requirements.
1155
1156
1157**Source Code**
1158
1159Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1160 - dcaegen2
1161 - dcaegen2.analytics
1162 - dcaegen2.analytics.tca
1163 - dcaegen2.collectors
1164 - dcaegen2.collectors.snmptrap
1165 - dcaegen2.collectors.ves
1166 - dcaegen2.collectors.hv-ves
1167 - dcaegen2.collectors.datafile
1168 - dcaegen2.deployments
1169 - dcaegen2.platform
1170 - dcaegen2.platform.blueprints
1171 - dcaegen2.platform.cli
1172 - dcaegen2.platform.configbinding
1173 - dcaegen2.platform.deployment-handler
1174 - dcaegen2.platform.inventory-api
1175 - dcaegen2.platform.plugins
1176 - dcaegen2.platform.policy-handler
1177 - dcaegen2.platform.servicechange-handler
1178 - dcaegen2.services.heartbeat
1179 - dcaegen2.services.mapper
1180 - dcaegen2.services.prh
1181 - dcaegen2.utils
1182
1183**Bug Fixes**
1184
1185**Known Issues**
1186
1187- 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.
1188
1189**Security Notes**
1190
1191DCAE 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>`_.
1192
1193Quick Links:
1194 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1195
1196 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1197
VENKATESH KUMARe21c8482020-11-12 15:00:02 -05001198 - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
Vijay VK2648c6d2018-09-19 04:30:37 +01001199
1200
Vijay VKf6659fc2018-11-02 05:07:27 +01001201**New component Notes**
1202The following components are introduced in R3
1203
1204 - DataFile Collector
Vijay VK56f31942018-11-07 20:41:15 +00001205 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
Vijay VKf6659fc2018-11-02 05:07:27 +01001206 - Description : Bulk data file collector to fetch non-realtime PM data
1207 - PNF Registrator handler
1208 - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001209 - Description : Recieves VES registration event and updates AAI and SO
Vijay VKf6659fc2018-11-02 05:07:27 +01001210 - HV-VES Collector
1211 - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
1212 - Description : High Volume VES Collector for fetching real-time PM measurement data
1213 - SNMP Trap Collector
1214 - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001215 - Description : Receives SNMP traps and publishes them to a message router (DMAAP/MR) in json structure
Vijay VKf6659fc2018-11-02 05:07:27 +01001216
Vijay VK2648c6d2018-09-19 04:30:37 +01001217
1218**Upgrade Notes**
1219
1220The following components are upgraded from R2:
1221 - Cloudify Manager:
Vijay VK86cd8932018-10-23 16:35:29 +01001222 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
Vijay VKf6659fc2018-11-02 05:07:27 +01001223 - 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 +02001224 - Bootstrap container:
Vijay VKf6659fc2018-11-02 05:07:27 +01001225 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
Vijay VK2648c6d2018-09-19 04:30:37 +01001226 - 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 +02001227 - Configuration Binding Service:
Vijay VK2648c6d2018-09-19 04:30:37 +01001228 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
1229 - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
1230 - Deployment Handler
Vijay VK86cd8932018-10-23 16:35:29 +01001231 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
Vijay VK2648c6d2018-09-19 04:30:37 +01001232 - Policy Handler
Vijay VKf6659fc2018-11-02 05:07:27 +01001233 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
Vijay VK2648c6d2018-09-19 04:30:37 +01001234 - Description: Policy Handler now supports the new configuration policy format and support for TLS
1235 - Service Change Handler
1236 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1237 - Description: Refactoring.
1238 - Inventory API
1239 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
1240 - Description: Refactoring.
1241 - VES Collector
1242 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
VENKATESH KUMARfac34a12019-01-20 20:15:08 -05001243 - Description : Refactoring
Vijay VK2648c6d2018-09-19 04:30:37 +01001244 - Threshold Crossing Analytics
1245 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1246 - 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.
1247
1248
1249
1250
Lusheng Jib2a561b2018-03-27 23:24:33 -04001251Version: 2.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -04001252==============
Lusheng Jib2a561b2018-03-27 23:24:33 -04001253
Gildas Lanilis82799c72018-05-30 13:22:48 -07001254:Release Date: 2018-06-07
Lusheng Jib2a561b2018-03-27 23:24:33 -04001255
1256**New Features**
Lusheng Ji768421b2018-06-01 16:36:54 -04001257
Lusheng Jib2a561b2018-03-27 23:24:33 -04001258DCAE R2 improves upon previous release with the following new features:
1259
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001260- All DCAE R2 components are delivered as Docker container images. The list of components is as follows.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001261 - Platform components
Lusheng Ji768421b2018-06-01 16:36:54 -04001262 - Cloudify Manager
Lusheng Jib2a561b2018-03-27 23:24:33 -04001263 - Bootstrap container
1264 - Configuration Binding Service
1265 - Deployment Handler
1266 - Policy Handler
1267 - Service Change Handler
1268 - Inventory API
1269 - Service components
1270 - VES Collector
1271 - SNMP Collector
Lusheng Jib2a561b2018-03-27 23:24:33 -04001272 - Threshold Crossing Analytics
Lusheng Ji768421b2018-06-01 16:36:54 -04001273 - Holmes Rule Management *
1274 - Holmes Engine Management *
1275 - Additional resources that DCAE utilizes:
1276 - Postgres Database
1277 - Redis Cluster Database
1278 - Consul Cluster
Lusheng Jieaac78d2018-06-06 00:20:03 -04001279
Lusheng Ji768421b2018-06-01 16:36:54 -04001280 Notes:
1281 \* These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001282
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001283- DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
Lusheng Jib2a561b2018-03-27 23:24:33 -04001284
Lusheng Ji768421b2018-06-01 16:36:54 -04001285 - 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 -04001286 - 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 -04001287
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001288- 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 -04001289
1290- All DCAE components are designed to support platform maturity requirements.
1291
1292
1293**Source Code**
Lusheng Jib2a561b2018-03-27 23:24:33 -04001294
1295Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1296 - dcaegen2
1297 - dcaegen2.analytics
1298 - dcaegen2.analytics.tca
1299 - dcaegen2.collectors
1300 - dcaegen2.collectors.snmptrap
1301 - dcaegen2.collectors.ves
1302 - dcaegen2.deployments
1303 - dcaegen2.platform
1304 - dcaegen2.platform.blueprints
1305 - dcaegen2.platform.cli
1306 - dcaegen2.platform.configbinding
1307 - dcaegen2.platform.deployment-handler
1308 - dcaegen2.platform.inventory-api
1309 - dcaegen2.platform.plugins
1310 - dcaegen2.platform.policy-handler
1311 - dcaegen2.platform.servicechange-handler
1312 - dcaegen2.services.heartbeat
1313 - dcaegen2.services.mapper
1314 - dcaegen2.services.prh
1315 - dcaegen2.utils
1316
1317**Bug Fixes**
1318
1319**Known Issues**
1320
Lusheng Ji768421b2018-06-01 16:36:54 -04001321- 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.
1322
Gildas Lanilis82799c72018-05-30 13:22:48 -07001323**Security Notes**
1324
1325DCAE 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>`_.
1326
1327Quick Links:
Lusheng Ji768421b2018-06-01 16:36:54 -04001328 - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1329
1330 - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1331
VENKATESH KUMARe21c8482020-11-12 15:00:02 -05001332 - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
Lusheng Ji768421b2018-06-01 16:36:54 -04001333
1334
Lusheng Jib2a561b2018-03-27 23:24:33 -04001335
1336**Upgrade Notes**
1337
Lusheng Ji768421b2018-06-01 16:36:54 -04001338The following components are upgraded from R1:
1339 - Cloudify Manager:
1340 - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
1341 - 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 +02001342 - Bootstrap container:
Lusheng Ji768421b2018-06-01 16:36:54 -04001343 - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
Lusheng Jieaac78d2018-06-06 00:20:03 -04001344 - 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 +02001345 - Configuration Binding Service:
Lusheng Ji768421b2018-06-01 16:36:54 -04001346 - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
1347 - Description: Configuration Binding Sevice now supports the new configuration policy format.
1348 - Deployment Handler
1349 - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
1350 - Policy Handler
1351 - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
1352 - Description: Policy Handler now supports the new configuration policy format.
1353 - Service Change Handler
1354 - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
1355 - Description: Refactoring.
1356 - Inventory API
1357 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
1358 - Description: Refactoring.
1359 - VES Collector
1360 - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
1361 - Threshold Crossing Analytics
1362 - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1363 - 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.
1364
Lusheng Jib2a561b2018-03-27 23:24:33 -04001365
1366
Lusheng Ji8fafa432017-11-06 21:52:26 -05001367Version: 1.0.0
VENKATESH KUMAR64559742020-04-29 18:53:53 -04001368==============
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001369
Lusheng Ji8fafa432017-11-06 21:52:26 -05001370:Release Date: 2017-11-16
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001371
1372
1373**New Features**
1374
Lusheng Ji8fafa432017-11-06 21:52:26 -05001375DCAE is the data collection and analytics sub-system of ONAP. Under ONAP Release 1 the DCAE
1376sub-system includes both platform components and DCAE service components. Collectively the ONAP R1
1377DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
1378vDNS, vCPU, and vVoLTE.
1379
1380Specifically, DCAE R1 includes the following components:
1381
1382- Core platform
1383 - Cloudify manager
1384 - Consul cluster
1385- Extended platform
1386 - Platform component docker host
1387 - Service component docker host
1388 - CDAP cluster
1389 - PostgreSQL database (*)
1390- Platform docker container components
1391 - Configuration binding service
1392 - Deployment handler
1393 - Service change handler
1394 - Inventory
1395 - Policy handler
1396 - CDAP broker
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001397- Service components
Lusheng Ji8fafa432017-11-06 21:52:26 -05001398 - Docker container components
1399 - VNF Event Streaming (VES) collector
Vijay0fbc6732017-11-08 13:55:01 +00001400 - Holmes (engine and rule management) **
Lusheng Ji8fafa432017-11-06 21:52:26 -05001401 - CDAP analytics component
Vijay0fbc6732017-11-08 13:55:01 +00001402 - Threshold Crossing Analytics (TCA)
Lusheng Ji8fafa432017-11-06 21:52:26 -05001403
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001404(*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
1405VM configuration as a shared PostgreSQL database for the R1 demos. (CCSDK PostgreSQL supports
Lusheng Ji8fafa432017-11-06 21:52:26 -05001406other deployment configurations not used in the R1 demos.)
Krzysztof Opasiakbb4a38a2019-05-27 17:46:11 +02001407(**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
Lusheng Ji8fafa432017-11-06 21:52:26 -05001408in R1.
1409
1410Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1411
1412- dcaegen2
1413- dcaegen2/analytics
1414- dcaegen2/analytics/tca
1415- dcaegen2/collectors
1416- dcaegen2/collectors/snmptrap
1417- dcaegen2/collectors/ves
1418- dcaegen2/deployments
1419- dcaegen2/platform
1420- dcaegen2/platform/blueprints
1421- dcaegen2/platform/cdapbroker
1422- dcaegen2/platform/cli
1423- dcaegen2/platform/configbinding
1424- dcaegen2/platform/deployment-handler
1425- dcaegen2/platform/inventory-api
1426- dcaegen2/platform/plugins
1427- dcaegen2/platform/policy-handler
1428- dcaegen2/platform/servicechange-handler
1429- dcaegen2/utils
1430
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001431
1432**Bug Fixes**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001433
1434This is the initial release.
1435
1436
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001437**Known Issues**
Lusheng Ji8fafa432017-11-06 21:52:26 -05001438
1439- Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1440- Need to provide a dev configuration DCAE.
1441
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001442
1443**Security Issues**
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001444
ankatare30c4cb42018-09-28 14:26:59 +05301445- 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 -04001446- 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.
1447
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001448
1449**Upgrade Notes**
1450
Lusheng Ji8fafa432017-11-06 21:52:26 -05001451This is the initial release.
1452
1453
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001454**Deprecation Notes**
1455
Lusheng Ji8fafa432017-11-06 21:52:26 -05001456There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system. The GEN1
1457DCAE is deprecated by the R1 release. The DCAE included in ONAP R1 is also known as DCAE GEN2. The
1458following Gerrit repos are voided and already locked as read-only.
1459
1460- dcae
1461- dcae/apod
1462- dcae/apod/analytics
1463- dcae/apod/buildtools
1464- dcae/apod/cdap
1465- dcae/collectors
1466- dcae/collectors/ves
1467- dcae/controller
1468- dcae/controller/analytics
1469- dcae/dcae-inventory
1470- dcae/demo
1471- dcae/demo/startup
1472- dcae/demo/startup/aaf
1473- dcae/demo/startup/controller
1474- dcae/demo/startup/message-router
1475- dcae/dmaapbc
1476- dcae/operation
1477- dcae/operation/utils
1478- dcae/orch-dispatcher
1479- dcae/pgaas
1480- dcae/utils
1481- dcae/utils/buildtools
1482- ncomp
1483- ncomp/cdap
1484- ncomp/core
1485- ncomp/docker
1486- ncomp/maven
1487- ncomp/openstack
1488- ncomp/sirius
1489- ncomp/sirius/manager
1490- ncomp/utils
1491
1492
Lusheng Ji72c4fba2017-10-10 18:12:22 +00001493**Other**
1494
Vijay0fbc6732017-11-08 13:55:01 +00001495SNMP trap collector is seed code delivery only.