Correct RTD rendering error for DCAE component BBS-ep 44/86144/1
authorStavros Kanarakis <stavros.kanarakis@nokia.com>
Wed, 24 Apr 2019 11:13:25 +0000 (14:13 +0300)
committerStavros Kanarakis <stavros.kanarakis@nokia.com>
Wed, 24 Apr 2019 11:13:25 +0000 (14:13 +0300)
Change-Id: I2113de4aef6560ef1207afb0dce70d997bc9146c
Issue-ID: DOC-444
Signed-off-by: Stavros Kanarakis <stavros.kanarakis@nokia.com>
docs/sections/services/bbs-event-processor/installation.rst

index 5c00c0d..242f9f9 100644 (file)
@@ -7,58 +7,77 @@ The following docker-compose-yaml file shows a default configuration. The file c
 
 .. 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: controName
-      CONFIGS_APPLICATION_CPE-AUTHENTICATION_POLICYSCOPE: policyScope
-      CONFIGS_APPLICATION_CPE-AUTHENTICATION_CLCONTROLNAME: controlName
-      LOGGING_LEVEL_ORG_ONAP_BBS: TRACE
+  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: controName
+        CONFIGS_APPLICATION_CPE-AUTHENTICATION_POLICYSCOPE: policyScope
+        CONFIGS_APPLICATION_CPE-AUTHENTICATION_CLCONTROLNAME: controlName
+        LOGGING_LEVEL_ORG_ONAP_BBS: TRACE
 
 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
-  https://gerrit.onap.org/r/gitweb?p=dcaegen2/services.git;a=blob_plain;f=components/bbs-event-processor/dpo/blueprints/k8s-bbs-event-processor.yaml-template;hb=refs/heads/master
+
+    https://gerrit.onap.org/r/gitweb?p=dcaegen2/services.git;a=blob_plain;f=components/bbs-event-processor/dpo/blueprints/k8s-bbs-event-processor.yaml-template;hb=refs/heads/master
 - Transfer blueprint component inputs file in DCAE bootstrap POD under / directory. Blueprint inputs file can be found in
-  https://gerrit.onap.org/r/gitweb?p=dcaegen2/services.git;a=blob_plain;f=components/bbs-event-processor/dpo/blueprints/bbs-event-processor-input.yaml;h=36e69cf64bee3b46ee2e1b95f1a16380b7046482;hb=refs/heads/master
+
+    https://gerrit.onap.org/r/gitweb?p=dcaegen2/services.git;a=blob_plain;f=components/bbs-event-processor/dpo/blueprints/bbs-event-processor-input.yaml;hb=refs/heads/master
 - Enter the Bootstrap POD
 - Validate blueprint
-    cfy blueprints validate /blueprints/k8s-bbs-event-processor.yaml-template
+    .. code-block:: bash
+        
+        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
+    .. code-block:: bash
+        
+
+        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
+    .. code-block:: bash
+        
+
+        cfy deployments create -b bbs-ep -i /bbs-event-processor-input.yaml bbs-ep
 - Deploy blueprint
-    cfy executions start -d bbs-ep install
+    .. code-block:: bash
+        
+
+        cfy executions start -d bbs-ep install
 
 To undeploy 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
\ No newline at end of file
+- 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