From 22872ddddd3c4e3646a2d01d42b534fdea469b8d Mon Sep 17 00:00:00 2001 From: "Pérez Caparrós David, INI-ONE-MBL-MEE" Date: Thu, 26 Mar 2020 12:17:50 +0100 Subject: Update BBS use case documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit BBS use case documentation needs additional updates in Frankfurt release Issue-ID: INT-1444 Signed-off-by: Pérez Caparrós David, INI-ONE-MBL-MEE Change-Id: I5d44898f4e7d7d628181a0140b7b13d8b57a8170 --- docs/docs_BBS.rst | 202 +++++++++-------------- docs/files/bbs/BBS_dcae-ves-collector_config.png | Bin 0 -> 591369 bytes 2 files changed, 81 insertions(+), 121 deletions(-) create mode 100644 docs/files/bbs/BBS_dcae-ves-collector_config.png (limited to 'docs') diff --git a/docs/docs_BBS.rst b/docs/docs_BBS.rst index fabcc9cf0..240c3099b 100644 --- a/docs/docs_BBS.rst +++ b/docs/docs_BBS.rst @@ -28,7 +28,7 @@ In Frankfurt release, BBS enables ONAP to - Service location modification that is detected by ONAP's analytic and initiated via the closed loop capabilities - The closed loop capabilities invoke a HSIA location change service that - is orchestrated and controlled using ONAP capabilities and 3rd party controllers + is orchestrated and controlled using ONAP capabilities and 3rd party controllers |image1| @@ -52,29 +52,10 @@ SO: Custom Workflow Configuration :: - ~/oom/kubernetes# kubectl edit cm dev-so-so-bpmn-infra-app-configmap - - mso: - ... - oof: - auth: test:testpwd - callbackEndpoint: http://so-bpmn-infra.onap:8081/mso/WorkflowMessage - endpoint: https://oof-osdf.onap:8698/api/oof/v1/placement - timeout: PT30M - workflow: - + custom: - + BBS_E2E_Service: - + sdnc: - + need: true - + resource: - + sequence: VnfVirtualLink,CPE,AccessConnectivity,InternetProfile,PonUni,OltNni,OntNni - CreateGenericVNFV1: - aai: - volume-group: - uri: /aai/v6/cloud-infrastructure/volume-groups/volume-group - default: - aai: - ... + ~/oom/kubernetes# kubectl edit cm dev-so-bpmn-infra-app-configmap + + ## replace "workflow:\n CreateGenericVNFV1:\n" + ## with "workflow:\n custom:\n BBS_E2E_Service:\n sdnc:\n need: true\n CreateGenericVNFV1:\n" ## Restart the pod ~/oom/kubernetes# kubectl delete po dev-so-so-bpmn-infra-7556d7f6bc-8fthk @@ -86,7 +67,7 @@ IMPORTANT: make sure vnf_recipe.NF_ROLE matches vnf_resource.MODEL_NAME, and vnf :: - root@onap-rancher-daily:/home/ubuntu# kubectl exec -ti dev-mariadb-galera-mariadb-galera-0 sh + root@onap-rancher-daily:/home/ubuntu# kubectl exec -ti dev-mariadb-galera-0 sh sh-4.2$ mysql -u root -p MariaDB [(none)]> use catalogdb; MariaDB [catalogdb]> INSERT INTO vnf_recipe (NF_ROLE, ACTION, SERVICE_TYPE, VERSION_STR, DESCRIPTION, ORCHESTRATION_URI, VNF_PARAM_XSD, RECIPE_TIMEOUT) @@ -113,8 +94,8 @@ Create the required topics in DMaaP :: - curl -X POST \ - http://mr.api.simpledemo.openecomp.org:30227/topics/create \ + curl -kX POST \ + https://mr.api.simpledemo.openecomp.org:30226/topics/create \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ @@ -125,8 +106,8 @@ Create the required topics in DMaaP "replicationCount": "3" }' - curl -X POST \ - http://mr.api.simpledemo.openecomp.org:30227/topics/create \ + curl -kX POST \ + https://mr.api.simpledemo.openecomp.org:30226/topics/create \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ @@ -137,8 +118,8 @@ Create the required topics in DMaaP "replicationCount": "3" }' - curl -X POST \ - http://mr.api.simpledemo.openecomp.org:30227/topics/create \ + curl -kX POST \ + https://mr.api.simpledemo.openecomp.org:30226/topics/create \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ @@ -149,8 +130,8 @@ Create the required topics in DMaaP "replicationCount": "3" }' - curl -X POST \ - http://mr.api.simpledemo.openecomp.org:30227/topics/create \ + curl -kX POST \ + https://mr.api.simpledemo.openecomp.org:30226/topics/create \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ @@ -161,55 +142,44 @@ Create the required topics in DMaaP "replicationCount": "3" }' + curl -k 'https://mr.api.simpledemo.openecomp.org:30226/topics' + + { + "topics": [ + "org.onap.dmaap.mr.PNF_REGISTRATION", + "unauthenticated.DCAE_CL_OUTPUT", + "AAI-EVENT", + "SDC-DISTR-STATUS-TOPIC-AUTO", + "SDC-DISTR-NOTIF-TOPIC-AUTO", + "org.onap.dmaap.mr.PNF_READY", + "unauthenticated.PNF_READY", + "POLICY-PDP-PAP", + "unauthenticated.CPE_AUTHENTICATION", + "unauthenticated.VES_MEASUREMENT_OUTPUT", + "unauthenticated.PNF_UPDATE", + "org.onap.dmaap.mr.mirrormakeragent", + "__consumer_offsets" + ] + } + + DCAE: BBS Event Processor (BBS-ep) ================================== -Description: :doc:`BBS-ep <../../dcaegen2.git/docs/sections/services/bbs-event-processor/index.rst>`_ +Description: :doc:`BBS-ep <../../dcaegen2.git/docs/sections/services/bbs-event-processor/index>` + +The following BBS event processor blueprint will be used: + +- `k8s-bbs-event-processor.yaml `_ -The following BBS event processor blueprints will be used: -- `k8s-bbs-event-processor.yaml `_ -- `bbs-event-processor-input.yaml `_ The BBS-ep deployment procedure: :: - ~/oom/kubernetes# kubectl exec -ti dev-dcaegen2-dcae-bootstrap-85f664d489-54pmt bash - - [root@dev-dcaegen2-dcae-bootstrap-85f664d489-54pmt /]# cfy blueprints validate /blueprints/k8s-bbs-event-processor.yaml - Validating blueprint: /blueprints/k8s-bbs-event-processor.yaml-template - Blueprint validated successfully - - [root@dev-dcaegen2-dcae-bootstrap-85f664d489-54pmt /]# cfy blueprints upload -b bbs-ep /blueprints/k8s-bbs-event-processor.yaml - Uploading blueprint /blueprints/k8s-bbs-event-processor.yaml... - k8s-bbs-event-pro... |################################################| 100.0% - Blueprint uploaded. The blueprint's id is bbs-ep - [root@dev-dcaegen2-dcae-bootstrap-85f664d489-54pmt /]# cfy deployments create -b bbs-ep -i /bbs-event-processor-input.yaml bbs-ep - Creating new deployment from blueprint bbs-ep... - Deployment created. The deployment's id is bbs-ep - - [root@dev-dcaegen2-dcae-bootstrap-85f664d489-54pmt /]# cfy executions start -d bbs-ep install - Executing workflow install on deployment bbs-ep [timeout=900 seconds] - 2019-05-01 11:35:32.007 CFY Starting 'install' workflow execution - 2019-05-01 11:35:32.587 CFY [bbs-event-processor_yd5ucp] Creating node instance - 2019-05-01 11:35:32.587 CFY [bbs-event-processor_yd5ucp.create] Sending task 'k8splugin.create_for_components' - 2019-05-01 11:35:33.953 LOG [bbs-event-processor_yd5ucp.create] INFO: Added config for s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor - 2019-05-01 11:35:33.953 LOG [bbs-event-processor_yd5ucp.create] INFO: Added config for s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor - 2019-05-01 11:35:34.596 CFY [bbs-event-processor_yd5ucp.create] Task succeeded 'k8splugin.create_for_components' - 2019-05-01 11:35:34.596 CFY [bbs-event-processor_yd5ucp] Node instance created - 2019-05-01 11:35:34.596 CFY [bbs-event-processor_yd5ucp] Configuring node instance: nothing to do - 2019-05-01 11:35:35.227 CFY [bbs-event-processor_yd5ucp] Starting node instance - 2019-05-01 11:35:35.227 CFY [bbs-event-processor_yd5ucp.start] Sending task 'k8splugin.create_and_start_container_for_components' - 2019-05-01 11:35:36.818 LOG [bbs-event-processor_yd5ucp.start] INFO: Passing k8sconfig: {'tls': {u'cert_path': u'/opt/tls/shared', u'image': u'nexus3.onap.org:10001/onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3-STAGING-latest'}, 'filebeat': {u'config_map': u'dcae-filebeat-configmap', u'config_path': u'/usr/share/filebeat/filebeat.yml', u'log_path': u'/var/log/onap', u'image': u'docker.elastic.co/beats/filebeat:5.5.0', u'data_path': u'/usr/share/filebeat/data', u'config_subpath': u'filebeat.yml'}, 'consul_dns_name': u'consul-server.onap', 'image_pull_secrets': [u'onap-docker-registry-key'], 'namespace': u'onap', 'consul_host': 'consul-server:8500', 'default_k8s_location': u'central'} - 2019-05-01 11:35:36.818 LOG [bbs-event-processor_yd5ucp.start] INFO: k8s deployment initiated successfully for s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor: {'services': ['s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor', 'xs4d51b24f52264857b7ef520be9efc46b-bbs-event-processor'], 'namespace': u'onap', 'location': u'central', 'deployment': 'dep-s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor'} - 2019-05-01 11:35:36.818 LOG [bbs-event-processor_yd5ucp.start] INFO: Waiting up to 1800 secs for s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor to become ready - 2019-05-01 11:36:58.376 LOG [bbs-event-processor_yd5ucp.start] INFO: Done starting: s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor - 2019-05-01 11:36:57.873 LOG [bbs-event-processor_yd5ucp.start] INFO: k8s deployment is ready for: s4d51b24f52264857b7ef520be9efc46b-bbs-event-processor - 2019-05-01 11:36:59.119 CFY [bbs-event-processor_yd5ucp.start] Task succeeded 'k8splugin.create_and_start_container_for_components' - 2019-05-01 11:36:59.119 CFY [bbs-event-processor_yd5ucp] Node instance started - 2019-05-01 11:36:59.119 CFY 'install' workflow execution succeeded - Finished executing workflow install on deployment bbs-ep - * Run 'cfy events list -e 7f285182-4f85-478c-95f3-b8b6970f7c8d' to retrieve the execution's events/logs + root@onap-nfs:/home/ubuntu# kubectl exec -ti dev-dcae-bootstrap-7599b45c77-czxsx -n onap bash + bash-4.2$ cfy install -b bbs-ep -d bbs-ep /blueprints/k8s-bbs-event-processor.yaml + IMPORTANT: Make sure that the configuration of BBS-ep in Consul contains the following version for the close loop policy in order to match the version expected by BBS APEX policy: @@ -217,70 +187,49 @@ IMPORTANT: Make sure that the configuration of BBS-ep in Consul contains the fol "application.clVersion": "1.0.2" + DCAE: RESTCONF Collector ======================== -Description: :doc:`RESTCONF Collector <../../dcaegen2.git/docs/sections/services/restconf/index.rst>`_ +Description: :doc:`RESTCONF Collector <../../dcaegen2.git/docs/sections/services/restconf/index>` + +The following RESTCONF collector blueprint will be used: + +- `k8s-restconf.yaml `_ -The following RESTCONF collector blueprints will be used: -- `k8s-rcc-policy.yaml `_ RESTCONF Collector deployment procedure: :: - [root@dev-dcaegen2-dcae-bootstrap-779767c49c-7cvdw /]# cfy blueprints validate blueprints/k8s-rcc-policy.yaml - Validating blueprint: blueprints/k8s-rcc-policy.yaml - Blueprint validated successfully - - [root@dev-dcaegen2-dcae-bootstrap-779767c49c-7cvdw /]# cfy blueprints upload -b restconfcollector /blueprints/k8s-rcc-policy.yaml - Uploading blueprint /blueprints/k8s-rcc-policy.yaml... - k8s-rcc-policy.yaml |#################################################| 100.0% - Blueprint uploaded. The blueprint's id is restconfcollector - - [root@dev-dcaegen2-dcae-bootstrap-779767c49c-7cvdw /]# cfy deployments create -b restconfcollector - Creating new deployment from blueprint restconfcollector... - Deployment created. The deployment's id is restconfcollector - - [root@dev-dcaegen2-dcae-bootstrap-779767c49c-7cvdw /]# cfy executions start -d restconfcollector install - Executing workflow install on deployment restconfcollector [timeout=900 seconds] - 2020-01-13 15:12:52.119 CFY Starting 'install' workflow execution - 2020-01-13 15:12:52.701 CFY [rcc_k8s_8qm5me] Creating node instance - 2020-01-13 15:12:52.701 CFY [rcc_k8s_8qm5me.create] Sending task 'k8splugin.create_for_platforms' - 2020-01-13 15:12:55.168 LOG [rcc_k8s_8qm5me.create] INFO: Added config for dcaegen2-collectors-rcc - 2020-01-13 15:12:55.747 LOG [rcc_k8s_8qm5me.create] INFO: Done setting up: dcaegen2-collectors-rcc - 2020-01-13 15:12:55.747 CFY [rcc_k8s_8qm5me.create] Task succeeded 'k8splugin.create_for_platforms' - 2020-01-13 15:12:55.747 CFY [rcc_k8s_8qm5me] Node instance created - 2020-01-13 15:12:56.341 CFY [rcc_k8s_8qm5me] Configuring node instance: nothing to do - 2020-01-13 15:12:56.341 CFY [rcc_k8s_8qm5me] Starting node instance - 2020-01-13 15:12:56.341 CFY [rcc_k8s_8qm5me.start] Sending task 'k8splugin.create_and_start_container_for_platforms' - 2020-01-13 15:12:57.559 LOG [rcc_k8s_8qm5me.start] INFO: Starting k8s deployment for dcaegen2-collectors-rcc, image: nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1, env: {'CONSUL_HOST': u'consul-server.onap.svc.cluster.local', u'DMAAPHOST': u'message-router.onap.svc.cluster.local', 'CONFIG_BINDING_SERVICE': u'config_binding_service', u'CBS_HOST': u'config-binding-service.dcae.svc.cluster.local', u'DMAAPPORT': u'3904', u'CBS_PORT': u'10000', u'CONSUL_PORT': u'8500', u'DMAAPPUBTOPIC': u'unauthenticated.DCAE_RCC_OUTPUT'}, kwargs: {'readiness': {u'endpoint': u'/healthcheck', u'type': u'http', u'timeout': u'1s', u'interval': u'15s'}, 'tls_info': {}, 'replicas': 1, u'envs': {u'CONSUL_HOST': u'consul-server.onap.svc.cluster.local', u'DMAAPHOST': u'message-router.onap.svc.cluster.local', u'CONFIG_BINDING_SERVICE': u'config_binding_service', u'CBS_HOST': u'config-binding-service.dcae.svc.cluster.local', u'DMAAPPORT': u'3904', u'CBS_PORT': u'10000', u'CONSUL_PORT': u'8500', u'DMAAPPUBTOPIC': u'unauthenticated.DCAE_RCC_OUTPUT'}, 'labels': {'cfydeployment': u'restconfcollector', 'cfynodeinstance': u'rcc_k8s_8qm5me', 'cfynode': u'rcc_k8s'}, 'ctx': , 'always_pull_image': False, 'resource_config': {}, 'log_info': {u'log_directory': u'/opt/app/RCCollector/logs'}, u'ports': [u'8080:30416'], 'k8s_location': u'central'} - 2020-01-13 15:12:58.275 LOG [rcc_k8s_8qm5me.start] INFO: Passing k8sconfig: {'tls': {u'cert_path': u'/opt/tls/shared', u'image': u'nexus3.onap.org:10001/onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3', u'ca_cert_configmap': u'dev-dcaegen2-dcae-bootstrap-dcae-cacert', u'component_ca_cert_path': u'/opt/dcae/cacert/cacert.pem'}, 'filebeat': {u'config_map': u'dcae-filebeat-configmap', u'config_path': u'/usr/share/filebeat/filebeat.yml', u'log_path': u'/var/log/onap', u'image': u'docker.elastic.co/beats/filebeat:5.5.0', u'data_path': u'/usr/share/filebeat/data', u'config_subpath': u'filebeat.yml'}, 'consul_dns_name': u'consul-server.onap', 'image_pull_secrets': [u'onap-docker-registry-key'], 'namespace': u'onap', 'consul_host': 'consul-server:8500', 'default_k8s_location': u'central'} - 2020-01-13 15:12:58.275 LOG [rcc_k8s_8qm5me.start] INFO: k8s deployment initiated successfully for dcaegen2-collectors-rcc: {'services': ['dcaegen2-collectors-rcc', 'xdcaegen2-collectors-rcc'], 'namespace': u'onap', 'location': u'central', 'deployment': 'dep-dcaegen2-collectors-rcc'} - 2020-01-13 15:12:58.275 LOG [rcc_k8s_8qm5me.start] INFO: Waiting up to 1800 secs for dcaegen2-collectors-rcc to become ready - 2020-01-13 15:13:29.970 LOG [rcc_k8s_8qm5me.start] INFO: k8s deployment is ready for: dcaegen2-collectors-rcc - 2020-01-13 15:13:30.550 CFY [rcc_k8s_8qm5me.start] Task succeeded 'k8splugin.create_and_start_container_for_platforms' - 2020-01-13 15:13:30.550 CFY [rcc_k8s_8qm5me] Node instance started - 2020-01-13 15:13:31.265 CFY 'install' workflow execution succeeded - Finished executing workflow install on deployment restconfcollector - * Run 'cfy events list -e 2ea4f906-536b-48b1-aa34-dd6b4baed255' to retrieve the execution's events/logs + root@onap-nfs:/home/ubuntu# kubectl exec -ti dev-dcae-bootstrap-7599b45c77-czxsx -n onap bash + bash-4.2$ cfy install -b restconf -d restconf /blueprints/k8s-restconf.yaml + DCAE: VES mapper ================ -Installation instructions: :doc:`VES Mapper <../../dcaegen2.git/docs/sections/services/mapper/index.rst>`_ +Description: :doc:`VES Mapper <../../dcaegen2.git/docs/sections/services/mapper/index>` + +The following VES mapper blueprint will be used: -The following VES mapper blueprints will be used: -- `k8s-vesmapper.yaml `_ +- `k8s-ves-mapper.yaml `_ + + +VES Mapper deployment procedure: + +:: + + root@onap-nfs:/home/ubuntu# kubectl exec -ti dev-dcae-bootstrap-7599b45c77-czxsx -n onap bash + bash-4.2$ cfy install -b ves-mapper -d ves-mapper /blueprints/k8s-ves-mapper.yaml -IMPORTANT: Set the image to nexus3.onap.org:10001/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0 in the blueprint DCAE: VES collector =================== Configure the mapping of the VES event domain to the correct DMaaP topic in Consul: ves-statechange --> unauthenticated.CPE_AUTHENTICATION -1. Access Consul UI: `:30270/ui/#/dc1/services>`_ +1. Access Consul UI http://CONSUL_SERVER_UI:30270/ui/#/dc1/services 2. Modify the dcae-ves-collector configuration by adding a new VES domain to DMaaP topic mapping @@ -288,6 +237,8 @@ Configure the mapping of the VES event domain to the correct DMaaP topic in Cons "ves-statechange": {"type": "message_router", "dmaap_info": {"topic_url": "http://message-router:3904/events/unauthenticated.CPE_AUTHENTICATION"}} +|image3| + 3. Click on UPDATE in order to apply the new configuration @@ -306,7 +257,8 @@ Make sure that the following BBS DGs in the SDNC DGBuilder are in Active state bbs-internet-profile-vnf-topology-operation-delete-huawei validate-bbs-vnf-input-parameters -DGBuilder URL: ``_ +DGBuilder URL: https://sdnc.api.simpledemo.onap.org:30203 + Access SDN M&C DG ================= @@ -321,7 +273,8 @@ Configure Access SDN M&C IP address in SDNC DG using dgbuilder. For instance: 3. Import back the DG and Activate it -DGBuilder URL: ``_ +DGBuilder URL: https://sdnc.api.simpledemo.onap.org:30203 + Edge SDN M&C DG =============== @@ -335,14 +288,15 @@ Configure Edge SDN M&C IP address in SDNC DG using dgbuilder. For instance: 3. Import back the DG and Activate it -DGBuilder URL: ``_ +DGBuilder URL: https://sdnc.api.simpledemo.onap.org:30203 + Add SSL certificate of the 3rd party controller into the SDNC trust store ========================================================================= :: - kubectl exec -ti dev-sdnc-sdnc-0 -n onap -- bash + kubectl exec -ti dev-sdnc-0 -n onap -- bash openssl s_client -connect : # copy server certificate and paste in /tmp/.crt @@ -368,6 +322,7 @@ Deployment procedure of BBS APEX Policy (master, apex-pdp image v2.3+) API: POST URL: {{POLICY-API-URL}}/policy/api/v1/policytypes + JSON Payload: https://git.onap.org/integration/usecases/bbs/tree/policy/apex/json/bbs_policytypes.json 3. Create BBS APEX policy @@ -375,13 +330,15 @@ Deployment procedure of BBS APEX Policy (master, apex-pdp image v2.3+) API: POST URL: {{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.Apex/versions/1.0.0/policies + JSON Payload: https://git.onap.org/integration/usecases/bbs/tree/policy/apex/json/bbs_create_policy.json 4. Deploy BBS policy :: API: POST - URL: {{POLICY-PAP-URL}}/policy/pap/v1/pdps/deployments/batch + URL: {{POLICY-PAP-URL}}/policy/pap/v1/pdps/policies + JSON Payload: https://git.onap.org/integration/usecases/bbs/tree/policy/apex/json/bbs_simple_deploy.json 5. Verify the deployment @@ -390,6 +347,7 @@ Deployment procedure of BBS APEX Policy (master, apex-pdp image v2.3+) API: GET URL: {{POLICY-API-URL}}/policy/api/v1/policytypes/onap.policies.controlloop.operational.Apex/versions/1.0.0/policies/ + Edge Services: vBNG+AAA+DHCP, Edge SDN M&C ========================================== @@ -411,3 +369,5 @@ Known Issues :width: 6.5in .. |image2| image:: files/bbs/BBS_system_view.png :width: 6.5in +.. |image3| image:: files/bbs/BBS_dcae-ves-collector_config.png + :width: 6.5in diff --git a/docs/files/bbs/BBS_dcae-ves-collector_config.png b/docs/files/bbs/BBS_dcae-ves-collector_config.png new file mode 100644 index 000000000..edce5985a Binary files /dev/null and b/docs/files/bbs/BBS_dcae-ves-collector_config.png differ -- cgit 1.2.3-korg