docs/sections/services/bbs-event-processor/installation.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. _bbs-installation:
   4
   5 Installation
   6 ============
   7
   8 BBS-ep is delivered as a Spring-Boot application ready to be deployed in Docker (via docker-compose).
   9
  10 The following docker-compose-yaml file shows a default configuration. The file can be run using `docker compose up` command:
  11
  12 .. code-block:: yaml
  13
  14   version: '3'
  15   services:
  16     bbs-event-processor:
  17       image: onap/org.onap.dcaegen2.services.components.bbs-event-processor:latest
  18       container_name: bbs-event-processor
  19       hostname: bbs-event-processor
  20       ports:
  21       - 32100:8100
  22       environment:
  23         CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_DMAAPHOSTNAME: 10.133.115.190
  24         CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_DMAAPPORTNUMBER: 30227
  25         CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_DMAAPTOPICNAME: /events/unauthenticated.PNF_UPDATE
  26         CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_CONSUMERGROUP: foo
  27         CONFIGS_DMAAP_CONSUMER_RE-REGISTRATION_CONSUMERID: bar
  28         CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_DMAAPHOSTNAME: 10.133.115.190
  29         CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_DMAAPPORTNUMBER: 30227
  30         CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_DMAAPTOPICNAME: /events/unauthenticated.CPE_AUTHENTICATION
  31         CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_CONSUMERGROUP: foo
  32         CONFIGS_DMAAP_CONSUMER_CPE-AUTHENTICATION_CONSUMERID: bar
  33         CONFIGS_DMAAP_PRODUCER_DMAAPHOSTNAME: 10.133.115.190
  34         CONFIGS_DMAAP_PRODUCER_DMAAPPORTNUMBER: 30227
  35         CONFIGS_DMAAP_PRODUCER_DMAAPTOPICNAME: /events/unauthenticated.DCAE_CL_OUTPUT
  36         CONFIGS_AAI_CLIENT_AAIHOST: 10.133.115.190
  37         CONFIGS_AAI_CLIENT_AAIPORT: 30233
  38         CONFIGS_APPLICATION_PIPELINESPOLLINGINTERVALSEC: 30
  39         CONFIGS_APPLICATION_PIPELINESTIMEOUTSEC: 15
  40         CONFIGS_APPLICATION_RE-REGISTRATION_POLICYSCOPE: policyScope
  41         CONFIGS_APPLICATION_RE-REGISTRATION_CLCONTROLNAME: controlName
  42         CONFIGS_APPLICATION_CPE-AUTHENTICATION_POLICYSCOPE: policyScope
  43         CONFIGS_APPLICATION_CPE-AUTHENTICATION_CLCONTROLNAME: controlName
  44         CONFIGS_SECURITY_TRUSTSTOREPATH: KeyStore.jks
  45         CONFIGS_SECURITY_TRUSTSTOREPASSWORDPATH: KeyStorePass.txt
  46         CONFIGS_SECURITY_KEYSTOREPATH: KeyStore.jks
  47         CONFIGS_SECURITY_KEYSTOREPASSWORDPATH: KeyStorePass.txt
  48         LOGGING_LEVEL_ORG_ONAP_BBS: TRACE
  49
  50 BBS-ep can be dynamically deployed in DCAE’s Cloudify environment via its blueprint deployment artifact.
  51
  52 Blueprint can be found in
  53
  54     https://git.onap.org/dcaegen2/platform/blueprints/tree/blueprints/k8s-bbs-event-processor.yaml
  55
  56 Steps to deploy are shown below
  57
  58 - Enter the Bootstrap POD
  59 - Validate blueprint
  60     .. code-block:: bash
  61
  62         cfy blueprints validate /blueprints/k8s-bbs-event-processor.yaml
  63 - Upload validated blueprint
  64     .. code-block:: bash
  65
  66
  67         cfy blueprints upload -b bbs-ep /blueprints/k8s-bbs-event-processor.yaml
  68 - Create deployment
  69     .. code-block:: bash
  70
  71
  72         cfy deployments create -b bbs-ep -i /blueprints/k8s-bbs-event-processor.yaml bbs-ep
  73 - Deploy blueprint
  74     .. code-block:: bash
  75
  76
  77         cfy executions start -d bbs-ep install
  78
  79 To undeploy BBS-ep, steps are shown below
  80
  81 - Uninstall running BBS-ep and delete deployment
  82     .. code-block:: bash
  83
  84
  85         cfy uninstall bbs-ep
  86 - Delete blueprint
  87     .. code-block:: bash
  88
  89
  90         cfy blueprints delete bbs-ep