Docker-Compose: как дождаться готовности другого сервиса?

документация предполагает, что в файлах Docker Compose версии 2, в частности, depends_on: может быть списком строк или отображением, где ключи являются именами служб, а значения - условиями. Для служб, для которых у вас нет (или необходимости) проверки работоспособности, существует условие service_started.

depends_on:
  # notice: these lines don't start with "-"
  jhipster-registry:
    condition: service_healthy
  myprogram-postgresql:
    condition: service_started
  myprogram-elasticsearch:
    condition: service_started

В зависимости от того, насколько вы контролируете свою программу и ее библиотеки, еще лучше, если вы можете организовать запуск службы без обязательной доступности ее зависимостей (эквивалентно, чтобы она работала, если ее зависимости умирают во время работы службы) , а не использовать опцию depends_on:. Вы можете вернуть ошибку HTTP 503 Service Unavailable, например, если база данных не работает. Другая часто полезная стратегия - немедленно выйти, если ваши зависимости недоступны, но использовать установка, например restart: on-error, чтобы попросить оркестратор перезапустить службу.

Хотя вы уже получили ответ, следует отметить, что то, чего вы пытаетесь достичь, сопряжено с некоторыми неприятными рисками.

В идеале сервис должен быть самодостаточным и достаточно умным, чтобы повторить попытку и дождаться появления зависимостей (до того, как произойдет сбой). В противном случае вы будете больше подвержены риску распространения одного сбоя на другие службы. Также учтите, что перезагрузка системы, в отличие от ручного запуска, может игнорировать порядок зависимостей.

Если сбой одной службы приводит к отказу всей вашей системы, у вас может быть инструмент, чтобы перезапустить все снова, но было бы лучше иметь службы, которые сопротивляются этому случаю.

Обновитесь до версии 3+.

Следуйте документы версии 3:

There are several things to be aware of when using depends_on:

depends_on does not wait for db and redis to be “ready” before starting web - only until they have been started.
If you need to wait for a service to be ready, see Controlling startup order for more on this problem and strategies for solving it.
Version 3 no longer supports the condition form of depends_on.
The depends_on option is ignored when deploying a stack in swarm mode with a version 3 Compose file.

Я бы подумал об использовании параметра restart_policy для настройки вашего myprogram-приложение для перезапуска, пока jhipster-реестр не будет включен и принимать соединения:

 restart_policy:
        condition: on-failure
        delay: 3s
        max_attempts: 5
        window: 60s

Лучший подход - запуск отказоустойчивого приложения

Хотя docker делает поддерживает зависимости запуска, они официально рекомендуют обновить логику запуска вашего приложения, чтобы проверить наличие внешних зависимостей и повторить попытку. Это имеет множество преимуществ для надежных приложений, которые могут перезапускаться в дикой природе на лету, в дополнение к обходу состояния гонки в docker compose up.

Докерский подход - wait-for-it.sh

Рекомендуемый подход от докеров в соответствии с их документами на Управление порядком запуска и завершения работы в Compose - загрузить wait-for-it.sh, который принимает domain:port для опроса, а затем выполняет следующий набор команд в случае успеха.

version: "2"
services:
  web:
    build: .
    ports:
      - "80:8000"
    depends_on:
      - "db"
    command: ["./wait-for-it.sh", "db:5432", "--", "python", "app.py"]
  db:
    image: postgres

Примечание: это требует переопределения команды запуска образа, поэтому убедитесь, что вы знаете, что нужно передать, чтобы сохранить четность запуска по умолчанию.

Исторический подход - depends_on - service_healthy (устарело 3+)

Исторически вы могли определить healthcheck (все еще хорошая практика), а затем установить условие для depends_on на service_healthy, однако это условное отклонение зависит от устаревшего в версии 3.0.

version: '3.0'
services:
  php:
    build:
      context: .
      dockerfile: tests/Docker/Dockerfile-PHP
    depends_on:
      redis:
        condition: service_healthy
  redis:
    image: redis
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 1s
      timeout: 3s
      retries: 30

Дальнейшее чтение

• Docker Compose ждет контейнера X перед запуском Y
• Разница между ссылками и зависимым_on в docker_compose.yml
• Как я могу дождаться запуска контейнера докеров?
• Docker Compose Подождите, пока контейнер зависимостей полностью не загрузится, прежде чем запускать
• зависимости_on не ждет другой службы в docker-compose 1.22.0

Лучший подход, который я нашел, - это проверить желаемый порт в точке входа. Это можно сделать разными способами, например: wait-for-it, но мне нравится использовать это решение, которое является кроссплатформенным между изображениями apline и bash и не загружает пользовательские скрипты с GitHub:

Установите netcat-openbsd (работает с apt и apk). Затем в точке входа (работает как с #!/bin/bash, так и с #!/bin/sh):

#!/bin/bash

wait_for()
{
  echo "Waiting $1 seconds for $2:$3"
  timeout $1 sh -c 'until nc -z $0 $1; do sleep 0.1; done' $2 $3 || return 1
  echo "$2:$3 available"
}


wait_for 10 db 5432
wait_for 10 redis 6379

Вы также можете превратить это в однострочник, если не хотите ничего печатать.