Dartanlla / OWS

Open World Server system
MIT License
362 stars 339 forks source link

feat(status): add system status api to management #100

Closed CanisHelix closed 1 year ago

CanisHelix commented 1 year ago

Add /api/system/status endpoint to OWS Management

SloppyShovel commented 1 year ago

Not sure what the point of tracking the health status of the Management UI is, also it's not added to heartbeat so its not going to do anything, but tracking frontend stuff is not really needed,

Health Status and tracking microservice stack should be reserved for things that affect your backend, management is not one of them. unless there is a different reason of adding this endpoint?

CanisHelix commented 1 year ago

I didn't add this one to the heartbeat as it is, like you say, a non-essential thing.

Some development teams might like to monitor and track the update of such a UI running on a central place like a shared server/kubernetes etc. While the UI itself might be fronted by a forward-auth proxy for security, they might need an end point that could be used to allow an unauthorized status request.

Personally I like to know that all containers are up and loaded on my network, I actually ping the / endpoint as I use a custom header to determine whether or not to bypass any authentication middleware. But having a fixed endpoint might be easier for some middlewares to allow a bypass.

This is more just for giving users a choice if they wanted to do such a thing themselves.