diff options
Diffstat (limited to 'docs/sections')
| -rw-r--r-- | docs/sections/apis/swagger_vescollector.json | 2 | ||||
| -rw-r--r-- | docs/sections/apis/swagger_vescollector.yaml | 2 | ||||
| -rw-r--r-- | docs/sections/architecture.rst | 6 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 10 | ||||
| -rw-r--r-- | docs/sections/services/ves-http/installation.rst | 26 |
5 files changed, 22 insertions, 24 deletions
diff --git a/docs/sections/apis/swagger_vescollector.json b/docs/sections/apis/swagger_vescollector.json index 90cc769e..05376ae4 100644 --- a/docs/sections/apis/swagger_vescollector.json +++ b/docs/sections/apis/swagger_vescollector.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "1.3.2", + "version": "1.4.5", "title": "VES Collector", "description": "Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics\n", "termsOfService": "urn:tos", diff --git a/docs/sections/apis/swagger_vescollector.yaml b/docs/sections/apis/swagger_vescollector.yaml index a2ed6a4d..978ea1d7 100644 --- a/docs/sections/apis/swagger_vescollector.yaml +++ b/docs/sections/apis/swagger_vescollector.yaml @@ -16,7 +16,7 @@ # swagger: '2.0' info: - version: 1.3.2 + version: 1.4.5 title: VES Collector description: > Virtual Event Streaming (VES) Collector is RESTful collector for processing diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst index 349f58b5..f4084eeb 100644 --- a/docs/sections/architecture.rst +++ b/docs/sections/architecture.rst @@ -22,11 +22,7 @@ data collection needs, event processors for data standardization, analytics tha collection and analytics, and support other ONAP functions. Service components and DMaaP buses form the "data plane" for DCAE, where DCAE collected data is transported among different DCAE service components. -DCAE use Consul's distributed K-V store service to manage component configurations where each key is based on the unique identity of a -DCAE component (identified by ServiceComponentName), and the value is the configuration for the corresponding component. The K-V store for each service components is -created during deployment. DCAE platform creates and updates the K-V pairs based on information provided as part of the control loop blueprint deployment, or through a notification/trigger received from other ONAP components such as Policy Framework and CLAMP. Either through periodically polling or proactive pushing, the DCAE - components get the configuration updates in realtime and apply the configuration updates. DCAE Platform also offers dynamic template resolution for configuration parameters that are dynamic and only known by the DCAE platform, such as dynamically provisioned DMaaP topics. This approach standardizes component deployment and -configuration management for DCAE service components in multi-site deployment. +DCAE use Consul's distributed K-V store service to manage component configurations where each key is based on the unique identity of a DCAE component (identified by ServiceComponentName), and the value is the configuration for the corresponding component. The K-V store for each service components is created during deployment. DCAE platform creates and updates the K-V pairs based on information provided as part of the control loop blueprint deployment, or through a notification/trigger received from other ONAP components such as Policy Framework and CLAMP. Either through periodically polling or proactive pushing, the DCAE components get the configuration updates in realtime and apply the configuration updates. DCAE Platform also offers dynamic template resolution for configuration parameters that are dynamic and only known by the DCAE platform, such as dynamically provisioned DMaaP topics. This approach standardizes component deployment and configuration management for DCAE service components in multi-site deployment. DCAE R4 Components diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index d5ec7495..8e375ffd 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -98,8 +98,8 @@ Source code of DCAE components are released under the following repositories on **Bug Fixes** **Known Issues** - * VES Collector basic authentication not working (DCAEGEN2-1541) - This has no impact on the Dublin usecases; will be addressed for El-Alto if not sooner. + * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594) + **Security Notes** @@ -152,7 +152,7 @@ The following components are introduced in R4 - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0 - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events - SON-Handler - - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.2 + - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3 - Description: Supports PC-ANR optimization analysis and generating CL events output - Heartbeat MS - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0 @@ -184,7 +184,7 @@ The following components are upgraded from R3 - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0 - Description: Refactoring and updates for health and service endpoint check - VES Collector - - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.4 + - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5 - Description : Authentication enhancement, refactoring and bug-fixes - Threshold Crossing Analytics - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2 @@ -193,7 +193,7 @@ The following components are upgraded from R3 - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3 - Description : Code optimization, bug fixes, logging and performance improvement - PNF Registrator handler - - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.3 + - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4 - Description : Code optimization, SDK integration, PNF-UPDATE flow support - HV-VES Collector - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0 diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst index 42d11e10..308a2ce3 100644 --- a/docs/sections/services/ves-http/installation.rst +++ b/docs/sections/services/ves-http/installation.rst @@ -177,12 +177,12 @@ and remove following entry and save the changes; K8S will update the service de get_input: ves_other_publish_url type: message_router collector.dynamic.config.update.frequency: "5" - docker_config: - healthcheck: - endpoint: /healthcheck - interval: 15s - timeout: 1s - type: https + #docker_config: + # healthcheck: + # endpoint: /healthcheck + # interval: 15s + # timeout: 1s + # type: https image: get_input: tag_version replicas: {get_input: replicas} @@ -211,20 +211,19 @@ To undeploy ves-tls, steps are noted below cfy uninstall ves-tls -The deployment uninstall will also delete the blueprint. In somecase you might notice 400 error reported indicating active deployment exist such as below +The deployment uninstall will also delete the blueprint. In some case you might notice 400 error reported indicating active deployment exist such as below ** An error occurred on the server: 400: Can't delete blueprint ves-tls - There exist deployments for this blueprint; Deployments ids: ves-tls** -In this case bluepint can be deleted explicitly using this command. +In this case blueprint can be deleted explicitly using this command. .. code-block:: bash cfy blueprint delete ves-tls -Note: When VESCollector is required to be deployed under *auth.method=certOnly* the blueprint above should be modified - - * Change auth.method: certBasicAuth to auth.method: certOnly - * Comment out following lines in blueprint to disable readiness check (DCAEGEN2-1594) +Known Issue : When VESCollector is required to be deployed with authentication enabled *auth.method=certOnly* or *auth.method: certBasicAuth* or *auth.method: basicAuth* +the blueprint currently disables healthcheck parameters configuration (below). This causes no readiness probe to be deployed in K8S when VES Collector is deployed with authentication enabled. + .. code-block:: bash docker_config: @@ -233,3 +232,6 @@ Note: When VESCollector is required to be deployed under *auth.method=certOnly* interval: 15s timeout: 1s type: https + + +The healthcheck support when VESauthentication is enabled needs a different solution to be worked. This will be worked as future enhancement (DCAEGEN2-1594) |