feat: add liveness and readiness probes to dialog deployment - #398
feat: add liveness and readiness probes to dialog deployment#398HussainAther wants to merge 1 commit into
Conversation
DougReeder
left a comment
There was a problem hiding this comment.
You can check that the HTTP endpoints return useful values by running the container locally. (The DNS name may be different than the service DNS name that Kubernetes provides.)
| path: https://localhost/health | ||
| port: 4443 | ||
| scheme: HTTPS |
There was a problem hiding this comment.
The probes are sent from the Kubernetes control plane; they are not run inside the container. So, they use the internal DNS names and the pod ports. Also, there is no /health path in dialog. So, I think these values need to be:
path: /meta
port: 7000
scheme: HTTP
| path: https://localhost/health | ||
| port: 4443 | ||
| scheme: HTTPS | ||
| initialDelaySeconds: 10 |
There was a problem hiding this comment.
Have you timed how long it usually takes dialog to start up?
| port: 4443 | ||
| scheme: HTTPS | ||
| initialDelaySeconds: 30 | ||
| periodSeconds: 10 |
There was a problem hiding this comment.
Line 564 of generate_script/hcce.yam has the livenessProbe for reticulum. The values there are more typical for httpGet probes.
What?
This PR adds adds Kubernetes readiness and liveness probes to the
dialogdeployment incommunity-edition/generate_script/hcce.yam.Why?
The
dialogservice currently =does not have any Kubernetes health monitoring. This PR adds the readiness and liveness that the probes allows Kubernetes to:For these reasons, this is aligns with standard Kubernetes best practices for service reliability for creating a PR.
Notes
healthendpoint referenced inHubs-Foundation/dialog#61.4443, matching the existing dialog deployment.Examples
N/A
How to test
Apply the updated deployment (or regenerate manifests if using the CE scripts).
Deploy to a Kubernetes cluster:
Verify the
dialogpod:Confirm that , based on the results of these actions :
ReadyOptionally:
Documentation of functionality
No additional documentation changes are required. This is a deployment configuration improvement within
hcce.yam.Limitations
dialog#61is stable and available.Alternative implementations considered
Open questions
/healthis the best long-term endpoint or if/healthz(used elsewhere in the repo) should be standardized across services.Additional details or related context