You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/how-tos/setup-healthcheck.md
+21-4Lines changed: 21 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Set up healthchecks with Kuberhealthy
4
4
description: Set up healthchecks with Kuberhealthy
5
5
---
6
6
7
-
:::warning
7
+
:::warning
8
8
9
9
This feature is in beta status. It should be used with caution.
10
10
@@ -14,7 +14,7 @@ This feature is in beta status. It should be used with caution.
14
14
15
15
Nebari integrates [Kuberhealthy](https://kuberhealthy.github.io/kuberhealthy/) to perform internal healthchecks on Nebari. This is an extensible Kubernetes native framework for continuous synthetic testing. Kuberhealthy is set up to export metrics to Prometheus. This allows them to be seen in Grafana.
16
16
17
-
# Enabling
17
+
##Enabling
18
18
19
19
Healthchecks are currently considered a beta feature that we are testing. Due to this, they are disabled by default. To enable healthchecks, add the following configuration under the `monitoring` configuration in your `nebari-config.yaml`.
20
20
@@ -24,7 +24,7 @@ monitoring:
24
24
enabled: true
25
25
```
26
26
27
-
# Checking status of Healthchecks
27
+
## Checking status of Healthchecks
28
28
29
29
All healthchecks are exported as metrics to Prometheus and can be viewed in Grafana.
30
30
@@ -43,4 +43,21 @@ have metrics available.
43
43
44
44

45
45
46
-
> Note: if you have previously deployed Nebari without healthchecks, You may need to restart your Prometheus service to get it to pick up the kuberhealthy metrics.
46
+
:::note
47
+
48
+
If you have previously deployed Nebari without healthchecks, You may need to restart your Prometheus service to get it to pick up the kuberhealthy metrics.
49
+
50
+
:::
51
+
52
+
## Summary of available healthchecks
53
+
54
+
Below is an explanation of the available healthchecks. This list may not be comprehensive as work on this feature is ongoing.
| conda-store-http-check | verifies that conda-store is accessible via it's REST API |
59
+
| jupyterhub-http-check | verifies JupyterHub is running |
60
+
| dns-status-internal | verifies internal DNS is accessible |
61
+
| 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 |
62
+
| deployment | verifies that a fresh deployment can run, deploy multiple pods, pass traffic, do a rolling update (without dropping connections), and clean up successfully |
63
+
| keycloak-http-check | verifies Keycloak is accessible |
0 commit comments