[Docs] Updated R8 release notes - manual collector installation
[dcaegen2.git] / docs / sections / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved.
4 .. Modification Copyright 2021 Nokia Solutions and Networks.
5 .. _release_notes:
6
7
8
9 ==================
10 DCAE Release Notes
11 ==================
12
13 .. contents::
14     :depth: 2
15 ..
16
17
18 ..      ==========================
19 ..      * * *    HONOLULU    * * *
20 ..      ==========================
21
22
23 Version: 8.0.0
24 ==============
25
26
27 Abstract
28 --------
29
30 This document provides the release notes for Honolulu release.
31
32 Summary
33 -------
34
35 Following DCAE components are available with default ONAP/DCAE installation.
36
37     - Platform components
38
39         - Cloudify Manager (helm chart)
40         - Bootstrap container (helm chart)
41         - Configuration Binding Service (helm chart)
42         - Deployment Handler (helm chart)
43         - Policy Handler (helm chart
44         - Service Change Handler (helm chart)
45         - Inventory API (helm chart)
46         - Dashboard (helm chart)
47         - VES OpenAPI Manager (helm chart)
48
49     - Service components
50
51         - VES Collector (helm chart  & cloudify blueprint)
52         - HV-VES Collector (helm chart  & cloudify blueprint)
53         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
54         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
55         - Holmes Rule Management (helm chart  & cloudify blueprint)
56         - Holmes Engine Management (helm chart  & cloudify blueprint)
57
58     - Additional resources that DCAE utilizes deployed using ONAP common charts:
59
60         - Postgres Database
61         - Mongo Database
62         - Consul Cluster
63
64 Below service components (mS) are available to be deployed on-demand (through Cloudify Blueprint)
65
66         - SNMPTrap Collector
67         - RESTConf Collector
68         - DataFile Collector
69         - PM-Mapper 
70         - BBS-EventProcessor
71         - VES Mapper
72         - Heartbeat mS
73         - SON-Handler
74         - PM-Subscription Handler
75         - DataLake Handler (Admin and Feeder)
76         - Slice Analysis mS
77         - DataLake Extraction Service
78         - KPI-Ms
79
80     Notes:
81
82         \*  These components are delivered by the Holmes project.
83
84
85
86 Under OOM (Kubernetes) all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE components are deployed using combination of Helm charts and Cloudify blueprint as noted above. 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.
87
88
89 Release Data
90 ------------
91
92 +--------------------------------------+--------------------------------------------------------+
93 | **DCAE Project**                     |                                                        |
94 |                                      |                                                        |
95 +--------------------------------------+--------------------------------------------------------+
96 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
97 |                                      |                                                        |
98 +--------------------------------------+--------------------------------------------------------+
99 | **Release designation**              | 8.0.0 Honolulu                                         |
100 |                                      |                                                        |
101 +--------------------------------------+--------------------------------------------------------+
102 | **Release date**                     | 2021-04-01                                             |
103 |                                      |                                                        |
104 +--------------------------------------+--------------------------------------------------------+
105
106
107 New features
108 ------------
109
110 - DCAE Enhancements
111
112
113 Functional Updates
114
115    - (New) VES-Openapi-Manager component added to DCAE, allowing to notify of missing openAPI description, at xNF distribution phase
116    - Added VES 7.2.1 support in VESCollector
117    - DCAE MS deployment through helm (common template defined for easier migration of DCAE services)
118    - (New) KPI-Computation MS introduced for support for E2E Slicing Usecase
119    - K8S configMap support through onboarding/design/deployment via DCAE-MOD and DCAE-Platform
120    - BP-generation Enhancements (Native-kafka support/Config-map)
121    - CFY plugin enhancements (support IPV6 service exposure + Config-Map + Cert-Manager's CMPv2 issuer integration)
122    - DCAE SDK enhancement (Dmaap Client update for timeout/retry + CBS client update)
123    - DFC enhancement - support in HTTP/HTTPS/enroll certificate from CMPv2 server
124
125 Non-Functional
126    - DCAE Cloudify py3 upgrade (including plugins/bootstrap cli)
127    - CII Badging improvements
128    - Policy-Handler Py3 upgrade
129    - Vulnerability updates for several DCAE MS (DataFile Collector, RESTConf, VESCollector, InventoryAPI, MOD/RuntimeAPI, VES-mapper, PM-Mapper, PRH, SON-Handler)
130    - Code Coverage improvement (DataFile, SDK, Blueprint-generator, Plugins, Acumos Adapter)
131    - Documentation/user-guide updates
132
133 Bug Fixes
134
135    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
136    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
137
138
139 - Following new services are delivered this release
140     - VES OpenAPI Manager
141     - Analytics/RCA
142         - KPI MS
143
144 .. _honolulu_deliverable:
145
146 Deliverables
147 ------------
148
149 Software Deliverables
150
151 .. csv-table::
152    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
153    :widths: auto
154
155    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
156    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.5.5"
157    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
158    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.4"
159    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.4"
160    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.8.0"
161    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.4.2"
162    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.0"
163    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
164    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
165    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
166    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.0"
167    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
168    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
169    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
170    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
171    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
172    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
173    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
174    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.4"
175    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.0.3" 
176    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
177    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
178    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
179    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.2"
180    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
181    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
182    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
183    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
184    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
185    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
186    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.4"
187    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
188    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.0"
189    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
190    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.2.0"
191    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.5.2"
192    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.6"
193    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.3"
194    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.7.3 (jar)"
195    "dcaegen2/services/sdk", "", "DCAE SDK 1.7.0 (jar)"
196    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
197
198
199 Known Limitations, Issues and Workarounds
200 -----------------------------------------
201
202 The new, Helm based installation mechanism for collectors doesn`t support yet certain features available with the traditional Cloudify orchestration based mechanisms:
203    - Obtaining X.509 certificates from external CMP v2 server for secure xNF connections
204    - Exposing the Collector port in Dual Stack IPv4/IPv6 networks.
205
206 Such features are available, when the collectors are installed using the Cloudify mechanisms.
207 Refer to collector installation page for more details:
208
209 .. toctree::
210    :maxdepth: 1
211
212    ./services/ves-http/installation.rst
213    ./services/ves-hv/installation.rst
214
215 *Known Vulnerabilities*
216
217 None
218
219 *Workarounds*
220
221 Documented under corresponding jira if applicable.
222
223 Security Notes
224 --------------
225
226 *Fixed Security Issues*
227     Listed above
228
229 *Known Security Issues*
230     None
231
232 *Known Vulnerabilities in Used Modules*
233     None
234         
235 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
236
237 Test Results
238 ------------
239
240  - `DCAE R8 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Honolulu+Release>`_
241  - `DCAE R8 Functional Test <https://wiki.onap.org/display/DW/DCAE+R8+Testplan>`_
242
243
244 References
245 ----------
246
247 For more information on the ONAP Honolulu release, please see:
248
249 #. `ONAP Home Page`_
250 #. `ONAP Documentation`_
251 #. `ONAP Release Downloads`_
252 #. `ONAP Wiki Page`_
253
254
255 .. _`ONAP Home Page`: https://www.onap.org
256 .. _`ONAP Wiki Page`: https://wiki.onap.org
257 .. _`ONAP Documentation`: https://docs.onap.org
258 .. _`ONAP Release Downloads`: https://git.onap.org
259
260 Quick Links:
261
262         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
263         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
264
265
266 ..      ===================================
267 ..      * * *    GUILIN  MAINTENANCE  * * *
268 ..      ===================================
269
270
271 Version: 7.0.1
272 ==============
273
274 Abstract
275 --------
276
277 This document provides the release notes for the Guilin Maintenance release
278
279
280 Summary
281 -------
282
283 This maintenance release is primarily to resolve bugs identified during Guilin release testing.
284
285
286 Release Data
287 ------------
288
289 +--------------------------------------+--------------------------------------+
290 | **Project**                          | DCAE                                 |
291 |                                      |                                      |
292 +--------------------------------------+--------------------------------------+
293 | **Docker images**                    | onap/org.onap.dcaegen2.collectors    |
294 |                                      |   .hv-ves.hv-collector-main:1.5.1    |
295 +--------------------------------------+--------------------------------------+
296 | **Release designation**              | Guilin Maintenance Release           |
297 |                                      |                                      |
298 +--------------------------------------+--------------------------------------+
299 | **Release date**                     | 2021/02/11                           |
300 |                                      |                                      |
301 +--------------------------------------+--------------------------------------+
302
303 New features
304 ------------
305
306 None
307
308 **Bug fixes**
309
310 - `DCAEGEN2-2516 <https://jira.onap.org/browse/DCAEGEN2-2516>`_ HV-VES Pod recovery when config-fetch fails
311 - `OOM-2641 <https://jira.onap.org/browse/OOM-2641>`_ Fix DCAEMOD paths based on Guilin ingress template
312
313 **Known Issues**
314
315 Same as Guilin Release
316
317
318 ..      ========================
319 ..      * * *    GUILIN    * * *
320 ..      ========================
321
322
323 Version: 7.0.0
324 ==============
325
326
327 Abstract
328 --------
329
330 This document provides the release notes for Guilin release.
331
332 Summary
333 -------
334
335 Following DCAE components are available with default ONAP/DCAE installation.
336
337     - Platform components
338
339         - Cloudify Manager (helm chart)
340         - Bootstrap container (helm chart)
341         - Configuration Binding Service (helm chart)
342         - Deployment Handler (helm chart)
343         - Policy Handler (helm chart
344         - Service Change Handler (helm chart)
345         - Inventory API (helm chart)
346         - Dashboard (helm chart)
347
348     - Service components
349
350         - VES Collector
351         - HV-VES Collector
352         - PNF-Registration Handler
353         - Docker based Threshold Crossing Analytics (TCA-Gen2)
354         - Holmes Rule Management *
355         - Holmes Engine Management *
356
357     - Additional resources that DCAE utilizes deployed using ONAP common charts:
358     
359         - Postgres Database
360         - Mongo Database
361         - Redis Cluster Database
362         - Consul Cluster 
363
364 Below service components (mS) are available to be deployed on-demand.
365
366         - SNMPTrap Collector
367         - RESTConf Collector
368         - DataFile Collector
369         - PM-Mapper 
370         - BBS-EventProcessor
371         - VES Mapper
372         - Heartbeat mS
373         - SON-Handler
374         - PM-Subscription Handler
375         - DataLake Handler (Admin and Feeder)
376         - Slice Analysis
377         - DataLake Extraction Service
378
379     Notes:
380
381         \*  These components are delivered by the Holmes project.
382
383
384
385 Under 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.
386
387
388 Release Data
389 ------------
390
391 +--------------------------------------+--------------------------------------------------------+
392 | **DCAE Project**                     |                                                        |
393 |                                      |                                                        |
394 +--------------------------------------+--------------------------------------------------------+
395 | **Docker images**                    | Refer :any:`Deliverable <guilin_deliverable>`          |
396 |                                      |                                                        |
397 +--------------------------------------+--------------------------------------------------------+
398 | **Release designation**              | 7.0.0 Guilin                                           |
399 |                                      |                                                        |
400 +--------------------------------------+--------------------------------------------------------+
401 | **Release date**                     | 2020-11-19                                             |
402 |                                      |                                                        |
403 +--------------------------------------+--------------------------------------------------------+
404
405
406 New features
407 ------------
408
409 - DCAE Enhancements
410
411     - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262)
412     - Bootstrap container optimization  (DCAEGEN2-1791)
413     - MOD/Runtime â€“ Enable configuration for dynamic topic support (DCAEGEN2-1996)
414     - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221)
415     - DCAE Dashboard UI Optimization  and bugfixes (DCAEGEN2-2223, DCAEGEN2-2364,DCAEGEN2-1638,DCAEGEN2-2298, DCAEGEN2-1857)
416     - Blueprint generator tool and K8Splugin enhancement to support External Certificate (DCAEGEN2-2250)
417     - K8S v1.17 support through DCAE Cloudify K8S plugins (DCAEGEN2-2309)
418     - Python 3.8 support enabled for several DCAE components - Heartbeat mS, PMSH mS, MOD/DistriubtorAPI mS, MOD/OnboardingAPI mS, Policy Library (DCAEGEN2-2292)
419     - 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)
420     - Hardcoded password removed from OOM charts - Cloudify, Bootstrap, DeploymentHandler, Dashboard; now managed dynamically through K8S secret (DCAEGEN2-1972, DCAEGEN2-1975)
421     - Best practice compliance
422          - STDOUT log compliance for DCAE Containers (DCAEGEN2-2324)
423          - No more than one main process (DCAEGEN2-2327/REQ-365)
424          - Container must crash when failure is noted (DCAEGEN2-2326/REQ-366)
425          - All containers must run as non-root (REQ-362)
426          - Code coverage >55% (DCAEGEN2-2333)
427     - All Vulnerability identified by SECCOM has been resolved (DCAEGEN2-2242)
428  
429
430 - Following new services are delivered this release
431
432     - Event Processors
433         - DataLake Extraction Service 
434        
435     - Analytics/RCA
436         - Slice Analysis MS
437         
438 .. _guilin_deliverable:
439
440 Deliverables
441 ------------
442
443 Software Deliverables
444
445 .. csv-table::
446    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
447    :widths: auto
448
449    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
450    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.4.3"
451    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
452    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.2"
453    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
454    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9"
455    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:3.3.4"
456    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
457    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
458    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
459    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
460    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
461    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.3"
462    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
463    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
464    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
465    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
466    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
467    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.1.1"
468    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.3"
469    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:2.1.8" 
470    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
471    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
472    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.1"  
473    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
474    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
475    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
476    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
477    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
478    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
479    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.1"
480    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
481    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
482    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0"
483    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.4.1"
484    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.4"
485    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.2"
486    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.5.2 (jar)"
487    "dcaegen2/services/sdk", "", "DCAE SDK 1.4.3 (jar)"
488    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
489         
490
491 Known Limitations, Issues and Workarounds
492 -----------------------------------------
493
494     * BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
495     * Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
496     * HV-VES - Pod recovery when config-fetch fails (DCAEGEN2-2516)
497     
498
499 *System Limitations*
500
501 None
502
503 *Known Vulnerabilities*
504
505 None
506
507 *Workarounds*
508
509 Documented under corresponding jira if applicable.
510
511 Security Notes
512 --------------
513
514 *Fixed Security Issues*
515     Listed above
516     
517 *Known Security Issues*
518
519         None
520         
521         
522 *Known Vulnerabilities in Used Modules*
523
524         None
525         
526 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
527
528 Test Results
529 ------------
530
531  - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
532  - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
533
534
535 References
536 ----------
537
538 For more information on the ONAP Guilin release, please see:
539
540 #. `ONAP Home Page`_
541 #. `ONAP Documentation`_
542 #. `ONAP Release Downloads`_
543 #. `ONAP Wiki Page`_
544
545
546 .. _`ONAP Home Page`: https://www.onap.org
547 .. _`ONAP Wiki Page`: https://wiki.onap.org
548 .. _`ONAP Documentation`: https://docs.onap.org
549 .. _`ONAP Release Downloads`: https://git.onap.org
550
551 Quick Links:
552
553         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
554         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
555
556
557
558
559 ..      ======================================
560 ..      * * *    EL-ALTO  MAINTENANCE  * * *
561 ..      ======================================
562
563
564 Version: 5.0.2
565 ==============
566
567 Abstract
568 --------
569
570 This document provides the release notes for the El-Alto Maintenance release
571
572
573 Summary
574 -------
575
576 This maintenance release is primarily to update expired certificates 
577 from original El-Alto released TLS-init container.
578
579 This patch is not required for Frankfurt release (and beyond) as certificates are dynamically 
580 retrieved from AAF at deployment time for all DCAE components.
581
582 Release Data
583 ------------
584
585 +--------------------------------------+--------------------------------------+
586 | **Project**                          | DCAE                                 |
587 |                                      |                                      |
588 +--------------------------------------+--------------------------------------+
589 | **Docker images**                    | onap/org.onap.dcaegen2.deployments   |
590 |                                      |   .tls-init-container:1.0.4          |
591 +--------------------------------------+--------------------------------------+
592 | **Release designation**              | El-Alto  Maintenance Release         |
593 |                                      |                                      |
594 +--------------------------------------+--------------------------------------+
595 | **Release date**                     | 2020/08/24                           |
596 |                                      |                                      |
597 +--------------------------------------+--------------------------------------+
598
599 New features
600 ------------
601
602 None
603
604 **Bug fixes**
605
606 - `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration
607
608 **Known Issues**
609 Same as El-Alto Release
610
611
612
613 ..      ======================================
614 ..      * * *    FRANKFURT  MAINTENANCE  * * *
615 ..      ======================================
616
617
618 Version: 6.0.1
619 ==============
620
621 Abstract
622 --------
623
624 This document provides the release notes for the Frankfurt Maintenance release
625
626
627 Summary
628 -------
629
630 The focus of this release is to correct issues found on Frankfurt release.
631
632 Release Data
633 ------------
634
635 +--------------------------------------+--------------------------------------+
636 | **Project**                          | DCAE                                 |
637 |                                      |                                      |
638 +--------------------------------------+--------------------------------------+
639 | **Docker images**                    | onap/org.onap.dcaegen2.services.     |
640 |                                      |   son-handler:2.0.4                  |
641 +--------------------------------------+--------------------------------------+
642 | **Release designation**              | Frankfurt  Maintenance Release 1     |
643 |                                      |                                      |
644 +--------------------------------------+--------------------------------------+
645 | **Release date**                     | 2020/08/17                           |
646 |                                      |                                      |
647 +--------------------------------------+--------------------------------------+
648
649 New features
650 ------------
651
652 None
653
654 **Bug fixes**
655
656 - `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof
657 - `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification  to align with policy component updates
658
659 **Known Issues**
660
661 Same as Frankfurt Release
662
663
664
665
666 ..      ===========================
667 ..      * * *    FRANKFURT    * * *
668 ..      ===========================
669
670
671 Version: 6.0.0
672 ==============
673
674
675 Abstract
676 --------
677
678 This document provides the release notes for the Frankfurt release.
679
680 Summary
681 -------
682
683 Following DCAE components are available with default ONAP/DCAE installation.
684
685     - Platform components
686
687         - Cloudify Manager (helm chart)
688         - Bootstrap container (helm chart)
689         - Configuration Binding Service (helm chart)
690         - Deployment Handler (helm chart)
691         - Policy Handler (helm chart
692         - Service Change Handler (helm chart)
693         - Inventory API (helm chart)
694         - Dashboard (helm chart)
695
696     - Service components
697
698         - VES Collector
699         - Threshold Crossing Analytics (TCA/CDAP)
700         - HV-VES Collector
701         - PNF-Registration Handler
702         - Docker based Threshold Crossing Analytics (TCA-Gen2)
703         - Holmes Rule Management *
704         - Holmes Engine Management *
705
706     - Additional resources that DCAE utilizes deployed using ONAP common charts:
707     
708         - Postgres Database
709         - Mongo Database
710         - Redis Cluster Database
711         - Consul Cluster 
712
713 Below service components (mS) are available to be deployed on-demand.
714
715         - SNMPTrap Collector
716         - RESTConf Collector
717         - DataFile Collector
718         - PM-Mapper 
719         - BBS-EventProcessor
720         - VES Mapper
721         - Heartbeat mS
722         - SON-Handler
723         - PM-Subscription Handler
724
725     Notes:
726
727         \*  These components are delivered by the Holmes project.
728
729
730
731 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
732
733
734 Release Data
735 ------------
736
737 +--------------------------------------+--------------------------------------------------------+
738 | **DCAE Project**                     |                                                        |
739 |                                      |                                                        |
740 +--------------------------------------+--------------------------------------------------------+
741 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
742 |                                      |                                                        |
743 +--------------------------------------+--------------------------------------------------------+
744 | **Release designation**              | 6.0.0 frankfurt                                        |
745 |                                      |                                                        |
746 +--------------------------------------+--------------------------------------------------------+
747 | **Release date**                     | 2020-06-04                                             |
748 |                                      |                                                        |
749 +--------------------------------------+--------------------------------------------------------+
750
751
752 New features
753 ------------
754
755 - DCAE Platform Enhancement
756
757     - Introduction of Microservice and Onboarding Design (MOD) platform 
758     - Policy Notification support for DCAE components
759     - Dynamic AAF certificate creation during component instantiation
760     - Helm chart optimization to control each platform component separate
761     - Dashboard Optimization 
762     - Blueprint generator tool to simplify deployment artifact creation
763    
764
765 - Following new services are delivered this release
766
767     - Event Processors
768     
769         - PM Subscription Handler
770         - DataLake Handlers 
771     - Analytics/RCA
772     
773         - TCA-GEN2
774         
775         - Acumos Adapter (PoC)
776
777 .. _frankfurt_deliverable:
778
779 Deliverables
780 ------------
781
782 Software Deliverables
783
784 .. csv-table::
785    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
786    :widths: auto
787
788    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
789    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
790    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
791    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
792    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
793    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
794    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
795    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
796    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
797    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
798    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
799    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
800    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
801    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
802    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
803    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
804    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
805    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
806    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
807    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
808    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
809    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6" 
810    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
811    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
812    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"  
813    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
814    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
815    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
816    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
817    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
818    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
819    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
820    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
821    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
822    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
823    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
824    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
825    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
826    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
827    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
828         
829
830 Known Limitations, Issues and Workarounds
831 -----------------------------------------
832
833     * Blueprint generator escape char issue (DCAEGEN2-2140)
834     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
835     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
836
837
838
839 *System Limitations*
840
841 None
842
843 *Known Vulnerabilities*
844
845 None
846
847 *Workarounds*
848
849 Documented under corresponding jira if applicable.
850
851 Security Notes
852 --------------
853
854 *Fixed Security Issues*
855
856     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
857     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
858     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
859     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
860     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
861
862     
863 *Known Security Issues*
864
865         None
866         
867         
868 *Known Vulnerabilities in Used Modules*
869
870         None
871         
872 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
873
874 Test Results
875 ------------
876
877  - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
878  - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
879
880
881 References
882 ----------
883
884 For more information on the ONAP Frankfurt release, please see:
885
886 #. `ONAP Home Page`_
887 #. `ONAP Documentation`_
888 #. `ONAP Release Downloads`_
889 #. `ONAP Wiki Page`_
890
891
892 .. _`ONAP Home Page`: https://www.onap.org
893 .. _`ONAP Wiki Page`: https://wiki.onap.org
894 .. _`ONAP Documentation`: https://docs.onap.org
895 .. _`ONAP Release Downloads`: https://git.onap.org
896
897 Quick Links:
898
899         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
900         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
901
902
903 ..      =========================
904 ..      * * *    EL-ALTO    * * *
905 ..      =========================
906
907
908 Version: 5.0.1
909 ==============
910
911 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
912
913 Following is summary of updates done for DCAEGEN2
914
915 **Security**
916
917 Following platform components were enabled for HTTPS
918     - ConfigBindingService (CBS)
919       -   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>`_
920     - Cloudify Manager
921     - InventoryAPI
922     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
923
924 All components interfacing with platform components were modified to support TLS interface
925
926 **Miscellaneous**
927     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
928     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
929     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
930     - CBS client libraries updated to remove consul service lookup
931     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
932
933
934
935 With this release, all DCAE platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/DCAE installation.
936     - Platform components
937         - Cloudify Manager (helm chart)
938         - Bootstrap container (helm chart)
939         - Configuration Binding Service (helm chart)
940         - Deployment Handler (helm chart)
941         - Policy Handler (helm chart
942         - Service Change Handler (helm chart)
943         - Inventory API (helm chart)
944         - Dashboard (helm charts)
945     - Service components
946         - VES Collector
947         - SNMP Collector
948         - Threshold Crossing Analytics
949         - HV-VES Collector
950         - PNF-Registration Handler
951         - Holmes Rule Management *
952         - Holmes Engine Management *
953     - Additional resources that DCAE utilizes:
954         - Postgres Database
955         - Redis Cluster Database
956         - Consul Cluster *
957
958     Notes:
959         \*  These components are delivered by external ONAP project.
960
961 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
962
963     - Collectors
964         - RESTConf collector 
965         - DataFile collector
966     - Event Processors
967         - VES Mapper
968         - 3gpp PM-Mapper
969         - BBS Event processor
970     - Analytics/RCA
971         - SON-Handler
972         - Missing Heartbeat Ms
973
974 - All DCAE components are designed to support platform maturity requirements.
975
976
977 **Source Code**
978
979 Source code of DCAE components are released under the following repositories on gerrit.onap.org; there is no new component introduced for El-Alto Early-drop.
980     - dcaegen2
981     - dcaegen2.analytics.tca
982     - dcaegen2.collectors.snmptrap
983     - dcaegen2.collectors.ves
984     - dcaegen2.collectors.hv-ves
985     - dcaegen2.collectors.datafile
986     - dcaegen2.collectors.restconf
987     - dcaegen2.deployments
988     - dcaegen2.platform.blueprints
989     - dcaegen2.platform.cli
990     - dcaegen2.platform.configbinding
991     - dcaegen2.platform.deployment-handler
992     - dcaegen2.platform.inventory-api
993     - dcaegen2.platform.plugins
994     - dcaegen2.platform.policy-handler
995     - dcaegen2.platform.servicechange-handler
996     - dcaegen2.services.heartbeat
997     - dcaegen2.services.mapper
998     - dcaegen2.services.pm-mapper
999     - dcaegen2.services.prh
1000     - dcaegen2.services.son-handler
1001     - dcaegen2.services
1002     - dcaegen2.services.sdk
1003     - dcaegen2.utils
1004     - ccsdk.platform.plugins
1005     - ccsdk.dashboard
1006
1007 **Bug Fixes**
1008     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1009     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1010
1011
1012 **Known Issues**
1013     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1014
1015 **Security Notes**
1016
1017 *Fixed Security Issues*
1018     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1019     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1020     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1021     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1022     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1023
1024 *Known Security Issues*
1025     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1026     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1027     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1028     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1029     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1030
1031 *Known Vulnerabilities in Used Modules*
1032
1033 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
1034
1035 Quick Links:
1036         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1037
1038         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1039
1040         - `Project Vulnerability Review Table for DCAE (El-Alto Maintenance) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1041
1042
1043 **Upgrade Notes**
1044
1045 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
1046     - K8S Bootstrap container:
1047        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
1048        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
1049     - Configuration Binding Service:
1050        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
1051        - Description: HTTPS support, Image optimization and non-root user
1052     - Inventory API
1053        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
1054        - Description: HTTPS support, container optmization and non-root user
1055     - DataFile Collector
1056        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
1057        - Description : Code optimization, bug fixes, dmaap plugin integration
1058     - SON Handler MS
1059        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
1060        - Description : Image optimization, bug fixes, CBS integration
1061     - VES Adapter/Mapper MS
1062        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
1063        - Description : Image optimization & CBS periodic polling
1064     - PRH MS
1065        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
1066        - Description : Code optimization, bug fixes and SDK alignment
1067     - HV-VES MS
1068        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
1069        - Description : Code optimization, bug fixes and SDK alignment
1070
1071 Version: 5.0.0
1072 ==============
1073
1074 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
1075
1076 Following is summary of updates done for DCAEGEN2
1077
1078 **Security**
1079
1080 Following platform components were enabled for HTTPS
1081     - ConfigBindingService (CBS)
1082       -   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>`_
1083     - Cloudify Manager
1084     - InventoryAPI
1085
1086 All components interfacing with platform components were modified to support TLS interface
1087
1088 **Miscellaneous**
1089     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
1090     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
1091     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
1092     - CBS client libraries updated to remove consul service lookup
1093
1094
1095
1096 **Bug Fixes**
1097     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1098     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1099
1100
1101 **Known Issues**
1102     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1103
1104
1105 **Security Notes**
1106
1107 *Fixed Security Issues*
1108
1109 *Known Security Issues*
1110
1111     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1112     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1113     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1114     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1115     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1116     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1117     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1118     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1119     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1120     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1121
1122 *Known Vulnerabilities in Used Modules*
1123
1124 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
1125
1126 Quick Links:
1127         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1128
1129         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1130
1131         - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1132
1133
1134 **Upgrade Notes**
1135
1136 The following components are upgraded from Dublin/R4.
1137     - Cloudify Manager:
1138        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
1139        - 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.
1140     - K8S Bootstrap container:
1141        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
1142        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
1143     - Configuration Binding Service:
1144        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
1145        - Description: HTTPS support, Image optimization and non-root user
1146     - Deployment Handler
1147        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
1148        - Description: Update to node10, uninstall workflow updates
1149     - Service Change Handler
1150        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
1151        - Description: HTTPS inventoryAPI support, container optmization and non-root user
1152     - Inventory API
1153        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
1154        - Description: HTTPS support, container optmization and non-root user
1155     - DataFile Collector
1156        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
1157        - Description : Code optimization, bug fixes, dmaap plugin integration
1158     - 3gpp PM-Mapper
1159        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
1160        - Description: Code optimization, bug fixes, dmaap plugin integration
1161
1162
1163
1164 Version: 4.0.0
1165 ==============
1166
1167 :Release Date: 2019-06-06
1168
1169 **New Features**
1170
1171 DCAE R4 improves upon previous release with the following new features:
1172
1173 - DCAE Platform Enhancement
1174     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
1175     - Support helm chart deployment in DCAE using new Helm cloudify plugin
1176     - DCAE Healthcheck enhancement to cover static and dynamic deployments
1177     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
1178     - Dashboard Integration (UI for deployment/verification)
1179     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
1180     - Blueprint generator tool to simplify deployment artifact creation
1181     - Cloudify Manager resiliency
1182
1183 - Following new services are delivered with Dublin
1184     - Collectors
1185         - RESTConf collector 
1186     - Event Processors
1187         - VES Mapper
1188         - 3gpp PM-Mapper
1189         - BBS Event processor
1190     - Analytics/RCA
1191         - SON-Handler
1192         - Heartbeat MS
1193
1194 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
1195     - Platform components
1196         - Cloudify Manager (helm chart)
1197         - Bootstrap container (helm chart)
1198         - Configuration Binding Service (helm chart)
1199         - Deployment Handler (helm chart)
1200         - Policy Handler (helm chart
1201         - Service Change Handler (helm chart)
1202         - Inventory API (helm chart)
1203         - Dashboard (Cloudify Blueprint)
1204     - Service components
1205         - VES Collector
1206         - SNMP Collector
1207         - Threshold Crossing Analytics
1208         - HV-VES Collector
1209         - PNF-Registration Handler
1210         - Holmes Rule Management *
1211         - Holmes Engine Management *
1212     - Additional resources that DCAE utilizes:
1213         - Postgres Database
1214         - Redis Cluster Database
1215         - Consul Cluster *
1216
1217     Notes:
1218         \*  These components are delivered by the Holmes project.
1219
1220
1221 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE R3 includes enhancement to Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
1222
1223 - All DCAE components are designed to support platform maturity requirements.
1224
1225
1226 **Source Code**
1227
1228 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1229     - dcaegen2
1230     - dcaegen2.analytics.tca
1231     - dcaegen2.collectors.snmptrap
1232     - dcaegen2.collectors.ves
1233     - dcaegen2.collectors.hv-ves
1234     - dcaegen2.collectors.datafile
1235     - dcaegen2.collectors.restconf
1236     - dcaegen2.deployments
1237     - dcaegen2.platform.blueprints
1238     - dcaegen2.platform.cli
1239     - dcaegen2.platform.configbinding
1240     - dcaegen2.platform.deployment-handler
1241     - dcaegen2.platform.inventory-api
1242     - dcaegen2.platform.plugins
1243     - dcaegen2.platform.policy-handler
1244     - dcaegen2.platform.servicechange-handler
1245     - dcaegen2.services.heartbeat
1246     - dcaegen2.services.mapper
1247     - dcaegen2.services.pm-mapper
1248     - dcaegen2.services.prh
1249     - dcaegen2.services.son-handler
1250     - dcaegen2.services
1251     - dcaegen2.services.sdk
1252     - dcaegen2.utils
1253     - ccsdk.platform.plugins
1254     - ccsdk.dashboard
1255
1256 **Bug Fixes**
1257
1258 **Known Issues**
1259     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1260
1261
1262 **Security Notes**
1263
1264 *Fixed Security Issues*
1265
1266 *Known Security Issues*
1267
1268     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1269     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1270     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1271     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1272     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1273     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1274     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1275     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1276     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1277     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1278
1279 *Known Vulnerabilities in Used Modules*
1280
1281 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
1282
1283 Quick Links:
1284         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1285
1286         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1287
1288         - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
1289
1290
1291 **New component Notes**
1292 The following components are introduced in R4
1293
1294     - Dashboard
1295        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
1296        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
1297     - Blueprint generator
1298        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
1299        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
1300     - RESTConf collector 
1301        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
1302        - Description: Provides RESTConf interfaces to events from external domain controllers
1303     - VES/Universal Mapper
1304        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
1305        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
1306     - 3gpp PM-Mapper
1307        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
1308        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
1309     - BBS Event processor
1310        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
1311        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
1312     - SON-Handler
1313        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
1314        - Description: Supports PC-ANR optimization analysis and generating CL events output
1315     - Heartbeat MS
1316        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
1317        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
1318
1319
1320 **Upgrade Notes**
1321
1322 The following components are upgraded from R3
1323     - Cloudify Manager:
1324        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
1325        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
1326     - K8S Bootstrap container:
1327        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
1328        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
1329     - Configuration Binding Service:
1330        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
1331        - Description: Code optimization and bug fixes
1332     - Deployment Handler
1333        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
1334        - Include updates for health and service endpoint check and bug fixes
1335     - Policy Handler
1336        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
1337        - Description: Policy Handler supports the new lifecycle API's from Policy framework
1338     - Service Change Handler
1339        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1340        - Description: No update from R3
1341     - Inventory API
1342        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
1343        - Description: Refactoring and updates for health and service endpoint check
1344     - VES Collector
1345        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
1346        - Description : Authentication enhancement, refactoring and bug-fixes
1347     - Threshold Crossing Analytics
1348        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
1349        - 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.
1350     - DataFile Collector
1351        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
1352        - Description : Code optimization, bug fixes, logging and performance improvement
1353     - PNF Registrator handler
1354        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
1355        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
1356     - HV-VES Collector
1357        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
1358        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
1359     - SNMP Trap Collector
1360        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
1361        - Description : Code coverage improvements
1362
1363
1364
1365
1366 Version: 3.0.1
1367 ==============
1368
1369 :Release Date: 2019-01-31
1370
1371 DCAE R3 Maintenance release includes following fixes
1372
1373 **Bug Fixes**
1374
1375 - DataFileCollector
1376      - DCAEGEN2-940
1377        Larger files of size 100Kb publish to DR
1378      - DCAEGEN2-941
1379        DFC error after running over 12 hours
1380      - DCAEGEN2-1001
1381        Multiple Fileready notification not handled
1382
1383 - HighVolume VES Collector (protobuf/tcp)
1384      - DCAEGEN2-976
1385        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
1386
1387 - VESCollector (http)
1388      - DCAEGEN2-1035
1389        Issue with VES batch event publish
1390
1391 - Heat deployment
1392      - DCAEGEN2-1007
1393        Removing obsolete services configuration
1394
1395
1396 The following containers are updated in R3.0.1
1397
1398     - DataFile Collector
1399        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
1400     - HV-VES Collector
1401        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
1402     - VES Collector
1403        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
1404
1405 **Known Issues**
1406
1407 - 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
1408
1409 - 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
1410     kubectl get deployments -n onap | grep deployment-handler
1411     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
1412     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
1413
1414
1415
1416
1417 Version: 3.0.0
1418 --------------
1419
1420 :Release Date: 2018-11-30
1421
1422 **New Features**
1423
1424 DCAE R3 improves upon previous release with the following new features:
1425
1426 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
1427     - Platform components
1428         - Cloudify Manager
1429         - Bootstrap container
1430         - Configuration Binding Service
1431         - Deployment Handler
1432         - Policy Handler
1433         - Service Change Handler
1434         - Inventory API
1435     - Service components
1436         - VES Collector
1437         - SNMP Collector
1438         - Threshold Crossing Analytics
1439         - Holmes Rule Management *
1440         - Holmes Engine Management *
1441     - Additional resources that DCAE utilizes:
1442         - Postgres Database
1443         - Redis Cluster Database
1444         - Consul Cluster
1445
1446     Notes:
1447         \*  These components are delivered by the Holmes project.
1448
1449 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
1450
1451     - 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".
1452     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1453
1454 - 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.
1455
1456 - All DCAE components are designed to support platform maturity requirements.
1457
1458
1459 **Source Code**
1460
1461 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1462     - dcaegen2
1463     - dcaegen2.analytics
1464     - dcaegen2.analytics.tca
1465     - dcaegen2.collectors
1466     - dcaegen2.collectors.snmptrap
1467     - dcaegen2.collectors.ves
1468     - dcaegen2.collectors.hv-ves
1469     - dcaegen2.collectors.datafile
1470     - dcaegen2.deployments
1471     - dcaegen2.platform
1472     - dcaegen2.platform.blueprints
1473     - dcaegen2.platform.cli
1474     - dcaegen2.platform.configbinding
1475     - dcaegen2.platform.deployment-handler
1476     - dcaegen2.platform.inventory-api
1477     - dcaegen2.platform.plugins
1478     - dcaegen2.platform.policy-handler
1479     - dcaegen2.platform.servicechange-handler
1480     - dcaegen2.services.heartbeat
1481     - dcaegen2.services.mapper
1482     - dcaegen2.services.prh
1483     - dcaegen2.utils
1484
1485 **Bug Fixes**
1486
1487 **Known Issues**
1488
1489 - 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.
1490
1491 **Security Notes**
1492
1493 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
1494
1495 Quick Links:
1496         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1497
1498         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1499
1500         - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
1501
1502
1503 **New component Notes**
1504 The following components are introduced in R3
1505
1506     - DataFile Collector
1507        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
1508        - Description : Bulk data file collector to fetch non-realtime PM data
1509     - PNF Registrator handler
1510        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
1511        - Description : Recieves VES registration event and updates AAI and SO
1512     - HV-VES Collector
1513        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
1514        - Description : High Volume VES Collector for fetching real-time PM measurement data
1515     - SNMP Trap Collector
1516        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
1517        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
1518
1519
1520 **Upgrade Notes**
1521
1522 The following components are upgraded from R2:
1523     - Cloudify Manager:
1524        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
1525        - 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.
1526     - Bootstrap container:
1527        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
1528        - 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.
1529     - Configuration Binding Service:
1530        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
1531        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
1532     - Deployment Handler
1533        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
1534     - Policy Handler
1535        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
1536        - Description: Policy Handler now supports the new configuration policy format and support for TLS
1537     - Service Change Handler
1538        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
1539        - Description: Refactoring.
1540     - Inventory API
1541        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
1542        - Description: Refactoring.
1543     - VES Collector
1544        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
1545        - Description : Refactoring
1546     - Threshold Crossing Analytics
1547        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1548        - 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.
1549
1550
1551
1552
1553 Version: 2.0.0
1554 ==============
1555
1556 :Release Date: 2018-06-07
1557
1558 **New Features**
1559
1560 DCAE R2 improves upon previous release with the following new features:
1561
1562 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
1563     - Platform components
1564         - Cloudify Manager
1565         - Bootstrap container
1566         - Configuration Binding Service
1567         - Deployment Handler
1568         - Policy Handler
1569         - Service Change Handler
1570         - Inventory API
1571     - Service components
1572         - VES Collector
1573         - SNMP Collector
1574         - Threshold Crossing Analytics
1575         - Holmes Rule Management *
1576         - Holmes Engine Management *
1577     - Additional resources that DCAE utilizes:
1578         - Postgres Database
1579         - Redis Cluster Database
1580         - Consul Cluster
1581
1582     Notes:
1583         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
1584
1585 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
1586
1587     - 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".
1588     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
1589
1590 - 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.
1591
1592 - All DCAE components are designed to support platform maturity requirements.
1593
1594
1595 **Source Code**
1596
1597 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
1598     - dcaegen2
1599     - dcaegen2.analytics
1600     - dcaegen2.analytics.tca
1601     - dcaegen2.collectors
1602     - dcaegen2.collectors.snmptrap
1603     - dcaegen2.collectors.ves
1604     - dcaegen2.deployments
1605     - dcaegen2.platform
1606     - dcaegen2.platform.blueprints
1607     - dcaegen2.platform.cli
1608     - dcaegen2.platform.configbinding
1609     - dcaegen2.platform.deployment-handler
1610     - dcaegen2.platform.inventory-api
1611     - dcaegen2.platform.plugins
1612     - dcaegen2.platform.policy-handler
1613     - dcaegen2.platform.servicechange-handler
1614     - dcaegen2.services.heartbeat
1615     - dcaegen2.services.mapper
1616     - dcaegen2.services.prh
1617     - dcaegen2.utils
1618
1619 **Bug Fixes**
1620
1621 **Known Issues**
1622
1623 - 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.
1624
1625 **Security Notes**
1626
1627 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_.
1628
1629 Quick Links:
1630         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1631
1632         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1633
1634         - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
1635
1636
1637
1638 **Upgrade Notes**
1639
1640 The following components are upgraded from R1:
1641     - Cloudify Manager:
1642        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
1643        - 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.
1644     - Bootstrap container:
1645        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
1646        - 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.
1647     - Configuration Binding Service:
1648        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
1649        - Description: Configuration Binding Sevice now supports the new configuration policy format.
1650     - Deployment Handler
1651        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
1652     - Policy Handler
1653        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
1654        - Description: Policy Handler now supports the new configuration policy format.
1655     - Service Change Handler
1656        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
1657        - Description: Refactoring.
1658     - Inventory API
1659        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
1660        - Description: Refactoring.
1661     - VES Collector
1662        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
1663     - Threshold Crossing Analytics
1664        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
1665        - 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.
1666
1667
1668
1669 Version: 1.0.0
1670 ==============
1671
1672 :Release Date: 2017-11-16
1673
1674
1675 **New Features**
1676
1677 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
1678 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
1679 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
1680 vDNS, vCPU, and vVoLTE.
1681
1682 Specifically, DCAE R1 includes the following components:
1683
1684 - Core platform
1685     - Cloudify manager
1686     - Consul cluster
1687 - Extended platform
1688     - Platform component docker host
1689     - Service component docker host
1690     - CDAP cluster
1691     - PostgreSQL database (*)
1692 - Platform docker container components
1693     - Configuration binding service
1694     - Deployment handler
1695     - Service change handler
1696     - Inventory
1697     - Policy handler
1698     - CDAP broker
1699 - Service components
1700     - Docker container components
1701         - VNF Event Streaming (VES) collector
1702         - Holmes (engine and rule management) **
1703     - CDAP analytics component
1704         - Threshold Crossing Analytics (TCA)
1705
1706 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
1707 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
1708 other deployment configurations not used in the R1 demos.)
1709 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
1710 in R1.
1711
1712 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1713
1714 - dcaegen2
1715 - dcaegen2/analytics
1716 - dcaegen2/analytics/tca
1717 - dcaegen2/collectors
1718 - dcaegen2/collectors/snmptrap
1719 - dcaegen2/collectors/ves
1720 - dcaegen2/deployments
1721 - dcaegen2/platform
1722 - dcaegen2/platform/blueprints
1723 - dcaegen2/platform/cdapbroker
1724 - dcaegen2/platform/cli
1725 - dcaegen2/platform/configbinding
1726 - dcaegen2/platform/deployment-handler
1727 - dcaegen2/platform/inventory-api
1728 - dcaegen2/platform/plugins
1729 - dcaegen2/platform/policy-handler
1730 - dcaegen2/platform/servicechange-handler
1731 - dcaegen2/utils
1732
1733
1734 **Bug Fixes**
1735
1736 This is the initial release.
1737
1738
1739 **Known Issues**
1740
1741 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1742 - Need to provide a dev configuration DCAE.
1743
1744
1745 **Security Issues**
1746
1747 - 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>`_.>`_.
1748 - 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.
1749
1750
1751 **Upgrade Notes**
1752
1753 This is the initial release.
1754
1755
1756 **Deprecation Notes**
1757
1758 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
1759 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
1760 following Gerrit repos are voided and already locked as read-only.
1761
1762 - dcae
1763 - dcae/apod
1764 - dcae/apod/analytics
1765 - dcae/apod/buildtools
1766 - dcae/apod/cdap
1767 - dcae/collectors
1768 - dcae/collectors/ves
1769 - dcae/controller
1770 - dcae/controller/analytics
1771 - dcae/dcae-inventory
1772 - dcae/demo
1773 - dcae/demo/startup
1774 - dcae/demo/startup/aaf
1775 - dcae/demo/startup/controller
1776 - dcae/demo/startup/message-router
1777 - dcae/dmaapbc
1778 - dcae/operation
1779 - dcae/operation/utils
1780 - dcae/orch-dispatcher
1781 - dcae/pgaas
1782 - dcae/utils
1783 - dcae/utils/buildtools
1784 - ncomp
1785 - ncomp/cdap
1786 - ncomp/core
1787 - ncomp/docker
1788 - ncomp/maven
1789 - ncomp/openstack
1790 - ncomp/sirius
1791 - ncomp/sirius/manager
1792 - ncomp/utils
1793
1794
1795 **Other**
1796
1797 SNMP trap collector is seed code delivery only.