Discover the Microservice Bus
Microservice Bus provides a service registration/discovery and routing mechanism to simply the communications between services, The service consumers only need to talk with Microservice Bus without any address information of individual service providers. However, all the service consumers/providers must know the IP and service port of Microservice Bus. MSB suggests the following approach to discover the Microservice Bus.
Each service provider/consumer implementation can get the address of the Microservice Bus from a local config file via the key 'msb.address', the default value consists of a hostname and a service port. The hostname is 'msb.onap.org', which can be resolved by a DNS server in the local network, and the default port is 80. If a DNS server is not available in some deployments, an IP should be used instead.
...
| Operation | Register service to the Microservice Bus |
|---|
| URL | /api/microservices/v1/services |
|---|
| Verb | POST |
|---|
| Request |
| Parameter | Mandatory | Parameter type | Data Type | Default | example | Description |
|---|
| Body | Y | Body | JSON String |
| {
"serviceName": "aai",
"version": "v8",
"url": "/aai/v8",
"protocol": "REST",
"visualRange": "1",
"path":"/aai/v8"
"nodes": [ {
"ip": "10.74.56.36",
"port": "8988",
"ttl": 0
}
]
}
| Described in the below table | | createOrUpdate | N | Query | boolean | true |
| true: create new instances or replace the old instances if the instance with the same service name, ipandport exist ipandportexist
false: create new instances and remove all the old instances with the same service name |
| Parameter | Mandatory | Data Type | Default | Description |
|---|
| serviceName | Y | String |
| Service Name | | version | Y | String |
| Service Version | | url | Y if protocol is 'REST' or 'UI' or 'HTTP' | String |
| the actual URL of the service to be registered | | protocol | Y | String |
| supported protocols: 'REST', 'UI', 'HTTP','TCP' | | visualRange | N | String | 1 | Visibility of the service.
External(can be accessed by external systems):0
Internal(can only be accessed by ONAP consumers microservices):1 | path | N | String |
| The customized publish Thecustomizedpublish path of this service. If path parameter is specified when registering the service, the service will be published to api gateway apigateway under this path. Otherwise, the service will be published to api gateway apigateway using a fixed format: api/{versionserviceName}/{serviceNameversion}. The customized publish path should only be used for back-compatible. | | nodes | Y | List |
| ip: the ipofthe service ipoftheservice instance node, it could also be a hostname like catalog.onap.org
port: the port of the service instance node
ttl: time to live, this parameter is reserved for later use |
|
|---|
| Response | | example | Description |
|---|
{
"serviceName": "catalog",
"version": "v1",
"url": "/api/catalog/v1",
"protocol": "REST",
"visualRange": "1",
"nodes": [
{
"ip": "10.74.55.66",
"port": "6666",
"ttl": 0
},
{
"ip": "10.74.56.37",
"port": "8989",
"ttl": 0
},
{
"ip": "10.74.56.36",
"port": "8988",
"ttl": 0
}
]
}
| serviceName: service name
version: version
url: url of the created service instance
protocol: supported protocols: 'REST', 'UI','HTTP','TCP'
nodes: the service instance nodes list to register
ip: the ip of the service instance node, it could also be a hostname like catalog.onap.org
port: the port of the service instance node
ttl: time to live, this parameter is reserved for later use
|
|
|---|
| Success Code | 201 |
|---|
| Error Code | 422 Invalid Parameters
500 Internal Server Error |
|---|
...
