[
https://issues.apache.org/jira/browse/HDFS-12027?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
patrick white updated HDFS-12027:
---------------------------------
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.
was:
Enhancement request, add an API to the Key Management Server which can be used
for health monitoring as well as programatic version checks, such as to return
the service version identifier, suggest this;
GET http://HOST:PORT/kms/v1/key/kms_version
This API would be useful for production monitoring tools to quickly do KMS
instance reporting (dashboards) and basic health checks, as part of overall
monitoring of a Hadoop stack installation.
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. Currently i believe a valid
key needs to be setup and available before calls can return success.
> Add KMS API to get service version and health check
> ---------------------------------------------------
>
> Key: HDFS-12027
> URL: https://issues.apache.org/jira/browse/HDFS-12027
> Project: Hadoop HDFS
> Issue Type: Improvement
> Components: kms
> Reporter: patrick white
> Priority: Minor
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
