docker-compose-wait 0.2.4

Some useful command line utility to wait until all services declared in a docker-compose file are up and running.

docker-compose-wait

Some useful script to wait until all services declared in a docker-compose file are up and running.

This script uses the health check mechanism provided since Docker 1.12. If your services have a configured health check, after making a docker-compose up -d you can simply call this script to have it wait until all your services health statuses are fixed. If they are all healthy it will return 0 if any of them is unhealthy (or Down) it will return -1.

This script can be useful, as example, in Continuous Integration or other situations when you just want to wait until a stack is deployed before performing other actions.

Please note this script does not do anything about dependencies startup order. See the official documentation for that problem.

Installation

pip install docker-compose-wait

This utility requires Python >= 3.3.

Usage

It can be as simple as:

docker-compose-wait

docker-compose-wait behaves like a docker-compose command. It will just forward any option to docker-compose. The above command will work fine if you previously ran docker-compose up -d by referencing the standard docker-compose.yml file. If you are using other files for your docker-compose configuration just use:

docker-compose-wait -f <path_to_yaml_file>

License

See the license file.

Contribution

See the contribution guide.