onepassword-operator icon indicating copy to clipboard operation
onepassword-operator copied to clipboard

Add a health check endpoint to the Operator

Open mcmarkj opened this issue 3 years ago • 1 comments

Summary

To keep things consistent and ensure the operator remains online. A health check endpoint similar to what's available in the 1Password Connect container i.e. /health or /heartbeat would be fantastic.

Use cases

This would be very useful in the Kubernetes landscape as a liveness endpoint could be added to the container. Meaning that if the operator were to fail, the pod would automatically be restarted.

Proposed solution

Continual checks to the API, connection to Kubernetes etc. If any of these connections were to fail, /health would no longer return 200 and as a result, the pod would restart.

Is there a workaround to accomplish this today?

/metrics is available, but that doesn't seem like the right place to check for the liveness and readiness of the pod.

mcmarkj avatar May 30 '21 09:05 mcmarkj

Hey there!

Just thought I would give you an update on this since it has been a while. We are currently working on some changes to the operator and hope to include this as a feature in the future as I believe this would be helpful.

Cheers

jillianwilson avatar Jun 08 '22 17:06 jillianwilson