| Table of Contents | ||
|---|---|---|
|
...
ONAP services need to be registered to MSB to leverage the service discovery/routing/LB capabilities of MSB. The below table is the information MSB need for service registration.
See also the complementary set official reference list of externally exposed ports for OOM at OOM NodePort List - until most of the ports are generated dynamically
| Attribute | Description | Required |
|---|---|---|
| Service Name | An unique name of the service, it should be constant so the service consumer can access the service. Service name recommendation:
| Yes |
| Service Type | api or ui | Yes |
| Version | Service version. Only the major version is used in the URI. RESTful API Design Specification for ONAPSpecification#Versioning | Yes |
| URL | The actual URL of the service to be registered | Yes |
| Customized Path | The customized publish path of this service. If this 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. | No |
| Published URL | If "Customized Path" attribute is not specified,The published URL is the fixed format api/{serviceName} /{version} . If "Customized Path" attribute is specified,The published URL is the same as the "Customized Path". | Yes |
| Visual Range | Visibility of the service. External(can be accessed by external systems):0 Internal(can only be accessed by ONAP microservices):1 | Yes |
| LB Method | Load balancing method used when MSB routes the service requests. Currently, Round robin and IP hash are supported. | Yes |
| Port | The service endpoint port. | Yes |
| Enable SSL | True if the registered service is based on https. False if the registered service is based on http. Default is False. | No |
...
| Service Name | Description | Service Type | version | URL | Cstomized Path | Published URL | Visual Range | LB Method | Port | Enable SSL |
|---|---|---|---|---|---|---|---|---|---|---|
| portal | RESTful service provided by Portal Platform | api | 2 | / | N/A | /api/portal/v2/ | Internal | Round robin | 8989 |
Usecase UI
...