update test external check readme
### test-external-check
-This is a container used to test external checks in Kuberhealthy. This container simply runs, waits for a set interval of seconds and then either reports a success or failure depending on the `REPORT_FAILURE` environment variable set in the pod spec. Simply set `REPORT_FAILURE` to `"true"` (a string not a bool) to cause this check to report an error message.
+This is a container used to test external checks in Kuberhealthy. This container simply runs, waits for a set interval of seconds and then either reports a success or failure depending on the `REPORT_FAILURE` environment variable set in the pod spec.
+
+
+##### Environment Variables
+
+`REPORT_FAILURE` can be set to `"true"` to cause the check to report a failure instead of success.
+`REPORT_DELAY` can be set to a duration of time (5s or 3h for example) to configure how long the check waits before reporting back to Kuberhealthy. By default this is set to 5s.
##### Example `khcheck`
-The pod is designed to wait every few seconds before reporting a success or failure to the Kuberhealthy API. The pod is also design to log any errors it encounters when communicating to the Kuberhealthy API.
+The pod is also design to log any errors it encounters when communicating to the Kuberhealthy API.
Below is a YAML template for enabling the test-external-check in Kuberhealthy.
@@ -30,6 +36,8 @@ spec:
- env:
- name: REPORT_FAILURE
value: "false"
+ - name: REPORT_DELAY
+ value: "10s"
image: kuberhealthy/test-external-check:v1.1.0
name: main
resources:
@@ -37,21 +45,3 @@ spec:
cpu: 10m
memory: 50Mi
```
-
-You don't have to use the default settings in the above YAML. Change specs as needed to extend or shorten timeouts or run intervals.
-
-##### Local Image Pull (optional)
-
-By setting your external check pod spec `imagePullPolicy` to `Never` you will allow Kubernetes to pull the image locally from your Kubernetes hosts. This enables you to build the container inside of Kubernetes more rapidly instead of fetching it from the web.
-
-See below on a example on how to set `imagePullPolicy`:
-
-```yaml
- containers:
- - env:
- - name: REPORT_FAILURE
- value: "false"
- image: kuberhealthy/test-external-check:v1.1.0
- imagePullPolicy: Never
- name: main
-```
