Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/docs/how-tos/setup-healthcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,6 @@ Below is an explanation of the available healthchecks. This list may not be comp
| daemonset | verifies that a daemonset can be created, fully provisioned, and torn down. This checks the full kubelet functionality of every node in your Kubernetes cluster |
| deployment | verifies that a fresh deployment can run, deploy multiple pods, pass traffic, do a rolling update (without dropping connections), and clean up successfully |
| keycloak-http-check | verifies Keycloak is accessible |
| argo-http-check | verifies Argo Workflows Server is accessible |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd just keep Argo Workflows instead of Argo Workflows Server here but I'll leave that up to you

| dask-gateway-http-check | verifies Dask Gateway Gateway API is running |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's an extra "Gateway" in Dask Gateway

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, that's the name of the check since its the name of the actual service listed in keycloak.I think its better to list the exact match since that's whats deployed, but if we just want to raise awareness I am fine with keeping the usual names

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, that's the name of the k8s service but I feel that's internal and users reading the documentation don't need to know the exact name but rather what "Nebari service" it refers to. That said, if you want to leave it like this, I don't have a problem with that.

| grafana-http-check | verifies Grafana is accessible |
Loading