Update README.md
Update readme for deployment check
@@ -25,7 +25,7 @@ This check follows the list of actions in order during the run of the check:
__IF ROLLING-UPDATE OPTION IS ENABLED__
5. Creates an updated deployment configuration, applies it to the namespace, and waits for the deployment to complete its rolling-update.
-6. Makes a second HTTP Get request to the servicee endpoint, looking for another `200 OK`.
+6. Makes a second HTTP Get request to the service endpoint, looking for another `200 OK`.
#### Check Details
@@ -47,6 +47,8 @@ __IF ROLLING-UPDATE OPTION IS ENABLED__
#### Example KuberhealthyCheck Spec
+The following configuration will create a deployment with 4 replicas and roll from `nginx:1.17-perl` to `nginx:1.17.5-perl`:
+
```yaml
apiVersion: comcast.github.io/v1
kind: KuberhealthyCheck
@@ -55,7 +57,7 @@ metadata:
namespace: kuberhealthy
spec:
runInterval: 30m
- timeout: 7m
+ timeout: 10m
podSpec:
containers:
- name: kh-deployment-check
@@ -76,10 +78,10 @@ spec:
value: "var1=foo,var2=bar"
resources:
requests:
- cpu: 25m
+ cpu: 15m
memory: 15Mi
limits:
- cpu: 40m
+ cpu: 25m
restartPolicy: Always
```
@@ -98,7 +100,3 @@ The check configuration file contains:
- ServiceAccount
The role, rolebinding, and service account are all required to create and delete all deployments and services from the check in the given namespaces you install the check for. The assumed default service account does not provide enough permissions for this check to run.
-
-You can also create the service account directly by running: `kubectl create serviceaccount deployment-khcheck`.
-This will create and apply the necessary secrets and tokens to your service account. Once you've created the service account, make
-sure to apply the rest of the configurations for the Role, RoleBinding, and Kuberhealthy check.
