docs/sections/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Release Notes
   4 =============
   5
   6 Version: 2.0.0
   7 --------------
   8
   9 :Release Date: 2018-06-07
  10
  11 **New Features**
  12 DCAE R2 improves upon previous release with the following new features:
  13
  14 - Kubernetes deployment support for DCAE.  In R2 all DCAE components can be deployed using Kubernetes into a Kubernetes cluster.  The list of a R2 DCAE include the following components.
  15     - Platform components
  16         - Cloudify Manager (Community Version 18.3.23)
  17         - Bootstrap container
  18         - Configuration Binding Service
  19         - Deployment Handler
  20         - Policy Handler
  21         - Service Change Handler
  22         - Inventory API
  23     - Service components
  24         - VES Collector
  25         - SNMP Collector
  26         - Mapper Microservice
  27         - PNF Registration Handler Microservice
  28         - Missing Heartbeat Microservice
  29         - Threshold Crossing Analytics
  30         - Holmes Rule Management*
  31         - Holmes Engine Management*
  32
  33 (*) Note: This component is delivered under the Holmes project and used as a DCAE analytics component in R2.
  34
  35 In addition, DCAE R2 utilizes the following shared resources that are provided by OOM ONAP deployment:
  36     - Postgres Database
  37     - Redis Cluster Database
  38     - Consul Cluster
  39
  40 All DCAE components are designed to support platform maturity requirements.
  41
  42 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
  43     - dcaegen2
  44     - dcaegen2.analytics
  45     - dcaegen2.analytics.tca
  46     - dcaegen2.collectors
  47     - dcaegen2.collectors.snmptrap
  48     - dcaegen2.collectors.ves
  49     - dcaegen2.deployments
  50     - dcaegen2.platform
  51     - dcaegen2.platform.blueprints
  52     - dcaegen2.platform.cli
  53     - dcaegen2.platform.configbinding
  54     - dcaegen2.platform.deployment-handler
  55     - dcaegen2.platform.inventory-api
  56     - dcaegen2.platform.plugins
  57     - dcaegen2.platform.policy-handler
  58     - dcaegen2.platform.servicechange-handler
  59     - dcaegen2.services.heartbeat
  60     - dcaegen2.services.mapper
  61     - dcaegen2.services.prh
  62     - dcaegen2.utils
  63
  64 **Bug Fixes**
  65
  66 **Known Issues**
  67
  68 **Security Notes**
  69
  70 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>`_.
  71
  72 Quick Links:
  73         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
  74
  75         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
  76
  77         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
  78
  79 **Upgrade Notes**
  80
  81
  82
  83 Version: 1.0.0
  84 --------------
  85
  86 :Release Date: 2017-11-16
  87
  88
  89 **New Features**
  90
  91 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
  92 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
  93 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
  94 vDNS, vCPU, and vVoLTE.
  95
  96 Specifically, DCAE R1 includes the following components:
  97
  98 - Core platform
  99     - Cloudify manager
 100     - Consul cluster
 101 - Extended platform
 102     - Platform component docker host
 103     - Service component docker host
 104     - CDAP cluster
 105     - PostgreSQL database (*)
 106 - Platform docker container components
 107     - Configuration binding service
 108     - Deployment handler
 109     - Service change handler
 110     - Inventory
 111     - Policy handler
 112     - CDAP broker
 113 - Service components
 114     - Docker container components
 115         - VNF Event Streaming (VES) collector
 116         - Holmes (engine and rule management) **
 117     - CDAP analytics component
 118         - Threshold Crossing Analytics (TCA)
 119
 120 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
 121 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
 122 other deployment configurations not used in the R1 demos.)
 123 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
 124 in R1.
 125
 126 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
 127
 128 - dcaegen2
 129 - dcaegen2/analytics
 130 - dcaegen2/analytics/tca
 131 - dcaegen2/collectors
 132 - dcaegen2/collectors/snmptrap
 133 - dcaegen2/collectors/ves
 134 - dcaegen2/deployments
 135 - dcaegen2/platform
 136 - dcaegen2/platform/blueprints
 137 - dcaegen2/platform/cdapbroker
 138 - dcaegen2/platform/cli
 139 - dcaegen2/platform/configbinding
 140 - dcaegen2/platform/deployment-handler
 141 - dcaegen2/platform/inventory-api
 142 - dcaegen2/platform/plugins
 143 - dcaegen2/platform/policy-handler
 144 - dcaegen2/platform/servicechange-handler
 145 - dcaegen2/utils
 146
 147
 148 **Bug Fixes**
 149
 150 This is the initial release.
 151
 152
 153 **Known Issues**
 154
 155 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
 156 - Need to provide a dev configuration DCAE.
 157
 158
 159 **Security Issues**
 160
 161 - The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches.
 162 This key is currently passed in as a Heat template parameter.  Tracked by JIRA DCAEGEN2-178.
 163 - The RESTful API calls are generally not secure.  That is, they are either over http, or https
 164 without certificate verification.  Once there is an ONAP wide solution for handling certificates,
 165 DCAE will switch to https.
 166
 167 **Upgrade Notes**
 168
 169 This is the initial release.
 170
 171
 172 **Deprecation Notes**
 173
 174 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
 175 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
 176 following Gerrit repos are voided and already locked as read-only.
 177
 178 - dcae
 179 - dcae/apod
 180 - dcae/apod/analytics
 181 - dcae/apod/buildtools
 182 - dcae/apod/cdap
 183 - dcae/collectors
 184 - dcae/collectors/ves
 185 - dcae/controller
 186 - dcae/controller/analytics
 187 - dcae/dcae-inventory
 188 - dcae/demo
 189 - dcae/demo/startup
 190 - dcae/demo/startup/aaf
 191 - dcae/demo/startup/controller
 192 - dcae/demo/startup/message-router
 193 - dcae/dmaapbc
 194 - dcae/operation
 195 - dcae/operation/utils
 196 - dcae/orch-dispatcher
 197 - dcae/pgaas
 198 - dcae/utils
 199 - dcae/utils/buildtools
 200 - ncomp
 201 - ncomp/cdap
 202 - ncomp/core
 203 - ncomp/docker
 204 - ncomp/maven
 205 - ncomp/openstack
 206 - ncomp/sirius
 207 - ncomp/sirius/manager
 208 - ncomp/utils
 209
 210
 211 **Other**
 212
 213 SNMP trap collector is seed code delivery only.