MSB Integration Guide Service RegistrationDiscoveryRouting with MSB OOM

MSB Integration Guide

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

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

Service Registration – Service Endpoint Info 4 Attribute Description service. Name Service Name version Service Version url the actual URL of the service to be registered protocol supported protocols: 'REST', 'UI', 'HTTP', 'TCP' visual. Range 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/{service. Name} /{version}. The customized publish path should only be used for backcompatible. 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

A&AI MSB Integration • Provide A&AI service endpoints definition for consumption Define the service according to ONAP RESTful API definition Specification Keep the old RESTful URL for back-compatible Service service. Name version url Cloud Infrastructure AAI-Cloud. Infrastructure v 1 /cloud-infrastructure REST 1 Cloud Infrastructure AAI-Cloud. Infrastructure-deprecated v 1 /cloud-infrastructure REST 1 Service Design And Creation AAI-service-design-and-creation v 1 /service-design-and-creation REST 1 Service Design And Creation AAI-service-design-and-creationdeprecated v 1 /service-design-and-creation REST 1 /api/AAI-Cloud. Infrastructure/v 1 protocol visual Range path /cloud-infrastructure /ervice-design-and-creation /cloud-infrastructure/ A&AI 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. 5

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