...
Container/VM name | API name | API purpose | protocol used | port number or range used | TCP/UDP |
|---|---|---|---|---|---|
sdc-fe | /sdc1/feproxy/* | Proxy for all the REST calls from the SDC UI | HTTP/HTTPS | 8181/8443 | TCP |
| sdc-be | /sdc2/* | Internal APIs used by the UI. The request is passed through the Front end proxy server | HTTP/HTTPS | 8080/8443 | TCP |
| sdc-be | /sdc/* | External APIs offered to the different components for retrieving information from the SDC Catalog. These APIs are protected by basic authentication. | HTTP/HTTPS | 8080/8443 | TCP |
...
Status Information
Diagnostic:
We provide a health check script that can show the state of our application.
The script is located at /data/scripts/docker_health.sh.
The script is taken from our repository in LF on VM spin.
The script calls a REST API in the FE and BE server.
BE health Check URL:
| Code Block |
|---|
http://<BE server IP>:<BE server port>/sdc2/rest/healthCheck |
The Back end health check provides the following INFO, in case one of the components is down the server will fail requests:
...
in addition to the info retrieved from the BE the info of the Frontend server is added for the Catalog and Onboarding
FE health Check URL:
| Code Block |
|---|
http://<FE server IP>:<FE server port>/sdc1/rest/healthCheck |
type | section | description |
|---|---|---|
general SDC info | in the main section | |
| Frontend | { | describe the version of the Catalog Frontend server |
| general Onboarding info | in the onboarding section | |
{ | describe the version of the Onboarding Frontend server |
...