Skip to content

Commit

Permalink
fixed typos and grammar in Readme and --help
Browse files Browse the repository at this point in the history
  • Loading branch information
groundnuty committed Apr 18, 2020
1 parent 808b158 commit 3985270
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

> This tool is still actively used and working stably despite not too frequent commits! Pull requests are most welcome!
A simple script that allows to wait for a k8s service, job or pods to enter desired state.
A simple script that allows waiting for a k8s service, job or pods to enter the desired state.

## Running

Expand All @@ -22,17 +22,17 @@ Read `--help` and play with it!

```bash
/ > wait_for.sh -h
This script waits until a job, pod or service enter ready state.
This script waits until a job, pod or service enter a ready state.

wait_for.sh job [<job name> | -l<kubectl selector>]
wait_for.sh pod [<pod name> | -l<kubectl selector>]
wait_for.sh service [<service name> | -l<kubectl selector>]

Examples:
Wait for all pods with with a following label to enter 'Ready' state:
Wait for all pods with a following label to enter 'Ready' state:
wait_for.sh pod -lapp=develop-volume-gluster-krakow

Wait for all pods with with a following label to enter 'Ready' or 'Error' state:
Wait for all pods with a following label to enter 'Ready' or 'Error' state:
wait_for.sh pod-we -lapp=develop-volume-gluster-krakow

Wait for all the pods in that job to have a 'Succeeded' state:
Expand All @@ -47,7 +47,7 @@ wait_for.sh pod -l"release in (develop), chart notin (cross-support-job-3p)"
## Example
A complex Kubernetes deployment manifest (generated by [helm](https://github.com/kubernetes/helm)). This deployment waits for one job to finish and 2 pods to enter ready state.
A complex Kubernetes deployment manifest (generated by [helm](https://github.com/kubernetes/helm)). This deployment waits for one job to finish and 2 pods to enter a ready state.
```bash
kind: StatefulSet
Expand Down Expand Up @@ -108,7 +108,7 @@ spec:
## Complex deployment use case
This container is used extensively in deployments of Onedata system [onedata/charts](https://github.com/onedata/charts) for the the purpose of specifying dependencies. It leverages Kubernetes [init containers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/), thus providing:
This container is used extensively in deployments of Onedata system [onedata/charts](https://github.com/onedata/charts) to specify dependencies. It leverages Kubernetes [init containers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/), thus providing:
- a detailed event log in `kubectl describe <pod>`, on what init container is pod hanging at the moment.
- a comprehensive view in `kubectl get pods` output where init containers are shown in a form `Init:<ready>/<total>`
Expand Down
4 changes: 2 additions & 2 deletions wait_for.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ ${0##*/} pod [<pod name> | -l<kubectl selector>]
${0##*/} service [<service name> | -l<kubectl selector>]
Examples:
Wait for all pods with with a following label to enter 'Ready' state:
Wait for all pods with a following label to enter 'Ready' state:
${0##*/} pod -lapp=develop-volume-gluster-krakow
Wait for all pods with with a following label to enter 'Ready' or 'Error' state:
Wait for all pods with a following label to enter 'Ready' or 'Error' state:
${0##*/} pod-we -lapp=develop-volume-gluster-krakow
Wait for all the pods in that job to have a 'Succeeded' state:
Expand Down

0 comments on commit 3985270

Please sign in to comment.