healthy

command module
Version: v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2022 License: MIT Imports: 10 Imported by: 0

README

Maintainability Docker image size Build Status Release Go Report Card CLA assistant GoDoc

healthy

-- Command healthy waits for Docker container(s) to become healthy.

The command takes one or more container ID's as argument(s) and will not exit until all of them are reported "healthy" as it Health check status.

A container with no health check defined is always considered healthy.

When all specified containers are reported healthy the command will exit with return code 0.

usage: healthy [flags] [container_id_or_name ...]

flags:
  -fail-on-unhealthy
	fail on unhealthy
  -timeout duration
	timeout after waiting (default 1h0m0s)

In a docker-compose setup you could wait for all services to be healthy by running:

healthy $(docker-compose ps -q)

Or just could wait for the database service to be healthy by running:

healthy $(docker-compose ps -q database)

To wait no longer than one and half minute for containers to be healthy:

healthy -timeout 1m30s $(docker-compose ps -q)

You can also run healthy using a Docker image:

docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro arnested/healthy $(docker-compose ps -q)

Documentation

Overview

Command healthy waits for Docker container(s) to become healthy.

The command takes one or more container ID's as argument(s) and will not exit until all of them are reported "healthy" as it Health check status.

A container with no health check defined is always considered healthy.

When all specified containers are reported healthy the command will exit with return code 0.

usage: healthy [flags] [container_id_or_name ...]

flags:
  -fail-on-unhealthy
	fail on unhealthy
  -timeout duration
	timeout after waiting (default 1h0m0s)

In a docker-compose setup you could wait for all services to be healthy by running:

healthy $(docker-compose ps -q)

Or just could wait for the database service to be healthy by running:

healthy $(docker-compose ps -q database)

To wait no longer than one and half minute for containers to be healthy:

healthy -timeout 1m30s $(docker-compose ps -q)

You can also run healthy using a Docker image:

docker run --rm -v /var/run/docker.sock:/var/run/docker.sock:ro arnested/healthy $(docker-compose ps -q)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL