spell and grammer check and added notes to doc
### test-external-check
-This is a container for use in testing external checks on Kuberhealthy. This container simply runs and either reports a pass or fail depending on the `REPORT_FAILURE` environment variable in its spec.
+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.
-##### 2.0.0 alpha setup
+##### test-external-check Setup
-The version 2.0.0 alpha for Kubernetes image is: `quay.io/comcast/kuberhealthy:2.0.0alpha`.
+To setup external checks on Kuberhealthy 2.0.0 the container for Kubernetes can be found at: `quay.io/comcast/kuberhealthy:2.0.0`.
-You will need to run this image of kuberhealthy in your cluster before external checks are available to you.
+The external checks are only in available in Kuberhealthy 2.0.0 and later.
-You will also need to define the following CRD for Kuberhealthy 2 to use.
+To begin using the external checks be sure that the `khchecks.comcast.github.io` CRD is already applied to your cluster.
-```
+To apply the CRD simply copy and paste the YAML specs below in a new file. Then run the following command to apply the YAML file `kubectl apply -f crd-file.yaml`.
+
+```yaml
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
@@ -27,12 +29,14 @@ spec:
- khc
```
+##### Example Check Template
+
+The pod is designed to run continuously and wait every few seconds then report a success or failure when communicating to the Kuberhealthy Servers. The pod is also design to log any errors it encounters when communicating to the KuberHealthy API.
-##### Example Check
+Below is a YAML template for enabling the test-external-check in Kuberhealthy.
-An example checker pod for testing the external check functionality. Waits a few seconds and reports success every time. Logs any Kuberhealthy API communication failures.
+Simply copy and paste the YAML specs below into a new file and apply it by using the command `kubectl apply -f your-named-khcheck.yaml`.
-The spec for enabling this check in Kuberhealthy looks like this:
```yaml
apiVersion: comcast.github.io/v1
@@ -60,6 +64,20 @@ spec:
memory: 50Mi
```
-Apply this check in your cluster (normally for testing) by running `kubectl apply -f khcheck.yaml`.
+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.
-**Pro tip: by setting the `imagePullPolicy` to `Never` on your check's spec or on the kuberhealthy deoplyment in your test environment, the Docker Kubernetes cluster will pull the image from your local docker host instead of the web. This enables rapid development when doing local builds.**
+##### 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
+```
