MSB Integration Guide

MSB Demo Pull and run the MSB dockers. sudo docker run -d --net=host --name msb_consul consul agent -dev sudo docker run -d --net=host --name msb_discovery zhaohuabing/msb_discovery sudo docker run -d --net=host -e "ROUTE_LABELS=visualRange:1" --name internal_msb_apigateway zhaohuabing/msb_apigateway Register your REST service to MSB via curl curl -X POST \ -H "Content-Type: application/json" \ -d '{"serviceName": "test", "version": "v1", "url": "/","protocol": "REST", "nodes": [ {"ip": "127.0.0.1","port": "9090"}]}' \ http://127.0.0.1:10081/api/microservices/v1/services Access the rest service via internal api gateway curl http://127.0.0.1/api/test/v1/people

Service Registration/Discovery/Routing with MSB OOM register/update service endpoint to MSB service discovery External API Gateway handle the service request form external systems(Browser, OSS, BSS, etc.) Centralized Auth is enforced at the entry point(External API Gateway), user don’t have to login to individual services for multiple times Internal API Gateway handle the service routing/LB between ONAP microservices No invasion to individual Microservice. ONAP projects don’t have to modify their codes to leverage the Registration/Discovery/Routing capabilities provided by MSB A client SDK will be provided at the next release to facilitate direct communication between ONAP microservices. ONAP Microservices MSB Service Discovery Internal API Gateway (Router) external service request External service Internal service OOM Register service AAF Authentication Authorization Desktop External Systems Mobile External API Gateway Service A A&AI VF-C … LCM(deploy/ start/ stop/ scale, etc.) Internal service request( REST) DMaaP Async Messages Routing and Load Balancing

ONAP RESTful API Definition Specification URI Construction http://[host]:[port]/api/{service name}]/v{version number}/{resource} Example: http://172.99.115.94:8480/api/policyengineservice/v1/policies Versioning Semantic Versioning http://semver.org/ Other https://wiki.onap.org/display/DW/RESTful+API+Design+Specification+for+ONAP

Service Registration – Service Endpoint Info Attribute Description serviceName Service Name version Service Version url the actual URL of the service to be registered protocol supported protocols: 'REST', 'UI', 'HTTP','TCP' visualRange Visibility of the service.  External(can be accessed by external systems):0  Internal(can only be accessed by ONAP microservices):1 path The customized publish path of this service. If path parameter is specified when registering the service, the service will be published to api gateway under this path. Otherwise, the service will be published to api gateway using a fixed format: api/{serviceName} /{version}. The customized publish path should only be used for back-compatible. nodes ip: the ip of theservice instance node port: the port of the service instance node ttl: time to live, this parameter is reserved for later use

Policy MSB Integration Provide Policy service endpoints definition for consumption Define the service according to ONAP RESTful API definition Specification Keep the old RESTful URL for back-compatible Service serviceName version url protocol visualRange path Policy engine service policyengineservice v1 /PyPDPServer REST 1 policyengineservice-deprecated Service Design And Creation AAI-service-design-and-creation /service-design-and-creation AAI-service-design-and-creation-deprecated /ervice-design-and-creation API URI conforming to standards: /api/policyengineservice/v1 API URI for back-compatible: /PyPDPServer Policy project don’t have to modify its code to provide the new API definition, MSB can translate the request to the new API to the current A&AI API. It is expected that A&AI should deprecate the old API and move to the new one in compliance with ONAP ESTful API definition specification in the later release like Beijing.

Policy MSB Integration Use the MSB internal API gateway to access other microservices Using a configuration file, we might have problems on scaling, failover and update MSB as the single entry point Before: After: “internalapigateway": "https://inernalapigateway.onap.org:80" …… How to call service: API gateway routes the request to: POST https://mso:8080/dbadapters/RequestsDbAdapter Note: If there are multiple service provider instances, MSB will choose one to send the request according to LB method POST https://internalapigateway.onap.org/api/mso/v1/dbadapters/RequestDbAdapter

Use MSB EAG as reverse proxy for UI Service Gateway Backend Server FrontEnd Server Other Services After: service gateway to solve cross-domain issue Cache for static resources (page, picture) Clearer boundary between UI and business logic page rest Backend Server FronEnd Server Before: The business logic(rest service) forwader must be add to front end server Solve the cross-domain issue cause coupling of business logic and UI pages