Add initial docs on k8s healthchecks #775
Conversation
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
…r status Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1
requested review from
mandy-chessell,
lpalashevski and
juergenhemelt
and removed request for
mandy-chessell and
cmgrote
|
Hopefully this doc contribution is useful - if it looks ok, please consider merging :-) |
| ### Platform | ||
| This checks if the *platform* is available. | ||
|
|
||
| #### Platform is not running |
There was a problem hiding this comment.
This call is deprecated. Should be https://44623abc-eu-gb.lb.appdomain.cloud:9443/open-metadata/platform-services/users/admin/server-platform/origin
|
|
||
| #### Platform is not running | ||
| ➜ ~ curl -k -X GET --connect-timeout 5 --max-time 5 "https://44623abc-eu-gb.lb.appdomain.cloud:9443/open-metadata/admin-services/users/admin/server-origin" | ||
| Egeria OMAG Server Platform (version 4.1-SNAPSHOT) |
There was a problem hiding this comment.
I am not sure how the platform returns a version if it is not running.
| Egeria OMAG Server Platform (version 4.1-SNAPSHOT) | ||
|
|
||
| #### Platform is running | ||
| ➜ ~ http --verify=no --pretty=format GET "https://44623abc-eu-gb.lb.appdomain.cloud:9443/open-metadata/admin-services/users/admin/server-origin" |
There was a problem hiding this comment.
Again - deprecated request
| This API call was introduced in [release 3.4](/release-notes/3-4.md) | ||
|
|
||
| #### Server is not known | ||
| ``` |
There was a problem hiding this comment.
This call indicates whether the server is running or not - the call to determine whether the server is known on the platform is {baseURL}/open-metadata/platform-services/users/{user}/server-platform/servers/{serverName}/is-known
| ``` | ||
| #### No permission for api call | ||
| ``` | ||
| ➜ ~ http --verify=no --pretty=format GET "https://44623abc-eu-gb.lb.appdomain.cloud:9443/open-metadata/admin-services/users/admin/servers/cocoMDS5/instance/status" |
There was a problem hiding this comment.
This call is deprecated - should use the platform services request {baseURL}/open-metadata/platform-services/users/{user}/server-platform/servers/{serverName}/instance/status
| } | ||
| ``` | ||
| ### Server is available | ||
| ``` |
There was a problem hiding this comment.
There is also a simpler call to test if the server is active ... {baseURL}/open-metadata/platform-services/users/{user}/server-platform/servers/{serverName}/is-active
|
|
||
| For example | ||
| ``` | ||
| curl -k -o - -X GET --connect-timeout 5 --max-time 5 "https://44623abc-eu-gb.lb.appdomain.cloud:9443/open-metadata/admin-services/users/admin/servers/cocoMDS5/instance/status" | grep '.*\"relatedHTTPCode\": 200' |
There was a problem hiding this comment.
Update for latest request
|
Thanks for the review comments. will try and propose an update |
Draft doc on api healthchecks