Skip to content

Commit 3673cc5

Browse files
committed
fix styling syntax, add table of explanations
1 parent e90edac commit 3673cc5

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

docs/docs/how-tos/setup-healthcheck.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Set up healthchecks with Kuberhealthy
44
description: Set up healthchecks with Kuberhealthy
55
---
66

7-
::: warning
7+
:::warning
88

99
This feature is in beta status. It should be used with caution.
1010

@@ -14,7 +14,7 @@ This feature is in beta status. It should be used with caution.
1414

1515
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.
1616

17-
# Enabling
17+
## Enabling
1818

1919
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`.
2020

@@ -24,7 +24,7 @@ monitoring:
2424
enabled: true
2525
```
2626
27-
# Checking status of Healthchecks
27+
## Checking status of Healthchecks
2828
2929
All healthchecks are exported as metrics to Prometheus and can be viewed in Grafana.
3030
@@ -43,4 +43,21 @@ have metrics available.
4343

4444
![Display of available kuberhealthy metrics in Grafana](/img/how-tos/nebari-healthchecks1.png)
4545

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.
55+
56+
| <div style={{width:180}}>Check Label</div> | Description |
57+
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
58+
| 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

Comments
 (0)