Home
Softono
docker-wait

docker-wait

Open source Shell
27
Stars
7
Forks
0
Issues
2
Watchers
2 months
Last Commit

About docker-wait

docker-wait is a lightweight 4MB Docker utility designed to block execution until one or more specified containers or services begin accepting TCP connections. It helps orchestrate dependent containers by ensuring prerequisite services are fully reachable before dependent services start. By default, it inspects all linked containers and waits for their EXPOSED ports to become available. Users can customize behavior with command-line flags: the -p flag limits the check to a subset of a linked container's ports, the -c flag allows waiting on arbitrary host and port combinations not declared as Docker links, and the -t flag sets a custom timeout per connection attempt, overriding the default 30 seconds. If a connection fails to establish within the timeout, the utility exits immediately with status code 1, signaling failure to the surrounding orchestration system. It supports usage in both interactive development and automated deployment pipelines, functioning as a simple readiness gate for service dependencies.

Platforms

Web Self-hosted Docker

Languages

Shell

Links

docker-wait

dokku/wait

wait is a really small (4MB) Docker utility that blocks until another container is accepting TCP connections, and errors-out if it cannot connect within a given timeout. It can be used to ensure that a service is up and running before starting another service that depends on it.

The default operation looks up all the EXPOSEd ports of all the linked containers and waits for them

$ docker run -d --name mycontainer some-image-or-other
$ docker run --link mycontainer:mycontainer --rm dokku/wait
Waiting for 172.17.0.105:5432  .  up!
Everything is up

It doesn't matter what the link alias is.

If you want to wait for only a subset of the ports in a linked container, you can provide the list with the -p parameter:

$ docker run -d --name mycontainer some-image-or-other
$ docker run --link mycontainer:mycontainer --rm dokku/wait -p 5432
Not checking 172.17.0.105:6379 because port is not included.
Waiting for 172.17.0.105:5432  .  up!
Everything is up

If you want to connect to hosts/ports that haven't been linked by Docker, you can provide the list with the -c parameter:

$ docker run --rm dokku/wait -c 8.8.8.8:53,github.com:443
Waiting for 8.8.8.8:53  .  up!
Waiting for github.com:443  .  up!
Everything is up

By default each connection attempt will bail after 30 seconds. You can override this with -t parameter:

$ docker run dokku/wait -c github.com:5432 -t 15
Waiting for github.com:5432  ...............................  ERROR: unable to connect

If any connection times out, the wait container immediately exits with status code 1

credits

waisbrot/wait n3llyb0y/wait aanand/wait