The CTMS Registry collects the HAL resources provided by the all different CTMS services on the platform.
A CTMS compliant service has two options to be included in the CTMS Registry:
-
It can implement a bus method named getServiceRoot that returns a top-level HAL resource with links to the functionality that the service provides.
-
If the service is running as Kubernetes service on the CloudUX platform, it can implement a REST endpoint that returns the Service Root resource and is detected by means of Kubernetes annotations in the Kubernetes Ingress configuration.
The service-root resource must contain at least the following properties:
-
The systems property should define the systems that are handled by the service.
-
The service property should contain basic information about the service.
-
The resources property must specify the HAL resources that shall be included in the CTMS Registry.
For details, see Service Root.
All services that implement a getServiceRoot bus method or have the necessary Kubernetes annotations are automatically added to the CTMS Registry. There’s no need for an explicit registration call.