docker-compose で PostgreSQL の起動を待ってからアプリを起動

やりたいこと

PHP, Laravel や Lumen で、 docker-compose を使って開発している時に、docker-compose up -d と同時にmigrationを行いたい。

そこで、docker-composeを以下のようにした。

version: '3'
services:
  app:
    image: lumenspeed
    container_name: lumen-app
    ports:
      - 7080:7080 # 管理ツールのポート
      - 8088:8088 # Webのポート
    environment:
      APP_ENV: local
      DB_CONNECTION: pgsql
      DB_HOST: lumen-postgresql
      DB_PORT: 5432
      DB_DATABASE: lumenspeed
      DB_USERNAME: postgres
      DB_PASSWORD: postgres
    command:
      - "/bin/sh"
      - "-c"
      - "php artisan migrate && /sbin/runit-wrapper"

  lumen-postgresql:
    image: postgres:10.5
    container_name: lumen-postgresql
    ports:
      - 5432:5432
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: lumenspeed
      POSTGRES_INITDB_ARGS: "--encoding=UTF-8"
    hostname: postgres
    restart: always
    user: postgres

要するに、起動時のコマンドに php artisan migrate を入れたのだ。

しかしこれには問題がある。docker-compose up -d した時にコンテナが立ち上がる順番は決まっていなく、たいていpostgresのほうが遅いので、php artisan migrate が実行された時にはまだpostgresが起動していないのである。

depends_on だとだめ

depends_on というのが docker-compose にはある。以下のように書くと lumen-postgres が起動してから app が起動するのだ。

しかしこれだとだめで、depends_onはコンテナが起動しているかどうかしか見ない。postgresが起動しているかどうかは見てくれないのである。

version: '3'
services:
  app:
    image: lumenspeed
    container_name: lumen-app
    depends_on:
      - lumen-postgresql

  lumen-postgresql:
    image: postgres:10.5

解決策

公式ページにも書いてあるが、postgresの起動を待つスクリプトを書くしかない。

docs.docker.com

スクリプトを用意する

postgresにつながるようになるまで待つスクリプトです。

#!/bin/sh

set -e

host="$1"
shift
cmd="$@"

until PGPASSWORD=$DB_PASSWORD psql -h $DB_HOST -U $DB_USERNAME -c '\q'; do
  >&2 echo "Postgres is unavailable - sleeping"
  sleep 1
done

>&2 echo "Postgres is up - executing command"
exec $cmd

スクリプトを起動時に叩く

これをdocker上に配置して起動前に叩くようにする。

version: '3'
services:
  app:
    image: lumenspeed
    container_name: lumen-app
    environment:
      APP_ENV: local
      DB_CONNECTION: pgsql
      DB_HOST: lumen-postgresql
      DB_PORT: 5432
      DB_DATABASE: lumenspeed
      DB_USERNAME: postgres
      DB_PASSWORD: postgres
    command:
      - "/bin/sh"
      - "-c"
      - "sh /var/lib/litespeed/Example/bin/wait-for-postgres.sh && php artisan migrate && /sbin/runit-wrapper"