diff options
author | 2022-04-26 07:09:43 +0000 | |
---|---|---|
committer | 2022-04-26 07:09:43 +0000 | |
commit | d042f17bb05f70f4230d4b8572dba5b31af783ca (patch) | |
tree | 8989287c750982e4e7b1ab6a1c8e4f75bb1ff6b9 /docs | |
parent | d37317befc750699d236c124fd220b51ef4e1667 (diff) | |
parent | f30b499d4d0089975d2f3a162a46bc94c7cabe0e (diff) |
Merge "Remove deprecated MS docs"
Diffstat (limited to 'docs')
5 files changed, 0 insertions, 165 deletions
diff --git a/docs/sections/services/bbs-event-processor/development_info.rst b/docs/sections/services/bbs-event-processor/development_info.rst deleted file mode 100644 index 4f4b4b1b..00000000 --- a/docs/sections/services/bbs-event-processor/development_info.rst +++ /dev/null @@ -1,30 +0,0 @@ -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` - - -API Endpoints -============= - -Running with dev-mode of BBS-EP - - Heartbeat: **GET http://<container_address>:8100/heartbeat** - - Start Polling for events: **POST http://<container_address>:8100/start-tasks** - - Stop Polling for events: **POST http://<container_address>:8100/cancel-tasks** - - Execute just one polling for PNF re-registration internal events: **POST http://<container_address>:8100/poll-reregistration-events** - - Execute just one polling for CPE authentication events: **POST http://<container_address>:8100/poll-cpe-authentication-events** - - Change application logging level: **POST http://<container_address>:8100/logging/{level}** - -More detailed API specifications can be found in :doc:`../../apis/swagger-bbs-event-processor`. - -Maven GroupId: -============== - -org.onap.dcaegen2.services.components - -Maven Parent ArtifactId: -======================== - -org.onap.oparen:oparent:1.2.3
\ No newline at end of file diff --git a/docs/sections/services/bbs-event-processor/functionality.rst b/docs/sections/services/bbs-event-processor/functionality.rst deleted file mode 100644 index 8ddf18d2..00000000 --- a/docs/sections/services/bbs-event-processor/functionality.rst +++ /dev/null @@ -1,13 +0,0 @@ -Functionality -============= - -PNF re-registration processing logic - -.. image:: ../../images/bbs-ep-pnf-relocation.png - -CPE authentication processing logic - -.. image:: ../../images/bbs-ep-cpe-authentication.png - -For more details about the exact flows and where BBS-EP fits in the overall BBS use case flows, visit -* https://wiki.onap.org/display/DW/BBS+Notifications
\ No newline at end of file diff --git a/docs/sections/services/bbs-event-processor/index.rst b/docs/sections/services/bbs-event-processor/index.rst deleted file mode 100644 index f9fc2d8b..00000000 --- a/docs/sections/services/bbs-event-processor/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -================== -BBS-EventProcessor -================== - - -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. 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 and they are forwared 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. Its implementation -is based on Reactive Streams (Reactor library), so it is fully asynchronous and non-blocking. - - -.. toctree:: - :maxdepth: 1 - - ./installation - ./functionality - ./development_info diff --git a/docs/sections/services/bbs-event-processor/installation.rst b/docs/sections/services/bbs-event-processor/installation.rst deleted file mode 100644 index dcb8269e..00000000 --- a/docs/sections/services/bbs-event-processor/installation.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. _bbs-installation: - -Installation -============ - -BBS-ep is delivered as a Spring-Boot application ready to be deployed in Docker (via docker-compose). - -The following docker-compose-yaml file shows a default configuration. The file can be run using `docker compose up` command: - -.. code-block:: yaml - - version: '3' - services: - bbs-event-processor: - image: onap/org.onap.dcaegen2.services.components.bbs-event-processor:latest - container_name: bbs-event-processor - hostname: bbs-event-processor - ports: - - 32100:8100 - environment: - CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_DMAAPHOSTNAME: 10.133.115.190 - CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_DMAAPPORTNUMBER: 30227 - CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_DMAAPTOPICNAME: /events/unauthenticated.PNF_UPDATE - CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_CONSUMERGROUP: foo - CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_CONSUMERID: bar - CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_DMAAPHOSTNAME: 10.133.115.190 - CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_DMAAPPORTNUMBER: 30227 - CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_DMAAPTOPICNAME: /events/unauthenticated.CPE_AUTHENTICATION - CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_CONSUMERGROUP: foo - CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_CONSUMERID: bar - CONFIGS_DMAAP_PRODUCER_DMAAPHOSTNAME: 10.133.115.190 - CONFIGS_DMAAP_PRODUCER_DMAAPPORTNUMBER: 30227 - CONFIGS_DMAAP_PRODUCER_DMAAPTOPICNAME: /events/unauthenticated.DCAE_CL_OUTPUT - CONFIGS_AAI_CLIENT_AAIHOST: 10.133.115.190 - CONFIGS_AAI_CLIENT_AAIPORT: 30233 - CONFIGS_APPLICATION_PIPELINESPOLLINGINTERVALSEC: 30 - CONFIGS_APPLICATION_PIPELINESTIMEOUTSEC: 15 - CONFIGS_APPLICATION_RE-REGISTRATION_POLICYSCOPE: policyScope - CONFIGS_APPLICATION_RE-REGISTRATION_CLCONTROLNAME: controlName - CONFIGS_APPLICATION_CPE-AUTHENTICATION_POLICYSCOPE: policyScope - CONFIGS_APPLICATION_CPE-AUTHENTICATION_CLCONTROLNAME: controlName - CONFIGS_SECURITY_TRUSTSTOREPATH: KeyStore.jks - CONFIGS_SECURITY_TRUSTSTOREPASSWORDPATH: KeyStorePass.txt - CONFIGS_SECURITY_KEYSTOREPATH: KeyStore.jks - CONFIGS_SECURITY_KEYSTOREPASSWORDPATH: KeyStorePass.txt - LOGGING_LEVEL_ORG_ONAP_BBS: TRACE - -BBS-ep can be dynamically deployed in DCAE’s Cloudify environment via its blueprint deployment artifact. - -Blueprint can be found in - - https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-bbs-event-processor.yaml - -Steps to deploy are shown below - -- Enter the Bootstrap POD -- Validate blueprint - .. code-block:: bash - - cfy blueprints validate /blueprints/k8s-bbs-event-processor.yaml -- Upload validated blueprint - .. code-block:: bash - - - cfy blueprints upload -b bbs-ep /blueprints/k8s-bbs-event-processor.yaml -- Create deployment - .. code-block:: bash - - - cfy deployments create -b bbs-ep -i /blueprints/k8s-bbs-event-processor.yaml bbs-ep -- Deploy blueprint - .. code-block:: bash - - - cfy executions start -d bbs-ep install - -To undeploy BBS-ep, steps are shown below - -- Uninstall running BBS-ep and delete deployment - .. code-block:: bash - - - cfy uninstall bbs-ep -- Delete blueprint - .. code-block:: bash - - - cfy blueprints delete bbs-ep
\ No newline at end of file diff --git a/docs/sections/services/serviceindex.rst b/docs/sections/services/serviceindex.rst index 386215dd..1701f0fb 100644 --- a/docs/sections/services/serviceindex.rst +++ b/docs/sections/services/serviceindex.rst @@ -25,7 +25,6 @@ Event Processor .. toctree::
:maxdepth: 1
- ./bbs-event-processor/index.rst
./datalake-handler/index.rst
./mapper/index.rst
./pm-mapper/index.rst
|