DCAE Kohn rls note updates
[dcaegen2.git] / docs / sections / release-notes.rst
1 .. ==============================LICENSE_START==========================================
2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright (c) 2017-2022 AT&T Intellectual Property. All rights reserved.
5 .. Copyright 2021 Nokia Solutions and Networks.
6 .. ==============================LICENSE_END============================================
7 .. _release_notes:
8
9
10
11 ==================
12 DCAE Release Notes
13 ==================
14
15 .. contents::
16     :depth: 2
17 ..
18
19
20
21 ..      =====================
22 ..      * * *    KOHN   * * *
23 ..      =====================
24
25
26 Version: 11.0.0
27 ===============
28
29
30 Abstract
31 --------
32
33 This document provides the release notes for Kohn release.
34
35 Summary
36 -------
37
38 The following DCAE components are available with default ONAP/DCAE installation:
39
40     - Service components
41         - VES Collector
42         - HV-VES Collector
43         - PNF-Registration Handler
44         - Docker based Threshold Crossing Analytics (TCA-Gen2)
45         - VES OpenAPI Manager
46
47     - Additional resources that DCAE utilizes are deployed using ONAP common charts:
48
49         - Postgresql Database
50         - Mongo Database
51
52
53 These service components (mS) are available to be deployed on-demand via helm:
54
55         - SNMPTrap Collector
56         - RESTConf Collector
57         - DataFile Collector
58         - PM-Mapper
59         - VES Mapper
60         - Heartbeat mS
61         - SON-Handler
62         - PM-Subscription Handler
63         - DataLake Handler (Admin & Feeder)
64         - Slice Analysis mS
65         - DataLake Extraction Service
66         - KPI-Ms
67
68
69 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services.
70
71 For Helm managed microservices,  dependencies are identified on each chart individually.
72 In general, most DCAE microservice rely on Configmap for sourcing configuration updates. Each microservice can be deployed independently and based on the dcaegen2-services-common template, features can be enabled or disabled via a configuration override during deployment.
73
74 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
75
76
77 Release Data
78 ------------
79
80 +--------------------------------------+--------------------------------------------------------+
81 | **DCAE Project**                     |                                                        |
82 |                                      |                                                        |
83 +--------------------------------------+--------------------------------------------------------+
84 | **Docker images**                    | Refer :any:`Deliverable <kohn_deliverable>`            |
85 |                                      |                                                        |
86 +--------------------------------------+--------------------------------------------------------+
87 | **Release designation**              | 11.0.0 Kohn                                            |
88 |                                      |                                                        |
89 +--------------------------------------+--------------------------------------------------------+
90 | **Release date**                     | 2022-11-10                                             |
91 |                                      |                                                        |
92 +--------------------------------------+--------------------------------------------------------+
93
94
95 New features
96 ------------
97
98 *DCAE Enhancements and Features*
99
100 DCAEGEN2-3148 5G SON use case enhancements for Kohn release
101     - CL message for ANR modified to align with A1-based flow/support
102
103 DCAEGEN2-3195 CCVPN Kohn Enhancements for Intent-based Cloud Leased Line and Transport Slicing
104     - DCAE SDK alignment for SliceAnalysis MS & enhanching AAI interface for supporting IBN CL 
105
106 DCAEGEN2-3194 Maintenance and Enhancement of Intent-driven Closed-loop Autonomous Networks
107     - Slice Analysis Enhancement with AAI Interface/processing for CL notification
108
109 DCAEGEN2-3119 Helm Transformation - Post migration
110
111 DCAEGEN2-2975 VES 7.2.1 support for DCAE Microservices
112      - TCAgen2 enhanced to support VES 7.2.1
113
114 DCAEGEN2-3037 AAF certificate dependency removal
115     - DFC Enhanced to support additional property to disable certificates checks
116
117 DCAEGEN2-3030 DMAAP SDK standardization for DCAE Microservices
118     - SliceAnalysis MS, KPI-MS, SON-Handler MS switched to use DMAAP SDK
119
120
121 *Non-Functional*
122
123    - DCAEGEN2-3089 - Sonarcoverage improvements for DCAE components - SliceAnalysis mS, SNMPTrap, TCA-gen2, SON-Handler, KPi-MS, Mapper, RESTConf
124    - DCAEGEN2-3209 - CII Badging improvements
125    - DCAEGEN2-3196 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector, HV-VES, RESTConf, VES, Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS, DCAE-SDK, VES OpenAPI Manager)
126
127
128 .. _kohn_deliverable:
129
130 Deliverables
131 ------------
132
133 Software Deliverables
134
135 .. csv-table::
136    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
137    :widths: auto
138
139    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.4"
140    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.9.0"
141    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.11.0"
142    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.3.4"
143    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.7"
144    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.11.1"
145    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
146    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
147    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
148    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
149    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
150    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
151    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
152    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
153    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
154    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"
155    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.2.0"
156    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
157    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
158    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
159    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
160    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.5"
161    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.9"
162    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.4.1"
163    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.3"
164    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.9.0"
165    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.8.1"
166    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.10"
167    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.4 (jar)"
168    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.10 (jar)"
169
170 The following repositories (and containers) have been deprecated with this release.
171
172 .. csv-table::
173    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
174    :widths: auto
175
176    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.7"
177
178 As DCAEMOD has been identified for EOL with London, following containers will be deprecated in next release and removed from OOM.
179
180 .. csv-table::
181    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
182    :widths: auto
183
184    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
185    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.1"
186    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
187    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
188    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.3"
189    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
190    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.3"   
191
192 Known Limitations, Issues and Workarounds
193 -----------------------------------------
194
195
196
197 *Known Vulnerabilities*
198
199 None
200
201 *Workarounds*
202
203 Documented under corresponding jira if applicable.
204
205 Security Notes
206 --------------
207
208 *Fixed Security Issues*
209
210     Documented on earlier section
211
212 *Known Security Issues*
213
214     None
215
216 *Known Vulnerabilities in Used Modules*
217
218     None
219
220 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/display/SV/Kohn+DCAE>`_.
221
222 Test Results
223 ------------
224
225  - `DCAE R11 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Kohn+Release>`_
226  - `DCAE R11 Functional Test <https://wiki.onap.org/display/DW/DCAE+R11+Kohn+Testplan>`_
227
228
229 References
230 ----------
231
232 For more information on the ONAP Jakarta release, please see:
233
234 #. `ONAP Home Page`_
235 #. `ONAP Documentation`_
236 #. `ONAP Release Downloads`_
237 #. `ONAP Wiki Page`_
238
239
240 .. _`ONAP Home Page`: https://www.onap.org
241 .. _`ONAP Wiki Page`: https://wiki.onap.org
242 .. _`ONAP Documentation`: https://docs.onap.org
243 .. _`ONAP Release Downloads`: https://git.onap.org
244
245 Quick Links:
246
247         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
248         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
249
250
251
252
253
254 ..      ==========================
255 ..      * * *    JAKARTA    * * *
256 ..      ==========================
257
258
259 Version: 10.0.0
260 ===============
261
262
263 Abstract
264 --------
265
266 This document provides the release notes for Jakarta release.
267
268 Summary
269 -------
270
271 With DCAE transformation to HELM completed this release, all Cloudify/platform handler components have been retired
272 and only helm based MS deployment mode is supported.
273 The following DCAE components are available with default ONAP/DCAE installation:
274
275     - Service components
276         - VES Collector
277         - HV-VES Collector
278         - PNF-Registration Handler
279         - Docker based Threshold Crossing Analytics (TCA-Gen2)
280         - VES OpenAPI Manager
281
282     - Additional resources that DCAE utilizes are deployed using ONAP common charts:
283
284         - Postgresql Database
285         - Mongo Database
286
287
288 These service components (mS) are available to be deployed on-demand via helm:
289
290         - SNMPTrap Collector
291         - RESTConf Collector
292         - DataFile Collector
293         - PM-Mapper
294         - VES Mapper
295         - Heartbeat mS
296         - SON-Handler
297         - PM-Subscription Handler
298         - DataLake Handler (Admin and Feeder)
299         - Slice Analysis mS
300         - DataLake Extraction Service
301         - KPI-Ms
302
303
304 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into a Kubernetes cluster.
305
306 For Helm managed microservices, the dependencies/pre-requisite are identified on each chart individually.
307 In general, most DCAE microservice rely on Configmap for sourcing configuration updates. Each microservice can be deployed independently and based on the dcaegen2-services-common template, features can be enabled or disabled via a configuration override during deployment.
308
309 For a list of supported features in helm, refer to :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
310
311
312 Release Data
313 ------------
314
315 +--------------------------------------+--------------------------------------------------------+
316 | **DCAE Project**                     |                                                        |
317 |                                      |                                                        |
318 +--------------------------------------+--------------------------------------------------------+
319 | **Docker images**                    | Refer :any:`Deliverable <jakarta_deliverable>`         |
320 |                                      |                                                        |
321 +--------------------------------------+--------------------------------------------------------+
322 | **Release designation**              | 10.0.0 Jakarta                                         |
323 |                                      |                                                        |
324 +--------------------------------------+--------------------------------------------------------+
325 | **Release date**                     | 2022-06-02                                             |
326 |                                      |                                                        |
327 +--------------------------------------+--------------------------------------------------------+
328
329
330 New features
331 ------------
332
333 *DCAE Enhancements and Features*
334
335 DCAEGEN2-3021 DCAE Impacts for E2E Network Slicing in Jakarta release
336     - Slice selection taking into consideration resource occupancy levels
337     - IBN based Closed loop for Network Slicing
338
339 DCAEGEN2-3063 CCVPN Jakarta Enhancements for Intent-based Cloud Leased Line and Closed-loop
340     - Support bandwidth evaluation and CL event generation
341     - AAI Interface for bandwidth update notification
342
343 DCAEGEN2-2773 DCAE Helm Transformation (Phase 3/Final)
344     - Removed Consul dependency across all DCAE service components.
345     - All DCAE microservices migrated to use latest CBS SDK library to support configmap/policy retrieval
346     - Enhancement on DCAE common template for DR Feed pub/sub configuration consistency and disable Consul loader
347     - DCAEMOD enhanced to support Helm chart generation for onboarded MS/flows
348     - Cloudify and related Handlers removal from ONAP/DCAE Deployment
349     - v3 spec introduced for MOD Helm flow support
350
351 DCAEGEN2-2906 - Bulk PM / PM Data Control Improvements (PMSH)
352     - PMSH functional enhancement and support for dynamic filter/subscription change via API
353
354 DCAEGEN2-3031 - Topic alignment for DCAE microservices
355     - Migrate DCAE MS to use standard topics for PM-Mapper, Slice-Analysis, KPI-MS
356
357
358 *Non-Functional*
359
360    - DCAEGEN2-2829 - CII Badging improvements
361    - DCAEGEN2-3006 - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector,RESTConf, VES,Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS, DCAE-SDK, VES OpenAPI Manager)
362    - DCAEGEN2-2961/DCAEGEN2-2962/DCAEGEN2-2963 - Removed GPLv3 license from software by switching to onap/integration base images for VESCollector, RESTConf, SliceAnalysis MS
363    - DCAEGEN2-2958 - STDOUT log compliance for DCAE SNMPTRap collector and Healthcheck container
364
365
366
367
368 .. _jakarta_deliverable:
369
370 Deliverables
371 ------------
372
373 Software Deliverables
374
375 .. csv-table::
376    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
377    :widths: auto
378
379    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.2"
380    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.7.1"
381    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.10.0"
382    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.3.2"
383    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.6"
384    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.11.0"
385    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.4.0"
386    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
387    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
388    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.13.0"
389    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
390    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
391    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
392    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
393    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
394    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.3.2"
395    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.7"
396    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.1.0"
397    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
398    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
399    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
400    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:2.2.2"
401    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.1.3"
402    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.4"
403    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
404    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.4.0"
405    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.8.0"
406    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.8.0"
407    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.7"
408    "dcaegen2/platform", "mod2/helm-generator", "Helm Generator 1.0.3 (jar)"
409    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.8 (jar)"
410
411 The following repositories (and containers) have been deprecated with this release.
412
413 .. csv-table::
414    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
415    :widths: auto
416
417    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.6.1"
418    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.1"
419    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
420    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.3.5"
421    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.4"
422    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
423    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
424    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.3"
425    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
426    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.1.1"
427    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.4"
428
429
430 Known Limitations, Issues and Workarounds
431 -----------------------------------------
432
433 DCAEGEN2-2861 - Topic/feed provisioned through Helm require manual cleanup once the helm deployed service are uninstalled.
434 Refer following document  :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>` for steps to remove topic/feed provisioned in DMAAP.
435
436
437 *Known Vulnerabilities*
438
439 None
440
441 *Workarounds*
442
443 Documented under corresponding jira if applicable.
444
445 Security Notes
446 --------------
447
448 *Fixed Security Issues*
449
450     Documented on earlier section
451
452 *Known Security Issues*
453
454     None
455
456 *Known Vulnerabilities in Used Modules*
457
458     None
459
460 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/display/SV/Jakarta+DCAE>`_.
461
462 Test Results
463 ------------
464
465  - `DCAE R10 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Jakarta+Release>`_
466  - `DCAE R10 Functional Test <https://wiki.onap.org/display/DW/DCAE+R10+Testplan>`_
467
468
469 References
470 ----------
471
472 For more information on the ONAP Jakarta release, please see:
473
474 #. `ONAP Home Page`_
475 #. `ONAP Documentation`_
476 #. `ONAP Release Downloads`_
477 #. `ONAP Wiki Page`_
478
479
480 .. _`ONAP Home Page`: https://www.onap.org
481 .. _`ONAP Wiki Page`: https://wiki.onap.org
482 .. _`ONAP Documentation`: https://docs.onap.org
483 .. _`ONAP Release Downloads`: https://git.onap.org
484
485 Quick Links:
486
487         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
488         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
489
490
491
492 ..      =====================================
493 ..      * * *    ISTANBUL  MAINTENANCE  * * *
494 ..      =====================================
495
496
497 Version: 9.0.1
498 ==============
499
500 Abstract
501 --------
502
503 This document provides the release notes for the Istanbul Maintenance release
504
505
506 Summary
507 -------
508
509 This maintenance release is primarily to resolve bugs identified during Istanbul release testing.
510
511
512 Release Data
513 ------------
514
515 +--------------------------------------+--------------------------------------+
516 | **Project**                          | DCAE                                 |
517 |                                      |                                      |
518 +--------------------------------------+--------------------------------------+
519 | **Docker images**                    | See Istanbul Maintenance Release     |
520 |                                      |         Deliverable (below)          |
521 +--------------------------------------+--------------------------------------+
522 | **Release designation**              | Istanbul Maintenance Release         |
523 |                                      |                                      |
524 +--------------------------------------+--------------------------------------+
525 | **Release date**                     | 2022/01/31                           |
526 |                                      |                                      |
527 +--------------------------------------+--------------------------------------+
528
529 New features
530 ------------
531
532 None
533
534 **Bug fixes**
535
536 - `DCAEGEN2-3022 <https://jira.onap.org/browse/DCAEGEN2-3022>`_ Log4j vulnerability fix
537 - `DCAEGEN2-2998 <https://jira.onap.org/browse/DCAEGEN2-2998>`_ Update SON-Handler missing configuration in helm
538
539
540 **Known Issues**
541
542 None
543
544
545 Security Notes
546 --------------
547
548 *Known Vulnerabilities in Used Modules*
549
550     dcaegne2/services/mapper includes transitive dependency on log4j 1.2.17; this will be addressed in later release (DCAEGEN2-3105)
551
552
553 Istanbul Maintenance Rls Deliverables
554 -------------------------------------
555
556 Software Deliverables
557
558 .. csv-table::
559    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
560    :widths: auto
561
562    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.7"
563    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.3"
564    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.3.2"
565
566
567
568 ..      ==========================
569 ..      * * *    ISTANBUL    * * *
570 ..      ==========================
571
572
573 Version: 9.0.0
574 ==============
575
576
577 Abstract
578 --------
579
580 This document provides the release notes for Istanbul release.
581
582 Summary
583 -------
584
585 Following DCAE components are available with default ONAP/DCAE installation.
586
587     - Platform components
588
589         - Cloudify Manager (helm chart)*
590         - Bootstrap container (helm chart)*
591         - Configuration Binding Service (helm chart)
592         - Deployment Handler (helm chart)*
593         - Policy Handler (helm chart*
594         - Service Change Handler (helm chart)*
595         - Inventory API (helm chart)*
596         - Dashboard (helm chart)*
597         - VES OpenAPI Manager (helm chart)
598
599     - Service components
600
601         - VES Collector (helm chart  & cloudify blueprint)
602         - HV-VES Collector (helm chart  & cloudify blueprint)
603         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
604         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
605
606     - Additional resources that DCAE utilizes deployed using ONAP common charts:
607
608         - Postgres Database
609         - Mongo Database
610         - Consul Cluster
611
612     \*  These components will be retired next ONAP release as cloudify deployments will be diabled after Istanbul.
613  
614
615 Below service components (mS) are available to be deployed on-demand (helm chart & Cloudify Blueprint)
616
617         - SNMPTrap Collector
618         - RESTConf Collector
619         - DataFile Collector
620         - PM-Mapper
621         - BBS-EventProcessor
622         - VES Mapper
623         - Heartbeat mS
624         - SON-Handler
625         - PM-Subscription Handler
626         - DataLake Handler (Admin and Feeder)
627         - Slice Analysis mS
628         - DataLake Extraction Service
629         - KPI-Ms
630
631
632 Under OOM all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
633 With DCAE tranformation to Helm in Istanbul release - all DCAE components are available to be deployed under Helm; Cloudify blueprint deployment is provided for backward compatibility support in this release.
634
635 For Helm managed microservices, the dependencies/pre-requisite are identified on each charts individually. In general, most DCAE microservice rely on Consul/Configbindingservice for sourcing configuration updates (this dependency will be removed in next release). Each microservice can be deployed independently and based on dcaegen2-services-common template, features can be enabled or disabled via configuration override during deployment. For list of supported features in helm refer - :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>`.
636
637 DCAE continues to provides Cloudify deployment through plugins (cloudify) 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.
638
639
640 Release Data
641 ------------
642
643 +--------------------------------------+--------------------------------------------------------+
644 | **DCAE Project**                     |                                                        |
645 |                                      |                                                        |
646 +--------------------------------------+--------------------------------------------------------+
647 | **Docker images**                    | Refer :any:`Deliverable <istanbul_deliverable>`        |
648 |                                      |                                                        |
649 +--------------------------------------+--------------------------------------------------------+
650 | **Release designation**              | 9.0.0 Istanbul                                         |
651 |                                      |                                                        |
652 +--------------------------------------+--------------------------------------------------------+
653 | **Release date**                     | 2021-11-18                                             |
654 |                                      |                                                        |
655 +--------------------------------------+--------------------------------------------------------+
656
657
658 New features
659 ------------
660
661 *DCAE Enhancements Features*
662
663 DCAEGEN2-2771 DCAE Impacts for E2E Network Slicing in Istanbul release
664     - SliceAnalysis and KPI-Computation MS migrated from ConfigDb to CPS
665     - Integration with new CBS client SDK and support policy sidecar
666
667 DCAEGEN2-2703 Add stndDefined domain to HV-VES
668     - HV_VES microservice was adapted to support stdDefined domain introduced under VES7.2.1 spec  
669
670 DCAEGEN2-2630 DCAE Helm Transformation (Phase 2)
671     - All DCAE microservices migration to helm was completed in Istanbul release. Since Honolulu, 13 additional MS has been delivered added for Helm deployment support
672     - All DCAE Microservice are supported under both Helm and Cloudify/blueprint based deployments (legacy)
673     - Helm Templated resuable function - Several new common features has been added in generic fashion as named template/functions defined in dcaegen2-services-common charts; each DCAEcomponents/mS can enable required features via configuration override. Following are current set of features available under dcaegen2-services-common
674             - K8S Secret/Environment mapping
675             - CMPv2 Certificate support
676             - Policy Sidecar
677             - Mount data from configmap through PV/PVC
678             - Topic/feed provisioning support
679             - AAF certificates generation/distribution
680             - Consul loader for application config
681
682     - Reducing Consul Dependency for DCAE components
683          Under cloudify deployments, Consul is used as central configuration store for all applications. With migration to Helm, the consul dependency is being removed by switching config management through K8S Configmap (via python/java SDK libraries). This allows application to be deployed standalone in multi/edge cloud without any dependency on central platform components.          
684
685     - Helm-generator tool (POC) available for generating DCAE component helm-chart given component spec. This tool will be integrated with MOD/design flow to support helm chart generation and distribution for Jakarta release. 
686
687 DCAEGEN2-2541 Bulk PM (PMSH) - Additional use cases, deployment and documentation enhancements
688     - Enhanced PMSH Microservice to support subscription property updates, config updates to support 'n' subscriptions, support resource name in filter
689
690 DCAEGEN2-2522 Enhancements for OOF SON use case
691     - Implemented CPS client interface (replacing ConfigDb)
692     - Switched to new CBS client SDK for removing consul dependency and enabling policy configuration through sidecar.
693
694 *Non-Functional*
695
696    - Removed GPLv3 license from software by switching to onap/integration base images (DCAEGEN2-2455)
697    - CII Badging improvements (DCAEGEN2-2622)
698    - Healthcheck container Py3 upgrade  (DCAEGEN2-2737)
699    - Vulnerability updates for several DCAE MS (TCA-gen2, DataFileCollector,RESTConf, VES,Mapper, PM-Mapper, PRH, SON-handler, KPI-MS, Slice-Analysis MS) (DCAEGEN2-2768)
700
701
702 Bug Fixes
703
704    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
705    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
706
707
708 .. _istanbul_deliverable:
709
710 Deliverables
711 ------------
712
713 Software Deliverables
714
715 .. csv-table::
716    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
717    :widths: auto
718
719    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.3.1"
720    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.6.1"
721    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.9.1"
722    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.5"
723    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.5"
724    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.10.1"
725    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.6.1"
726    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.1"
727    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
728    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.2.0"
729    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
730    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.1"
731    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
732    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
733    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
734    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
735    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
736    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
737    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
738    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.6"
739    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.3.5"
740    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.4"
741    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
742    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
743    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.3"
744    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
745    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
746    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.1"
747    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.1"
748    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.1"
749    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.3.2"
750    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.6"
751    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.1.1"
752    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.1"
753    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.3.1"
754    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.3.0"
755    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.7.2"
756    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.7.1"
757    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.5"
758    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.8.0 (jar)"
759    "dcaegen2/services/sdk", "", "DCAE SDK 1.8.7 (jar)"
760    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.4"
761
762
763 Known Limitations, Issues and Workarounds
764 -----------------------------------------
765
766 DCAEGEN2-2861 - Topic/feed provisioned through Helm require manual cleanup once the helm deployed service are uninstalled.
767 Refer following document  :doc:`Using Helm to deploy DCAE Microservices <./dcaeservice_helm_template>` for steps to remove topic/feed provisioned in DMAAP.
768
769
770 *Known Vulnerabilities*
771
772 None
773
774 *Workarounds*
775
776 Documented under corresponding jira if applicable.
777
778 Security Notes
779 --------------
780
781 *Fixed Security Issues*
782
783     Documented on earlier section
784
785 *Known Security Issues*
786
787     None
788
789 *Known Vulnerabilities in Used Modules*
790
791     None
792
793 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>`_.
794
795 Test Results
796 ------------
797
798  - `DCAE R9 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Istanbul+Release>`_
799  - `DCAE R9 Functional Test <https://wiki.onap.org/display/DW/DCAE+R9+Testplan>`_
800
801
802 References
803 ----------
804
805 For more information on the ONAP Honolulu release, please see:
806
807 #. `ONAP Home Page`_
808 #. `ONAP Documentation`_
809 #. `ONAP Release Downloads`_
810 #. `ONAP Wiki Page`_
811
812
813 .. _`ONAP Home Page`: https://www.onap.org
814 .. _`ONAP Wiki Page`: https://wiki.onap.org
815 .. _`ONAP Documentation`: https://docs.onap.org
816 .. _`ONAP Release Downloads`: https://git.onap.org
817
818 Quick Links:
819
820         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
821         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
822
823
824 ..      =====================================
825 ..      * * *    HONOLULU  MAINTENANCE  * * *
826 ..      =====================================
827
828
829 Version: 8.0.1
830 ==============
831
832 Abstract
833 --------
834
835 This document provides the release notes for the Honolulu Maintenance release
836
837
838 Summary
839 -------
840
841 This maintenance release is primarily to resolve bugs identified during Honolulu release testing.
842
843
844 Release Data
845 ------------
846
847 +--------------------------------------+--------------------------------------+
848 | **Project**                          | DCAE                                 |
849 |                                      |                                      |
850 +--------------------------------------+--------------------------------------+
851 | **Docker images**                    | onap/org.onap.ccsdk.dashboard.       |
852 |                                      |   .ccsdk-app-os:1.4.4                |
853 +--------------------------------------+--------------------------------------+
854 | **Release designation**              | Honolulu Maintenance Release         |
855 |                                      |                                      |
856 +--------------------------------------+--------------------------------------+
857 | **Release date**                     | 2021/06/01                           |
858 |                                      |                                      |
859 +--------------------------------------+--------------------------------------+
860
861 New features
862 ------------
863
864 None
865
866 **Bug fixes**
867
868 - `DCAEGEN2-2751 <https://jira.onap.org/browse/DCAEGEN2-2751>`_ Dashboard login issue due to oom/common PG upgrade to centos8-13.2-4.6.1
869 - `CCSDK-3233 <https://jira.onap.org/browse/CCSDK-3233>`_ Switch to integration base image & vulnerability updates fixes
870 - `DCAEGEN2-2800 <https://jira.onap.org/browse/DCAEGEN2-2800>`_ DCAE Healthcheck failure due to Dashboard 
871 - `DCAEGEN2-2869 <https://jira.onap.org/browse/DCAEGEN2-2869>`_ Fix PRH aai lookup url config
872
873 **Known Issues**
874
875 None
876
877 ..      ==========================
878 ..      * * *    HONOLULU    * * *
879 ..      ==========================
880
881
882 Version: 8.0.0
883 ==============
884
885
886 Abstract
887 --------
888
889 This document provides the release notes for Honolulu release.
890
891 Summary
892 -------
893
894 Following DCAE components are available with default ONAP/DCAE installation.
895
896     - Platform components
897
898         - Cloudify Manager (helm chart)
899         - Bootstrap container (helm chart)
900         - Configuration Binding Service (helm chart)
901         - Deployment Handler (helm chart)
902         - Policy Handler (helm chart
903         - Service Change Handler (helm chart)
904         - Inventory API (helm chart)
905         - Dashboard (helm chart)
906         - VES OpenAPI Manager (helm chart)
907
908     - Service components
909
910         - VES Collector (helm chart  & cloudify blueprint)
911         - HV-VES Collector (helm chart  & cloudify blueprint)
912         - PNF-Registration Handler  (helm chart  & cloudify blueprint)
913         - Docker based Threshold Crossing Analytics (TCA-Gen2) (helm chart  & cloudify blueprint)
914         - Holmes Rule Management (helm chart  & cloudify blueprint)
915         - Holmes Engine Management (helm chart  & cloudify blueprint)
916
917     - Additional resources that DCAE utilizes deployed using ONAP common charts:
918
919         - Postgres Database
920         - Mongo Database
921         - Consul Cluster
922
923 Below service components (mS) are available to be deployed on-demand (through Cloudify Blueprint)
924
925         - SNMPTrap Collector
926         - RESTConf Collector
927         - DataFile Collector
928         - PM-Mapper 
929         - BBS-EventProcessor
930         - VES Mapper
931         - Heartbeat mS
932         - SON-Handler
933         - PM-Subscription Handler
934         - DataLake Handler (Admin and Feeder)
935         - Slice Analysis mS
936         - DataLake Extraction Service
937         - KPI-Ms
938
939     Notes:
940
941         \*  These components are delivered by the Holmes project.
942
943
944
945 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.
946
947
948 Release Data
949 ------------
950
951 +--------------------------------------+--------------------------------------------------------+
952 | **DCAE Project**                     |                                                        |
953 |                                      |                                                        |
954 +--------------------------------------+--------------------------------------------------------+
955 | **Docker images**                    | Refer :any:`Deliverable <honolulu_deliverable>`        |
956 |                                      |                                                        |
957 +--------------------------------------+--------------------------------------------------------+
958 | **Release designation**              | 8.0.0 Honolulu                                         |
959 |                                      |                                                        |
960 +--------------------------------------+--------------------------------------------------------+
961 | **Release date**                     | 2021-04-29                                             |
962 |                                      |                                                        |
963 +--------------------------------------+--------------------------------------------------------+
964
965
966 New features
967 ------------
968
969 *DCAE Enhancements*
970
971
972 Functional Updates
973
974    - New service VES-Openapi-Manager component added to DCAE, allowing to notify of missing openAPI description, at xNF distribution phase (DCAEGEN2-2571) 
975    - Added VES 7.2.1 support in VESCollector (DCAEGEN2-2539, DCAEGEN2-2477)
976    - DCAE MS deployment through helm with introduction of common dcae-service template to standardize charts with migration (DCAEGEN2-2488) 
977    - New service KPI-Computation MS introduced for support for E2E Slicing Usecase (DCAEGEN2-2521)
978    - K8S configMap support through onboarding/design/deployment via DCAE-MOD and DCAE-Platform (DCAEGEN2-2539)
979    - BP-generation Enhancements - support Native-kafka & Config-map through onboarding (DCAEGEN2-2458)
980    - CFY plugin enhancements - support IPV6 service exposure + Config-Map + Cert-Manager's CMPv2 issuer integration (DCAEGEN2-2539, DCAEGEN2-2458, DCAEGEN2-2388)
981    - DCAE SDK enhancement - Dmaap Client update for timeout/retry + CBS client update (DCAEGEN2-1483)
982    - DFC enhancement - support in HTTP/HTTPS/enroll certificate from CMPv2 server (DCAEGEN2-2517)
983
984 Non-Functional
985
986    - DCAE Cloudify py3 upgrade including plugins/bootstrap cli (DCAEGEN2-1546)
987    - CII Badging improvements (DCAEGEN2-2570)
988    - Policy-Handler Py3 upgrade  (DCAEGEN2-2494)
989    - Vulnerability updates for several DCAE MS (DataFile Collector, RESTConf, VESCollector, InventoryAPI, MOD/RuntimeAPI, VES-mapper, PM-Mapper, PRH, SON-Handler) (DCAEGEN2-2551)
990    - Code Coverage improvement (DataFile, SDK, Blueprint-generator, Plugins, Acumos Adapter) (DCAEGEN2-2382)
991    - Documentation/user-guide updates
992
993 Bug Fixes
994
995    - BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
996    - Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
997
998
999 - Following new services are delivered this release
1000     - VES OpenAPI Manager
1001     - KPI MS (Analytics/RCA)
1002
1003 .. _honolulu_deliverable:
1004
1005 Deliverables
1006 ------------
1007
1008 Software Deliverables
1009
1010 .. csv-table::
1011    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1012    :widths: auto
1013
1014    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
1015    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.5.5"
1016    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.6.0"
1017    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.4"
1018    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.4"
1019    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.8.0"
1020    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:4.4.2"
1021    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.1.0"
1022    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
1023    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
1024    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
1025    "dcaegen2/deployments", "dcae-services-policy-sync", "onap/org.onap.dcaegen2.deployments.dcae-services-policy-sync:1.0.0"
1026    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.5"
1027    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
1028    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
1029    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
1030    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
1031    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
1032    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.2.3"
1033    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.4"
1034    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:3.0.4" 
1035    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
1036    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
1037    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.2"  
1038    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.2"
1039    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
1040    "dcaegen2/platform/ves-openapi-manager", "", "onap/org.onap.dcaegen2.platform.ves-openapi-manager:1.0.1"
1041    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
1042    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
1043    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
1044    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
1045    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.4"
1046    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
1047    "dcaegen2/services", "components/kpi-ms", "onap/org.onap.dcaegen2.services.components.kpi-ms:1.0.0"
1048    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
1049    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.2.0"
1050    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.5.2"
1051    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.6"
1052    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.3"
1053    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.7.3 (jar)"
1054    "dcaegen2/services/sdk", "", "DCAE SDK 1.7.0 (jar)"
1055    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
1056
1057
1058 Known Limitations, Issues and Workarounds
1059 -----------------------------------------
1060
1061 The new, Helm based installation mechanism for collectors doesn't support yet certain features available with the traditional Cloudify orchestration based mechanisms:
1062    - Obtaining X.509 certificates from external CMP v2 server for secure xNF connections
1063    - Exposing the Collector port in Dual Stack IPv4/IPv6 networks.
1064
1065 Such features are available, when the collectors are installed using the Cloudify mechanisms.
1066 Refer to collector installation page for more details:
1067
1068 .. toctree::
1069    :maxdepth: 1
1070
1071    ./services/ves-http/installation.rst
1072    ./services/ves-hv/installation.rst
1073
1074     
1075 *Known Vulnerabilities*
1076
1077 None
1078
1079 *Workarounds*
1080
1081 Documented under corresponding jira if applicable.
1082
1083 Security Notes
1084 --------------
1085
1086 *Fixed Security Issues*
1087     
1088     Documented on earlier section
1089
1090 *Known Security Issues*
1091     
1092     None
1093
1094 *Known Vulnerabilities in Used Modules*
1095     
1096     None
1097         
1098 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>`_.
1099
1100 Test Results
1101 ------------
1102
1103  - `DCAE R8 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Honolulu+Release>`_
1104  - `DCAE R8 Functional Test <https://wiki.onap.org/display/DW/DCAE+R8+Testplan>`_
1105
1106
1107 References
1108 ----------
1109
1110 For more information on the ONAP Honolulu release, please see:
1111
1112 #. `ONAP Home Page`_
1113 #. `ONAP Documentation`_
1114 #. `ONAP Release Downloads`_
1115 #. `ONAP Wiki Page`_
1116
1117
1118 .. _`ONAP Home Page`: https://www.onap.org
1119 .. _`ONAP Wiki Page`: https://wiki.onap.org
1120 .. _`ONAP Documentation`: https://docs.onap.org
1121 .. _`ONAP Release Downloads`: https://git.onap.org
1122
1123 Quick Links:
1124
1125         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1126         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1127
1128
1129 ..      ===================================
1130 ..      * * *    GUILIN  MAINTENANCE  * * *
1131 ..      ===================================
1132
1133
1134 Version: 7.0.1
1135 ==============
1136
1137 Abstract
1138 --------
1139
1140 This document provides the release notes for the Guilin Maintenance release
1141
1142
1143 Summary
1144 -------
1145
1146 This maintenance release is primarily to resolve bugs identified during Guilin release testing.
1147
1148
1149 Release Data
1150 ------------
1151
1152 +--------------------------------------+--------------------------------------+
1153 | **Project**                          | DCAE                                 |
1154 |                                      |                                      |
1155 +--------------------------------------+--------------------------------------+
1156 | **Docker images**                    | onap/org.onap.dcaegen2.collectors    |
1157 |                                      |   .hv-ves.hv-collector-main:1.5.1    |
1158 +--------------------------------------+--------------------------------------+
1159 | **Release designation**              | Guilin Maintenance Release           |
1160 |                                      |                                      |
1161 +--------------------------------------+--------------------------------------+
1162 | **Release date**                     | 2021/04/19                           |
1163 |                                      |                                      |
1164 +--------------------------------------+--------------------------------------+
1165
1166 New features
1167 ------------
1168
1169 None
1170
1171 **Bug fixes**
1172
1173 - `DCAEGEN2-2516 <https://jira.onap.org/browse/DCAEGEN2-2516>`_ HV-VES Pod recovery when config-fetch fails
1174 - `OOM-2641 <https://jira.onap.org/browse/OOM-2641>`_ Fix DCAEMOD paths based on Guilin ingress template
1175
1176 **Known Issues**
1177
1178 Same as Guilin Release
1179
1180
1181 ..      ========================
1182 ..      * * *    GUILIN    * * *
1183 ..      ========================
1184
1185
1186 Version: 7.0.0
1187 ==============
1188
1189
1190 Abstract
1191 --------
1192
1193 This document provides the release notes for Guilin release.
1194
1195 Summary
1196 -------
1197
1198 Following DCAE components are available with default ONAP/DCAE installation.
1199
1200     - Platform components
1201
1202         - Cloudify Manager (helm chart)
1203         - Bootstrap container (helm chart)
1204         - Configuration Binding Service (helm chart)
1205         - Deployment Handler (helm chart)
1206         - Policy Handler (helm chart
1207         - Service Change Handler (helm chart)
1208         - Inventory API (helm chart)
1209         - Dashboard (helm chart)
1210
1211     - Service components
1212
1213         - VES Collector
1214         - HV-VES Collector
1215         - PNF-Registration Handler
1216         - Docker based Threshold Crossing Analytics (TCA-Gen2)
1217         - Holmes Rule Management *
1218         - Holmes Engine Management *
1219
1220     - Additional resources that DCAE utilizes deployed using ONAP common charts:
1221     
1222         - Postgres Database
1223         - Mongo Database
1224         - Redis Cluster Database
1225         - Consul Cluster 
1226
1227 Below service components (mS) are available to be deployed on-demand.
1228
1229         - SNMPTrap Collector
1230         - RESTConf Collector
1231         - DataFile Collector
1232         - PM-Mapper 
1233         - BBS-EventProcessor
1234         - VES Mapper
1235         - Heartbeat mS
1236         - SON-Handler
1237         - PM-Subscription Handler
1238         - DataLake Handler (Admin and Feeder)
1239         - Slice Analysis
1240         - DataLake Extraction Service
1241
1242     Notes:
1243
1244         \*  These components are delivered by the Holmes project.
1245
1246
1247
1248 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.
1249
1250
1251 Release Data
1252 ------------
1253
1254 +--------------------------------------+--------------------------------------------------------+
1255 | **DCAE Project**                     |                                                        |
1256 |                                      |                                                        |
1257 +--------------------------------------+--------------------------------------------------------+
1258 | **Docker images**                    | Refer :any:`Deliverable <guilin_deliverable>`          |
1259 |                                      |                                                        |
1260 +--------------------------------------+--------------------------------------------------------+
1261 | **Release designation**              | 7.0.0 Guilin                                           |
1262 |                                      |                                                        |
1263 +--------------------------------------+--------------------------------------------------------+
1264 | **Release date**                     | 2020-11-19                                             |
1265 |                                      |                                                        |
1266 +--------------------------------------+--------------------------------------------------------+
1267
1268
1269 New features
1270 ------------
1271
1272 - DCAE Enhancements
1273
1274     - Cloudify Container upgraded with new base image; plugins load optimized (DCAEGEN2-2236, DCAEGEN2-2207, DCAEGEN2-2262)
1275     - Bootstrap container optimization  (DCAEGEN2-1791)
1276     - MOD/Runtime â€“ Enable configuration for dynamic topic support (DCAEGEN2-1996)
1277     - MOD/OnboardingAPI - Support for offline install (DCAEGEN2-2221)
1278     - DCAE Dashboard UI Optimization  and bugfixes (DCAEGEN2-2223, DCAEGEN2-2364,DCAEGEN2-1638,DCAEGEN2-2298, DCAEGEN2-1857)
1279     - Blueprint generator tool and K8Splugin enhancement to support External Certificate (DCAEGEN2-2250)
1280     - K8S v1.17 support through DCAE Cloudify K8S plugins (DCAEGEN2-2309)
1281     - Python 3.8 support enabled for several DCAE components - Heartbeat mS, PMSH mS, MOD/DistriubtorAPI mS, MOD/OnboardingAPI mS, Policy Library (DCAEGEN2-2292)
1282     - 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)
1283     - Hardcoded password removed from OOM charts - Cloudify, Bootstrap, DeploymentHandler, Dashboard; now managed dynamically through K8S secret (DCAEGEN2-1972, DCAEGEN2-1975)
1284     - Best practice compliance
1285          - STDOUT log compliance for DCAE Containers (DCAEGEN2-2324)
1286          - No more than one main process (DCAEGEN2-2327/REQ-365)
1287          - Container must crash when failure is noted (DCAEGEN2-2326/REQ-366)
1288          - All containers must run as non-root (REQ-362)
1289          - Code coverage >55% (DCAEGEN2-2333)
1290     - All Vulnerability identified by SECCOM has been resolved (DCAEGEN2-2242)
1291  
1292
1293 - Following new services are delivered this release
1294
1295     - Event Processors
1296         - DataLake Extraction Service 
1297        
1298     - Analytics/RCA
1299         - Slice Analysis MS
1300         
1301 .. _guilin_deliverable:
1302
1303 Deliverables
1304 ------------
1305
1306 Software Deliverables
1307
1308 .. csv-table::
1309    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1310    :widths: auto
1311
1312    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.2.1"
1313    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.4.3"
1314    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.5.0"
1315    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.2.2"
1316    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
1317    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9"
1318    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:3.3.4"
1319    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
1320    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
1321    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:2.1.0"
1322    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
1323    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
1324    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.3"
1325    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.1.0"
1326    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
1327    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.2"
1328    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.2"
1329    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
1330    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.1.1"
1331    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.3"
1332    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:2.1.8" 
1333    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.3"
1334    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.4.1"
1335    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.5.1"  
1336    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
1337    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.4.0"
1338    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.1.0"
1339    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.1.0"
1340    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalake.exposure.service:1.1.0"
1341    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.1.2"
1342    "dcaegen2/services", "components/slice-analysis-ms", "onap/org.onap.dcaegen2.services.components.slice-analysis-ms:1.0.1"
1343    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.1"
1344    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.1"
1345    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.1.0"
1346    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.4.1"
1347    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.4"
1348    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.1.2"
1349    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.5.2 (jar)"
1350    "dcaegen2/services/sdk", "", "DCAE SDK 1.4.3 (jar)"
1351    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.4.0"
1352         
1353
1354 Known Limitations, Issues and Workarounds
1355 -----------------------------------------
1356
1357     * BPGenerator yaml Fixes are different for yaml file and string (DCAEGEN2-2489)
1358     * Slice Analysis - Avoid removal of data when insufficient samples are present (DCAEGEN2-2509)
1359     * HV-VES - Pod recovery when config-fetch fails (DCAEGEN2-2516)
1360     
1361
1362 *System Limitations*
1363
1364 None
1365
1366 *Known Vulnerabilities*
1367
1368 None
1369
1370 *Workarounds*
1371
1372 Documented under corresponding jira if applicable.
1373
1374 Security Notes
1375 --------------
1376
1377 *Fixed Security Issues*
1378     Listed above
1379     
1380 *Known Security Issues*
1381
1382         None
1383         
1384         
1385 *Known Vulnerabilities in Used Modules*
1386
1387         None
1388         
1389 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>`_.
1390
1391 Test Results
1392 ------------
1393
1394  - `DCAE R7 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Guilin+Release>`_
1395  - `DCAE MOD R7 Test <https://wiki.onap.org/display/DW/DCAE+R7+Testplan>`_
1396
1397
1398 References
1399 ----------
1400
1401 For more information on the ONAP Guilin release, please see:
1402
1403 #. `ONAP Home Page`_
1404 #. `ONAP Documentation`_
1405 #. `ONAP Release Downloads`_
1406 #. `ONAP Wiki Page`_
1407
1408
1409 .. _`ONAP Home Page`: https://www.onap.org
1410 .. _`ONAP Wiki Page`: https://wiki.onap.org
1411 .. _`ONAP Documentation`: https://docs.onap.org
1412 .. _`ONAP Release Downloads`: https://git.onap.org
1413
1414 Quick Links:
1415
1416         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1417         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1418
1419
1420
1421
1422 ..      ======================================
1423 ..      * * *    EL-ALTO  MAINTENANCE  * * *
1424 ..      ======================================
1425
1426
1427 Version: 5.0.2
1428 ==============
1429
1430 Abstract
1431 --------
1432
1433 This document provides the release notes for the El-Alto Maintenance release
1434
1435
1436 Summary
1437 -------
1438
1439 This maintenance release is primarily to update expired certificates 
1440 from original El-Alto released TLS-init container.
1441
1442 This patch is not required for Frankfurt release (and beyond) as certificates are dynamically 
1443 retrieved from AAF at deployment time for all DCAE components.
1444
1445 Release Data
1446 ------------
1447
1448 +--------------------------------------+--------------------------------------+
1449 | **Project**                          | DCAE                                 |
1450 |                                      |                                      |
1451 +--------------------------------------+--------------------------------------+
1452 | **Docker images**                    | onap/org.onap.dcaegen2.deployments   |
1453 |                                      |   .tls-init-container:1.0.4          |
1454 +--------------------------------------+--------------------------------------+
1455 | **Release designation**              | El-Alto  Maintenance Release         |
1456 |                                      |                                      |
1457 +--------------------------------------+--------------------------------------+
1458 | **Release date**                     | 2020/08/24                           |
1459 |                                      |                                      |
1460 +--------------------------------------+--------------------------------------+
1461
1462 New features
1463 ------------
1464
1465 None
1466
1467 **Bug fixes**
1468
1469 - `DCAEGEN2-2206 <https://jira.onap.org/browse/DCAEGEN2-2206>`_ DCAE TLS Container : Address certificate expiration
1470
1471 **Known Issues**
1472 Same as El-Alto Release
1473
1474
1475
1476 ..      ======================================
1477 ..      * * *    FRANKFURT  MAINTENANCE  * * *
1478 ..      ======================================
1479
1480
1481 Version: 6.0.1
1482 ==============
1483
1484 Abstract
1485 --------
1486
1487 This document provides the release notes for the Frankfurt Maintenance release
1488
1489
1490 Summary
1491 -------
1492
1493 The focus of this release is to correct issues found on Frankfurt release.
1494
1495 Release Data
1496 ------------
1497
1498 +--------------------------------------+--------------------------------------+
1499 | **Project**                          | DCAE                                 |
1500 |                                      |                                      |
1501 +--------------------------------------+--------------------------------------+
1502 | **Docker images**                    | onap/org.onap.dcaegen2.services.     |
1503 |                                      |   son-handler:2.0.4                  |
1504 +--------------------------------------+--------------------------------------+
1505 | **Release designation**              | Frankfurt  Maintenance Release 1     |
1506 |                                      |                                      |
1507 +--------------------------------------+--------------------------------------+
1508 | **Release date**                     | 2020/08/17                           |
1509 |                                      |                                      |
1510 +--------------------------------------+--------------------------------------+
1511
1512 New features
1513 ------------
1514
1515 None
1516
1517 **Bug fixes**
1518
1519 - `DCAEGEN2-2249 <https://jira.onap.org/browse/DCAEGEN2-2249>`_ SON-Handler: Fix networkId issue while making call to oof
1520 - `DCAEGEN2-2216 <https://jira.onap.org/browse/DCAEGEN2-2216>`_ SON-Handler: Change Policy notification  to align with policy component updates
1521
1522 **Known Issues**
1523
1524 Same as Frankfurt Release
1525
1526
1527
1528
1529 ..      ===========================
1530 ..      * * *    FRANKFURT    * * *
1531 ..      ===========================
1532
1533
1534 Version: 6.0.0
1535 ==============
1536
1537
1538 Abstract
1539 --------
1540
1541 This document provides the release notes for the Frankfurt release.
1542
1543 Summary
1544 -------
1545
1546 Following DCAE components are available with default ONAP/DCAE installation.
1547
1548     - Platform components
1549
1550         - Cloudify Manager (helm chart)
1551         - Bootstrap container (helm chart)
1552         - Configuration Binding Service (helm chart)
1553         - Deployment Handler (helm chart)
1554         - Policy Handler (helm chart
1555         - Service Change Handler (helm chart)
1556         - Inventory API (helm chart)
1557         - Dashboard (helm chart)
1558
1559     - Service components
1560
1561         - VES Collector
1562         - Threshold Crossing Analytics (TCA/CDAP)
1563         - HV-VES Collector
1564         - PNF-Registration Handler
1565         - Docker based Threshold Crossing Analytics (TCA-Gen2)
1566         - Holmes Rule Management *
1567         - Holmes Engine Management *
1568
1569     - Additional resources that DCAE utilizes deployed using ONAP common charts:
1570     
1571         - Postgres Database
1572         - Mongo Database
1573         - Redis Cluster Database
1574         - Consul Cluster 
1575
1576 Below service components (mS) are available to be deployed on-demand.
1577
1578         - SNMPTrap Collector
1579         - RESTConf Collector
1580         - DataFile Collector
1581         - PM-Mapper 
1582         - BBS-EventProcessor
1583         - VES Mapper
1584         - Heartbeat mS
1585         - SON-Handler
1586         - PM-Subscription Handler
1587
1588     Notes:
1589
1590         \*  These components are delivered by the Holmes project.
1591
1592
1593
1594 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.
1595
1596
1597 Release Data
1598 ------------
1599
1600 +--------------------------------------+--------------------------------------------------------+
1601 | **DCAE Project**                     |                                                        |
1602 |                                      |                                                        |
1603 +--------------------------------------+--------------------------------------------------------+
1604 | **Docker images**                    |Refer :any:`Deliverable <frankfurt_deliverable>`        |
1605 |                                      |                                                        |
1606 +--------------------------------------+--------------------------------------------------------+
1607 | **Release designation**              | 6.0.0 frankfurt                                        |
1608 |                                      |                                                        |
1609 +--------------------------------------+--------------------------------------------------------+
1610 | **Release date**                     | 2020-06-04                                             |
1611 |                                      |                                                        |
1612 +--------------------------------------+--------------------------------------------------------+
1613
1614
1615 New features
1616 ------------
1617
1618 - DCAE Platform Enhancement
1619
1620     - Introduction of Microservice and Onboarding Design (MOD) platform 
1621     - Policy Notification support for DCAE components
1622     - Dynamic AAF certificate creation during component instantiation
1623     - Helm chart optimization to control each platform component separate
1624     - Dashboard Optimization 
1625     - Blueprint generator tool to simplify deployment artifact creation
1626    
1627
1628 - Following new services are delivered this release
1629
1630     - Event Processors
1631     
1632         - PM Subscription Handler
1633         - DataLake Handlers 
1634     - Analytics/RCA
1635     
1636         - TCA-GEN2
1637         
1638         - Acumos Adapter (PoC)
1639
1640 .. _frankfurt_deliverable:
1641
1642 Deliverables
1643 ------------
1644
1645 Software Deliverables
1646
1647 .. csv-table::
1648    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
1649    :widths: auto
1650
1651    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
1652    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
1653    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
1654    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
1655    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
1656    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
1657    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
1658    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
1659    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
1660    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
1661    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
1662    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
1663    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
1664    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
1665    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
1666    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
1667    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
1668    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
1669    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
1670    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
1671    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
1672    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6" 
1673    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
1674    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
1675    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"  
1676    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
1677    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
1678    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
1679    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
1680    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
1681    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
1682    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
1683    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
1684    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
1685    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
1686    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
1687    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
1688    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
1689    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
1690    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
1691         
1692
1693 Known Limitations, Issues and Workarounds
1694 -----------------------------------------
1695
1696     * Blueprint generator escape char issue (DCAEGEN2-2140)
1697     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
1698     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
1699
1700
1701
1702 *System Limitations*
1703
1704 None
1705
1706 *Known Vulnerabilities*
1707
1708 None
1709
1710 *Workarounds*
1711
1712 Documented under corresponding jira if applicable.
1713
1714 Security Notes
1715 --------------
1716
1717 *Fixed Security Issues*
1718
1719     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1720     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1721     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1722     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1723     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1724
1725     
1726 *Known Security Issues*
1727
1728         None
1729         
1730         
1731 *Known Vulnerabilities in Used Modules*
1732
1733         None
1734         
1735 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>`_.
1736
1737 Test Results
1738 ------------
1739
1740  - `DCAE R6 Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
1741  - `DCAE MOD R6 Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
1742
1743
1744 References
1745 ----------
1746
1747 For more information on the ONAP Frankfurt release, please see:
1748
1749 #. `ONAP Home Page`_
1750 #. `ONAP Documentation`_
1751 #. `ONAP Release Downloads`_
1752 #. `ONAP Wiki Page`_
1753
1754
1755 .. _`ONAP Home Page`: https://www.onap.org
1756 .. _`ONAP Wiki Page`: https://wiki.onap.org
1757 .. _`ONAP Documentation`: https://docs.onap.org
1758 .. _`ONAP Release Downloads`: https://git.onap.org
1759
1760 Quick Links:
1761
1762         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1763         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1764
1765
1766 ..      =========================
1767 ..      * * *    EL-ALTO    * * *
1768 ..      =========================
1769
1770
1771 Version: 5.0.1
1772 ==============
1773
1774 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
1775
1776 Following is summary of updates done for DCAEGEN2
1777
1778 **Security**
1779
1780 Following platform components were enabled for HTTPS
1781     - ConfigBindingService (CBS)
1782       -   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>`_
1783     - Cloudify Manager
1784     - InventoryAPI
1785     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
1786
1787 All components interfacing with platform components were modified to support TLS interface
1788
1789 **Miscellaneous**
1790     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
1791     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
1792     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
1793     - CBS client libraries updated to remove consul service lookup
1794     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
1795
1796
1797
1798 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.
1799     - Platform components
1800         - Cloudify Manager (helm chart)
1801         - Bootstrap container (helm chart)
1802         - Configuration Binding Service (helm chart)
1803         - Deployment Handler (helm chart)
1804         - Policy Handler (helm chart
1805         - Service Change Handler (helm chart)
1806         - Inventory API (helm chart)
1807         - Dashboard (helm charts)
1808     - Service components
1809         - VES Collector
1810         - SNMP Collector
1811         - Threshold Crossing Analytics
1812         - HV-VES Collector
1813         - PNF-Registration Handler
1814         - Holmes Rule Management *
1815         - Holmes Engine Management *
1816     - Additional resources that DCAE utilizes:
1817         - Postgres Database
1818         - Redis Cluster Database
1819         - Consul Cluster *
1820
1821     Notes:
1822         \*  These components are delivered by external ONAP project.
1823
1824 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
1825
1826     - Collectors
1827         - RESTConf collector 
1828         - DataFile collector
1829     - Event Processors
1830         - VES Mapper
1831         - 3gpp PM-Mapper
1832         - BBS Event processor
1833     - Analytics/RCA
1834         - SON-Handler
1835         - Missing Heartbeat Ms
1836
1837 - All DCAE components are designed to support platform maturity requirements.
1838
1839
1840 **Source Code**
1841
1842 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.
1843     - dcaegen2
1844     - dcaegen2.analytics.tca
1845     - dcaegen2.collectors.snmptrap
1846     - dcaegen2.collectors.ves
1847     - dcaegen2.collectors.hv-ves
1848     - dcaegen2.collectors.datafile
1849     - dcaegen2.collectors.restconf
1850     - dcaegen2.deployments
1851     - dcaegen2.platform.blueprints
1852     - dcaegen2.platform.cli
1853     - dcaegen2.platform.configbinding
1854     - dcaegen2.platform.deployment-handler
1855     - dcaegen2.platform.inventory-api
1856     - dcaegen2.platform.plugins
1857     - dcaegen2.platform.policy-handler
1858     - dcaegen2.platform.servicechange-handler
1859     - dcaegen2.services.heartbeat
1860     - dcaegen2.services.mapper
1861     - dcaegen2.services.pm-mapper
1862     - dcaegen2.services.prh
1863     - dcaegen2.services.son-handler
1864     - dcaegen2.services
1865     - dcaegen2.services.sdk
1866     - dcaegen2.utils
1867     - ccsdk.platform.plugins
1868     - ccsdk.dashboard
1869
1870 **Bug Fixes**
1871     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1872     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1873
1874
1875 **Known Issues**
1876     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1877
1878 **Security Notes**
1879
1880 *Fixed Security Issues*
1881     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1882     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1883     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1884     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1885     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1886
1887 *Known Security Issues*
1888     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1889     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1890     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1891     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1892     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1893
1894 *Known Vulnerabilities in Used Modules*
1895
1896 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>`_.
1897
1898 Quick Links:
1899         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1900
1901         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1902
1903         - `Project Vulnerability Review Table for DCAE (El-Alto Maintenance) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1904
1905
1906 **Upgrade Notes**
1907
1908 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
1909     - K8S Bootstrap container:
1910        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
1911        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
1912     - Configuration Binding Service:
1913        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
1914        - Description: HTTPS support, Image optimization and non-root user
1915     - Inventory API
1916        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
1917        - Description: HTTPS support, container optmization and non-root user
1918     - DataFile Collector
1919        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
1920        - Description : Code optimization, bug fixes, dmaap plugin integration
1921     - SON Handler MS
1922        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
1923        - Description : Image optimization, bug fixes, CBS integration
1924     - VES Adapter/Mapper MS
1925        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
1926        - Description : Image optimization & CBS periodic polling
1927     - PRH MS
1928        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
1929        - Description : Code optimization, bug fixes and SDK alignment
1930     - HV-VES MS
1931        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
1932        - Description : Code optimization, bug fixes and SDK alignment
1933
1934 Version: 5.0.0
1935 ==============
1936
1937 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
1938
1939 Following is summary of updates done for DCAEGEN2
1940
1941 **Security**
1942
1943 Following platform components were enabled for HTTPS
1944     - ConfigBindingService (CBS)
1945       -   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>`_
1946     - Cloudify Manager
1947     - InventoryAPI
1948
1949 All components interfacing with platform components were modified to support TLS interface
1950
1951 **Miscellaneous**
1952     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
1953     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
1954     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
1955     - CBS client libraries updated to remove consul service lookup
1956
1957
1958
1959 **Bug Fixes**
1960     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
1961     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
1962
1963
1964 **Known Issues**
1965     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
1966
1967
1968 **Security Notes**
1969
1970 *Fixed Security Issues*
1971
1972 *Known Security Issues*
1973
1974     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
1975     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
1976     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
1977     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
1978     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
1979     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
1980     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
1981     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
1982     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
1983     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
1984
1985 *Known Vulnerabilities in Used Modules*
1986
1987 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>`_.
1988
1989 Quick Links:
1990         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
1991
1992         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
1993
1994         - `Project Vulnerability Review Table for DCAE (El-Alto) <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
1995
1996
1997 **Upgrade Notes**
1998
1999 The following components are upgraded from Dublin/R4.
2000     - Cloudify Manager:
2001        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
2002        - 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.
2003     - K8S Bootstrap container:
2004        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
2005        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
2006     - Configuration Binding Service:
2007        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
2008        - Description: HTTPS support, Image optimization and non-root user
2009     - Deployment Handler
2010        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
2011        - Description: Update to node10, uninstall workflow updates
2012     - Service Change Handler
2013        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
2014        - Description: HTTPS inventoryAPI support, container optmization and non-root user
2015     - Inventory API
2016        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
2017        - Description: HTTPS support, container optmization and non-root user
2018     - DataFile Collector
2019        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
2020        - Description : Code optimization, bug fixes, dmaap plugin integration
2021     - 3gpp PM-Mapper
2022        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
2023        - Description: Code optimization, bug fixes, dmaap plugin integration
2024
2025
2026
2027 Version: 4.0.0
2028 ==============
2029
2030 :Release Date: 2019-06-06
2031
2032 **New Features**
2033
2034 DCAE R4 improves upon previous release with the following new features:
2035
2036 - DCAE Platform Enhancement
2037     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
2038     - Support helm chart deployment in DCAE using new Helm cloudify plugin
2039     - DCAE Healthcheck enhancement to cover static and dynamic deployments
2040     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
2041     - Dashboard Integration (UI for deployment/verification)
2042     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
2043     - Blueprint generator tool to simplify deployment artifact creation
2044     - Cloudify Manager resiliency
2045
2046 - Following new services are delivered with Dublin
2047     - Collectors
2048         - RESTConf collector 
2049     - Event Processors
2050         - VES Mapper
2051         - 3gpp PM-Mapper
2052         - BBS Event processor
2053     - Analytics/RCA
2054         - SON-Handler
2055         - Heartbeat MS
2056
2057 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
2058     - Platform components
2059         - Cloudify Manager (helm chart)
2060         - Bootstrap container (helm chart)
2061         - Configuration Binding Service (helm chart)
2062         - Deployment Handler (helm chart)
2063         - Policy Handler (helm chart
2064         - Service Change Handler (helm chart)
2065         - Inventory API (helm chart)
2066         - Dashboard (Cloudify Blueprint)
2067     - Service components
2068         - VES Collector
2069         - SNMP Collector
2070         - Threshold Crossing Analytics
2071         - HV-VES Collector
2072         - PNF-Registration Handler
2073         - Holmes Rule Management *
2074         - Holmes Engine Management *
2075     - Additional resources that DCAE utilizes:
2076         - Postgres Database
2077         - Redis Cluster Database
2078         - Consul Cluster *
2079
2080     Notes:
2081         \*  These components are delivered by the Holmes project.
2082
2083
2084 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.
2085
2086 - All DCAE components are designed to support platform maturity requirements.
2087
2088
2089 **Source Code**
2090
2091 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
2092     - dcaegen2
2093     - dcaegen2.analytics.tca
2094     - dcaegen2.collectors.snmptrap
2095     - dcaegen2.collectors.ves
2096     - dcaegen2.collectors.hv-ves
2097     - dcaegen2.collectors.datafile
2098     - dcaegen2.collectors.restconf
2099     - dcaegen2.deployments
2100     - dcaegen2.platform.blueprints
2101     - dcaegen2.platform.cli
2102     - dcaegen2.platform.configbinding
2103     - dcaegen2.platform.deployment-handler
2104     - dcaegen2.platform.inventory-api
2105     - dcaegen2.platform.plugins
2106     - dcaegen2.platform.policy-handler
2107     - dcaegen2.platform.servicechange-handler
2108     - dcaegen2.services.heartbeat
2109     - dcaegen2.services.mapper
2110     - dcaegen2.services.pm-mapper
2111     - dcaegen2.services.prh
2112     - dcaegen2.services.son-handler
2113     - dcaegen2.services
2114     - dcaegen2.services.sdk
2115     - dcaegen2.utils
2116     - ccsdk.platform.plugins
2117     - ccsdk.dashboard
2118
2119 **Bug Fixes**
2120
2121 **Known Issues**
2122     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
2123
2124
2125 **Security Notes**
2126
2127 *Fixed Security Issues*
2128
2129 *Known Security Issues*
2130
2131     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
2132     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
2133     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
2134     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
2135     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
2136     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
2137     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
2138     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
2139     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
2140     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
2141
2142 *Known Vulnerabilities in Used Modules*
2143
2144 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>`_.
2145
2146 Quick Links:
2147         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
2148
2149         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
2150
2151         - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
2152
2153
2154 **New component Notes**
2155 The following components are introduced in R4
2156
2157     - Dashboard
2158        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
2159        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
2160     - Blueprint generator
2161        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
2162        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
2163     - RESTConf collector 
2164        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
2165        - Description: Provides RESTConf interfaces to events from external domain controllers
2166     - VES/Universal Mapper
2167        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
2168        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
2169     - 3gpp PM-Mapper
2170        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
2171        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
2172     - BBS Event processor
2173        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
2174        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
2175     - SON-Handler
2176        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
2177        - Description: Supports PC-ANR optimization analysis and generating CL events output
2178     - Heartbeat MS
2179        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
2180        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
2181
2182
2183 **Upgrade Notes**
2184
2185 The following components are upgraded from R3
2186     - Cloudify Manager:
2187        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
2188        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
2189     - K8S Bootstrap container:
2190        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
2191        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
2192     - Configuration Binding Service:
2193        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
2194        - Description: Code optimization and bug fixes
2195     - Deployment Handler
2196        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
2197        - Include updates for health and service endpoint check and bug fixes
2198     - Policy Handler
2199        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
2200        - Description: Policy Handler supports the new lifecycle API's from Policy framework
2201     - Service Change Handler
2202        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
2203        - Description: No update from R3
2204     - Inventory API
2205        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
2206        - Description: Refactoring and updates for health and service endpoint check
2207     - VES Collector
2208        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
2209        - Description : Authentication enhancement, refactoring and bug-fixes
2210     - Threshold Crossing Analytics
2211        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
2212        - 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.
2213     - DataFile Collector
2214        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
2215        - Description : Code optimization, bug fixes, logging and performance improvement
2216     - PNF Registrator handler
2217        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
2218        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
2219     - HV-VES Collector
2220        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
2221        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
2222     - SNMP Trap Collector
2223        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
2224        - Description : Code coverage improvements
2225
2226
2227
2228
2229 Version: 3.0.1
2230 ==============
2231
2232 :Release Date: 2019-01-31
2233
2234 DCAE R3 Maintenance release includes following fixes
2235
2236 **Bug Fixes**
2237
2238 - DataFileCollector
2239      - DCAEGEN2-940
2240        Larger files of size 100Kb publish to DR
2241      - DCAEGEN2-941
2242        DFC error after running over 12 hours
2243      - DCAEGEN2-1001
2244        Multiple Fileready notification not handled
2245
2246 - HighVolume VES Collector (protobuf/tcp)
2247      - DCAEGEN2-976
2248        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
2249
2250 - VESCollector (http)
2251      - DCAEGEN2-1035
2252        Issue with VES batch event publish
2253
2254 - Heat deployment
2255      - DCAEGEN2-1007
2256        Removing obsolete services configuration
2257
2258
2259 The following containers are updated in R3.0.1
2260
2261     - DataFile Collector
2262        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
2263     - HV-VES Collector
2264        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
2265     - VES Collector
2266        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
2267
2268 **Known Issues**
2269
2270 - 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
2271
2272 - 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
2273     kubectl get deployments -n onap | grep deployment-handler
2274     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
2275     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
2276
2277
2278
2279
2280 Version: 3.0.0
2281 --------------
2282
2283 :Release Date: 2018-11-30
2284
2285 **New Features**
2286
2287 DCAE R3 improves upon previous release with the following new features:
2288
2289 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
2290     - Platform components
2291         - Cloudify Manager
2292         - Bootstrap container
2293         - Configuration Binding Service
2294         - Deployment Handler
2295         - Policy Handler
2296         - Service Change Handler
2297         - Inventory API
2298     - Service components
2299         - VES Collector
2300         - SNMP Collector
2301         - Threshold Crossing Analytics
2302         - Holmes Rule Management *
2303         - Holmes Engine Management *
2304     - Additional resources that DCAE utilizes:
2305         - Postgres Database
2306         - Redis Cluster Database
2307         - Consul Cluster
2308
2309     Notes:
2310         \*  These components are delivered by the Holmes project.
2311
2312 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
2313
2314     - 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".
2315     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
2316
2317 - 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.
2318
2319 - All DCAE components are designed to support platform maturity requirements.
2320
2321
2322 **Source Code**
2323
2324 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
2325     - dcaegen2
2326     - dcaegen2.analytics
2327     - dcaegen2.analytics.tca
2328     - dcaegen2.collectors
2329     - dcaegen2.collectors.snmptrap
2330     - dcaegen2.collectors.ves
2331     - dcaegen2.collectors.hv-ves
2332     - dcaegen2.collectors.datafile
2333     - dcaegen2.deployments
2334     - dcaegen2.platform
2335     - dcaegen2.platform.blueprints
2336     - dcaegen2.platform.cli
2337     - dcaegen2.platform.configbinding
2338     - dcaegen2.platform.deployment-handler
2339     - dcaegen2.platform.inventory-api
2340     - dcaegen2.platform.plugins
2341     - dcaegen2.platform.policy-handler
2342     - dcaegen2.platform.servicechange-handler
2343     - dcaegen2.services.heartbeat
2344     - dcaegen2.services.mapper
2345     - dcaegen2.services.prh
2346     - dcaegen2.utils
2347
2348 **Bug Fixes**
2349
2350 **Known Issues**
2351
2352 - 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.
2353
2354 **Security Notes**
2355
2356 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>`_.
2357
2358 Quick Links:
2359         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
2360
2361         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
2362
2363         - `Project Vulnerability Review Table for DCAE (Casablanca) <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
2364
2365
2366 **New component Notes**
2367 The following components are introduced in R3
2368
2369     - DataFile Collector
2370        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
2371        - Description : Bulk data file collector to fetch non-realtime PM data
2372     - PNF Registrator handler
2373        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
2374        - Description : Recieves VES registration event and updates AAI and SO
2375     - HV-VES Collector
2376        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
2377        - Description : High Volume VES Collector for fetching real-time PM measurement data
2378     - SNMP Trap Collector
2379        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
2380        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
2381
2382
2383 **Upgrade Notes**
2384
2385 The following components are upgraded from R2:
2386     - Cloudify Manager:
2387        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
2388        - 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.
2389     - Bootstrap container:
2390        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
2391        - 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.
2392     - Configuration Binding Service:
2393        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
2394        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
2395     - Deployment Handler
2396        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
2397     - Policy Handler
2398        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
2399        - Description: Policy Handler now supports the new configuration policy format and support for TLS
2400     - Service Change Handler
2401        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
2402        - Description: Refactoring.
2403     - Inventory API
2404        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
2405        - Description: Refactoring.
2406     - VES Collector
2407        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
2408        - Description : Refactoring
2409     - Threshold Crossing Analytics
2410        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
2411        - 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.
2412
2413
2414
2415
2416 Version: 2.0.0
2417 ==============
2418
2419 :Release Date: 2018-06-07
2420
2421 **New Features**
2422
2423 DCAE R2 improves upon previous release with the following new features:
2424
2425 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
2426     - Platform components
2427         - Cloudify Manager
2428         - Bootstrap container
2429         - Configuration Binding Service
2430         - Deployment Handler
2431         - Policy Handler
2432         - Service Change Handler
2433         - Inventory API
2434     - Service components
2435         - VES Collector
2436         - SNMP Collector
2437         - Threshold Crossing Analytics
2438         - Holmes Rule Management *
2439         - Holmes Engine Management *
2440     - Additional resources that DCAE utilizes:
2441         - Postgres Database
2442         - Redis Cluster Database
2443         - Consul Cluster
2444
2445     Notes:
2446         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
2447
2448 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
2449
2450     - 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".
2451     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
2452
2453 - 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.
2454
2455 - All DCAE components are designed to support platform maturity requirements.
2456
2457
2458 **Source Code**
2459
2460 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
2461     - dcaegen2
2462     - dcaegen2.analytics
2463     - dcaegen2.analytics.tca
2464     - dcaegen2.collectors
2465     - dcaegen2.collectors.snmptrap
2466     - dcaegen2.collectors.ves
2467     - dcaegen2.deployments
2468     - dcaegen2.platform
2469     - dcaegen2.platform.blueprints
2470     - dcaegen2.platform.cli
2471     - dcaegen2.platform.configbinding
2472     - dcaegen2.platform.deployment-handler
2473     - dcaegen2.platform.inventory-api
2474     - dcaegen2.platform.plugins
2475     - dcaegen2.platform.policy-handler
2476     - dcaegen2.platform.servicechange-handler
2477     - dcaegen2.services.heartbeat
2478     - dcaegen2.services.mapper
2479     - dcaegen2.services.prh
2480     - dcaegen2.utils
2481
2482 **Bug Fixes**
2483
2484 **Known Issues**
2485
2486 - 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.
2487
2488 **Security Notes**
2489
2490 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>`_.
2491
2492 Quick Links:
2493         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
2494
2495         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
2496
2497         - `Project Vulnerability Review Table for DCAE (Beijing) <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
2498
2499
2500
2501 **Upgrade Notes**
2502
2503 The following components are upgraded from R1:
2504     - Cloudify Manager:
2505        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
2506        - 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.
2507     - Bootstrap container:
2508        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
2509        - 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.
2510     - Configuration Binding Service:
2511        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
2512        - Description: Configuration Binding Sevice now supports the new configuration policy format.
2513     - Deployment Handler
2514        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
2515     - Policy Handler
2516        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
2517        - Description: Policy Handler now supports the new configuration policy format.
2518     - Service Change Handler
2519        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
2520        - Description: Refactoring.
2521     - Inventory API
2522        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
2523        - Description: Refactoring.
2524     - VES Collector
2525        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
2526     - Threshold Crossing Analytics
2527        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
2528        - 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.
2529
2530
2531
2532 Version: 1.0.0
2533 ==============
2534
2535 :Release Date: 2017-11-16
2536
2537
2538 **New Features**
2539
2540 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
2541 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
2542 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
2543 vDNS, vCPU, and vVoLTE.
2544
2545 Specifically, DCAE R1 includes the following components:
2546
2547 - Core platform
2548     - Cloudify manager
2549     - Consul cluster
2550 - Extended platform
2551     - Platform component docker host
2552     - Service component docker host
2553     - CDAP cluster
2554     - PostgreSQL database (*)
2555 - Platform docker container components
2556     - Configuration binding service
2557     - Deployment handler
2558     - Service change handler
2559     - Inventory
2560     - Policy handler
2561     - CDAP broker
2562 - Service components
2563     - Docker container components
2564         - VNF Event Streaming (VES) collector
2565         - Holmes (engine and rule management) **
2566     - CDAP analytics component
2567         - Threshold Crossing Analytics (TCA)
2568
2569 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
2570 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
2571 other deployment configurations not used in the R1 demos.)
2572 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
2573 in R1.
2574
2575 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
2576
2577 - dcaegen2
2578 - dcaegen2/analytics
2579 - dcaegen2/analytics/tca
2580 - dcaegen2/collectors
2581 - dcaegen2/collectors/snmptrap
2582 - dcaegen2/collectors/ves
2583 - dcaegen2/deployments
2584 - dcaegen2/platform
2585 - dcaegen2/platform/blueprints
2586 - dcaegen2/platform/cdapbroker
2587 - dcaegen2/platform/cli
2588 - dcaegen2/platform/configbinding
2589 - dcaegen2/platform/deployment-handler
2590 - dcaegen2/platform/inventory-api
2591 - dcaegen2/platform/plugins
2592 - dcaegen2/platform/policy-handler
2593 - dcaegen2/platform/servicechange-handler
2594 - dcaegen2/utils
2595
2596
2597 **Bug Fixes**
2598
2599 This is the initial release.
2600
2601
2602 **Known Issues**
2603
2604 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
2605 - Need to provide a dev configuration DCAE.
2606
2607
2608 **Security Issues**
2609
2610 - 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>`_.>`_.
2611 - 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.
2612
2613
2614 **Upgrade Notes**
2615
2616 This is the initial release.
2617
2618
2619 **Deprecation Notes**
2620
2621 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
2622 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
2623 following Gerrit repos are voided and already locked as read-only.
2624
2625 - dcae
2626 - dcae/apod
2627 - dcae/apod/analytics
2628 - dcae/apod/buildtools
2629 - dcae/apod/cdap
2630 - dcae/collectors
2631 - dcae/collectors/ves
2632 - dcae/controller
2633 - dcae/controller/analytics
2634 - dcae/dcae-inventory
2635 - dcae/demo
2636 - dcae/demo/startup
2637 - dcae/demo/startup/aaf
2638 - dcae/demo/startup/controller
2639 - dcae/demo/startup/message-router
2640 - dcae/dmaapbc
2641 - dcae/operation
2642 - dcae/operation/utils
2643 - dcae/orch-dispatcher
2644 - dcae/pgaas
2645 - dcae/utils
2646 - dcae/utils/buildtools
2647 - ncomp
2648 - ncomp/cdap
2649 - ncomp/core
2650 - ncomp/docker
2651 - ncomp/maven
2652 - ncomp/openstack
2653 - ncomp/sirius
2654 - ncomp/sirius/manager
2655 - ncomp/utils
2656
2657
2658 **Other**
2659
2660 SNMP trap collector is seed code delivery only.