update external check docs with deadline
@@ -22,8 +22,7 @@ Your check only needs to do a few things:
- Read the `KH_REPORTING_URL` environment variable.
- Send a `POST` to the `KH_REPORTING_URL` with the following JSON body:
-- Ensure that your check finishes running before the unix time specified in the `KH_CHECK_RUN_DEADLINE` environment variable occurs. (Optional)
- - This is optional, but by respecting `KH_CHECK_RUN_DEADLINE` means you won't have an unexpected `400` returned from Kuberhealthy when reporting your check's status.
+- Ensure that your check finishes within the `unix` deadline specified in the `KH_CHECK_RUN_DEADLINE` environment variable. Without respecting `KH_CHECK_RUN_DEADLINE`, your check may run into a `400` error returned from Kuberhealthy when reporting your check's status.
```json
{
@@ -41,6 +40,13 @@ Simply build your program into a container, `docker push` it to somewhere your c
Clients outside of Go can be found in the [clients directory](../clients).
+#### Injected Check Pod Environment Variables
+
+```
+KH_REPORTING_URL: The Kuberhealthy URL to send POST requests to for check statuses.
+KH_CHECK_RUN_DEADLINE: The Kuberhealthy-calculated deadline for checks given in unix.
+```
+
### Creating Your `khcheck` Resource
Every check needs a `khcheck` to enable and configure it. As soon as this resource is applied to the cluster, Kuberhealthy will begin running your check. Whenever you make a change, Kuberhealthy will automatically re-load the check and restart any checks currently in progress gracefully.
