From 3601ddf5c10e2a0dfcbbf854fd40cfbbc14074f0 Mon Sep 17 00:00:00 2001 From: Stavros Kanarakis Date: Thu, 4 Apr 2019 12:05:02 +0300 Subject: Handle CLM findings Along with CLM scan findings resolution, some minor SONAR fixes are included and a README.md file about BBS-ep service. Change-Id: Ifaeb9db0156aa459f5e5ee5fe2ae09c5f5669ece Issue-ID: DCAEGEN2-1388 Signed-off-by: Stavros Kanarakis --- components/bbs-event-processor/README.md | 76 ++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) (limited to 'components/bbs-event-processor/README.md') diff --git a/components/bbs-event-processor/README.md b/components/bbs-event-processor/README.md index e69de29b..14ecc8ce 100644 --- a/components/bbs-event-processor/README.md +++ b/components/bbs-event-processor/README.md @@ -0,0 +1,76 @@ +# BBS use case event processor + +--- + +## Overview + +BBE-ep is responsible for handling two types of events for the BBS use case. + +First are PNF re-registration internal events published by PRH (in **unauthenticated.PNF_UPDATE** DMaaP topic). +BBS-ep must process these internal events to understand if they actually constitute ONT(CPE) relocation events. +In the relocation case, it publishes an event towards **unauthenticated.DCAE_CL_OUTPUT** DMaaP topic to trigger +further Policy actions related to BBS use case. + +Second type of events are CPE authentication events originally published by the Edge SDN M&C component of BBS +use case architecture. Through RestConf-Collector or VES-Collector, these events are consumed by BBS-ep +(in **unauthenticated.CPE_AUTHENTICATION** DMaaP topic) and they are forwarded towards **unauthenticated.DCAE_CL_OUTPUT** +DMaaP topic to trigger further Policy actions related to BBS use case. + +BBE-ep periodically polls for the two events. Polling interval is configurable and can be changed dynamically from Consul. I +Its implementation is based on Reactive Streams (Reactor library), so it is fully asynchronous and non-blocking. + +## Installation and Removal + +BBS-ep is delivered as a Spring-Boot application ready to be deployed in Docker (via docker-compose). + +For Dublin release, it will be a DCAE component that can dynamically be deployed via Cloudify blueprint installation. +Steps to deploy are shown below + +- Transfer blueprint component file in DCAE bootstrap POD under /blueprints directory. Blueprint can be found in + +- Transfer blueprint component inputs file in DCAE bootstrap POD under / directory. Blueprint inputs file can be found in + +- Enter the Bootstrap POD +- Validate blueprint + cfy blueprints validate /blueprints/k8s-bbs-event-processor.yaml-template +- Upload validated blueprint + cfy blueprints upload -b bbs-ep /blueprints/k8s-bbs-event-processor.yaml-template +- Create deployment + cfy deployments create -b bbs-ep -i /bbs-event-processor-input.yaml bbs-ep +- Deploy blueprint + cfy executions start -d bbs-ep install + +To un-deploy BBS-ep, steps are shown below + +- Validate blueprint by running command + cfy uninstall bbs-ep +- Validate blueprint by running command + cfy blueprints delete bbs-ep + +## Functionality + +For more details about the exact flows and where BBS-EP fits in the overall BBS flows, visit [use case official documentation](https://wiki.onap.org/display/DW/BBS+Notifications) + +## Compiling BBS-ep + +BBS-ep is a sub-project of dcaegen2/services (inside components directory). +To build just the BBS-ep component, run the following maven command from within **components/bbs-event-processor** directory + +`mvn clean install` + +## Main API Endpoints + +Running with dev-mode of BBS-ep + + - **Heartbeat** + - GET http://:8100/heartbeat + - **Start Polling for events** + - POST http://:8100/start-tasks + - **Stop Polling for events** + - POST http://:8100/cancel-tasks + - **Execute just one polling for PNF re-registration internal events** + - POST http://:8100/poll-reregistration-events + - **Execute just one polling for CPE authentication events** + - POST http://:8100/poll-cpe-authentication-events + - **Change application logging level** + - POST http://:8100/logging/{level} \ No newline at end of file -- cgit 1.2.3-korg