[HDFS-12027] Add KMS API to get service version and health check - ASF JIRA

Log work

Agile Board

Rank to Top

Rank to Bottom

Attach files

Attach Screenshot

Bulk Copy Attachments

Bulk Move Attachments

Add vote

Voters

Watch issue

Watchers

Create sub-task

Convert to sub-task

Move

Link

Clone

Labels

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: Improvement
Status: Open
Priority: Minor
Resolution: Unresolved
Affects Version/s: None
Fix Version/s: None
Component/s: kms
Labels:
None

Description

Enhancement request, add a non-privileged user API to the Key Management Server which would return the product's build version. This API would allow users the ability to quickly verify the service is up as well as to retrieve the KMS instance build version.

Suggested API:

GET http://HOST:PORT/kms/v1/key/kms_build_version

Return:

200 OK
Content-Type: application/json
{
"BuildVersion" : "<Dotted_Version>" // example "BuildVersion" : "1.2.3.4"
}

Applications for this API are health monitoring dashboards, and cluster installation reporting by Production, Service and Release engineering teams. The API would also be useful for users, clients and non-admins to do adhoc verification that a specific KMS instance is available or to check its version.

Such an API would also be useful for debugging initial bring-up of a service instance, such as validation of the KMS webserver and its interaction with ZK before the key manager(s) are necessarily working.