docker-compose upで「psql: not found」エラー

Question

##経緯
Control startup and shutdown order in Compose
上記のDocker公式で紹介されている、wrapper scriptによるPostgreSQL起動確認/待機のコマンドを自作のdocker-compose.ymlに移植して実行してみたところ「psql: not found」エラーが発生しました。

##質問
「web」コンテナにpsqlはインストールされていないのでこのエラーは当然だと思うのですが、公式サイトのサンプルスクリプトも「web」コンテナでpsqlコマンドを実行しているという意味では、同じような構成になっているように見えます。

この問題解決の方向性として、docker-compose.yml 内で他コンテナ（＝「db」コンテナ）にインストールされているpsqlアプリを実行できれば、このエラーは解消されるのでしょうか？以下、私のソース構成で間違っている点をご指摘いただけますと大変ありがたく存じます。

ご不明な点などは、適宜追記してまいりますので、どうぞよろしくお願い申し上げます。

###■エラー箇所（※詳細ログは、ページ下部をご参照ください）

web_1  | /project01/wait-for-postgres.sh: 14: /project01/wait-for-postgres.sh: psql: not found

　※不要コメントを削除したのでエラー行は14からズレています。「until PGPASSWORD=$POSTGRES_PASSWORD psql -h "$host" -U "postgres" -c '\q'; do」がエラー行となります。

###■使用したdocker-compose.yml

version: "3.7"
services:
  web:
    build: .
    command: ["./wait-for-postgres.sh", "db", "--", "python", "app.py"]
    volumes:
      - .:/project01

    ports:
      - 8000:8000

    depends_on:
      - db      

    environment:
      PIPENV_VENV_IN_PROJECT: "true"    
  db:
    image: postgres
    environment:
      POSTGRES_USER: ${POSTGRES_USER}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}        
      POSTGRES_DB: ${POSTGRES_DB} 
      POSTGRES_INITDB_ARGS: ${POSTGRES_INITDB_ARGS} 
      

###■使用したwait-for-postgres.sh

#!/bin/sh
# wait-for-postgres.sh
set -e

host="$1"
shift

cmd="$@"
  
until PGPASSWORD=$POSTGRES_PASSWORD psql -h "$host" -U "postgres" -c '\q'; do
  >&2 echo "Postgres is unavailable - sleeping"
  sleep 1
done
  
>&2 echo "Postgres is up - executing command"
exec $cmd

###■使用したDockerfile

FROM python:3.6
ENV PYTHONDONTWRITEBYTECODE 1 
ENV PYTHONUNBUFFERED 1
WORKDIR /project01
COPY Pipfile Pipfile.lock /project01/
RUN apt-get update && apt-get upgrade
RUN pip install pipenv
RUN pipenv install --system
COPY . /project01/

###■実行時の詳細ログ

C:\Users\test\dev\project01>docker-compose up
Creating network "project01_default" with the default driver
Creating project01_db_1 ... done
Creating project01_web_1 ... done
Attaching to project01_db_1, project01_web_1
db_1   | The files belonging to this database system will be owned by user "postgres".
db_1   | This user must also own the server process.
db_1   |
db_1   | The database cluster will be initialized with locale "en_US.utf8".
db_1   | The default text search configuration will be set to "english".
db_1   |
db_1   | Data page checksums are disabled.
db_1   |
db_1   | fixing permissions on existing directory /var/lib/postgresql/data ... ok
db_1   | creating subdirectories ... ok
db_1   | selecting dynamic shared memory implementation ... posix
db_1   | selecting default max_connections ... 100
db_1   | selecting default shared_buffers ... 128MB
db_1   | selecting default time zone ... Etc/UTC
db_1   | creating configuration files ... ok
db_1   | running bootstrap script ... ok
db_1   | performing post-bootstrap initialization ... ok
db_1   | syncing data to disk ... initdb: warning: enabling "trust" authentication for local connections
db_1   | You can change this by editing pg_hba.conf or using the option -A, or
db_1   | --auth-local and --auth-host, the next time you run initdb.
db_1   | ok
db_1   |
db_1   |
db_1   | Success. You can now start the database server using:
db_1   |
db_1   |     pg_ctl -D /var/lib/postgresql/data -l logfile start
db_1   |
db_1   | waiting for server to start....2020-09-18 04:47:47.719 UTC [47] LOG:  starting PostgreSQL 12.4 (Debian 12.4-1.pgdg100+1) on x86_64-pc-linux-gnu, compiled by gcc (Debian 8.3.0-6) 8.3.0, 64-bit
db_1   | 2020-09-18 04:47:47.797 UTC [47] LOG:  listening on Unix socket "/var/run/postgresql/.s.PGSQL.5432"
db_1   | 2020-09-18 04:47:48.476 UTC [48] LOG:  database system was shut down at 2020-09-18 04:47:43 UTC
db_1   | 2020-09-18 04:47:48.645 UTC [47] LOG:  database system is ready to accept connections
db_1   |  done
db_1   | server started
web_1  | ./wait-for-postgres.sh: 15: ./wait-for-postgres.sh: psql: not found
web_1  | Postgres is unavailable - sleeping
（ループ、中略）
web_1  | ./wait-for-postgres.sh: 15: ./wait-for-postgres.sh: psql: not found
web_1  | Postgres is unavailable - sleeping
Gracefully stopping... (press Ctrl+C again to force)
Stopping project01_web_1 ... done
Stopping project01_db_1  ... done

###環境
Windows 10
Docker Engine 19.03.12

Answer 1

おそらく公式ドキュメントでは、web サービスのイメージに
PostgreSQL クライアントをインストールすることを想定しているものと思われます:

services:
  web:
    build: .

(もしかしたら postgres のイメージと volume を共有して psql クライアントを使えば解決できるかもしれませんが、僕はやったことがありません)

PostgreSQL クライアントをインストールしたくない場合は
その上の wait-for-it.sh を利用して port のサービス開始を検知する方法で
実装すると良いでしょう:

    depends_on:
      - "db"
    command: ["./wait-for-it.sh", "db:5432", "--", "python", "app.py"]

これは Shell Script を落としてくるだけでできます:

RUN wget -O /usr/bin/wait-for-it https://raw.githubusercontent.com/vishnubob/wait-for-it/master/wait-for-it.sh \
 && chmod +x /usr/bin/wait-for-it

wget でなく curl や git でも構いません
Docker イメージのレイヤーが増えますが、ADD を使うと上記のコマンドなしでも設定できます:

ADD https://raw.githubusercontent.com/vishnubob/wait-for-it/master/wait-for-it.sh /usr/bin/wait-for-it
RUN chmod +x /usr/bin/wait-for-it

Comments

[fukazume]

多角的に解決方法を教えていただきありがとうございます！Docker公式の例は、やはりpsqlクライアントが入っている前提なんですね！おかげさまでスッキリ理解できました。ご提示いただきましたwait-for-it, wait-for-postgres の両方の方法でpsql起動まで待機してくれることを確認できました！volume共有についてはまだ理解の途中ですが、大変参考になりました！深く御礼申し上げます！m(__)m