diff --git a/README.md b/README.md index 2ebb591..0b80986 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 [ | -l] wait_for.sh pod [ | -l] wait_for.sh service [ | -l] 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: @@ -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 @@ -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 `, 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:/` diff --git a/wait_for.sh b/wait_for.sh index e884ce3..4f3e17d 100755 --- a/wait_for.sh +++ b/wait_for.sh @@ -21,10 +21,10 @@ ${0##*/} pod [ | -l] ${0##*/} service [ | -l] 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: