Sustie

Docker Compose确保Postgres启动的方法

最近我编写了一个 Django + Postgres 的网站，其 docker-compose.yml 大概是下面这样的：

services:
  db:
    image: postgres

  web:
    image: django
    depends_on:
      - db

根据 Docker 文档，指定depends_on属性可以确保 Django 容器在 Postgres 容器启动之后才启动。但是这么设置之后，会发现启动的时候 Django 还是有可能连接不上 Postgres 导致异常。其原因在于：Postgres 容器启动（也就是 Postgres 进程启动）不代表 Postgres 进程已经准备好接受连接了。这之间还需要一段时间用来初始化。因此上面的 docker-compose.yml 是不可靠的。

正确的写法应该是下面这样的：

services:
  db:
    image: postgres
    healthcheck:
      test: pg_isready || exit 1
      interval: 5s
      timeout: 10s
      retries: 120

  web:
    image: django
    depends_on:
      db:
        condition: service_healthy

首先看db的healthcheck属性。这个属性用来启用 Docker 的 healthcheck 机制。Docker 会定期在容器内运行test所指定的命令，根据命令的返回值来判断容器的健康状态。pg_isready是 Postgres 官方提供的命令，用于检测 Postgres 是否已经完全启动。

这里有一个乍看之下比较奇怪的地方，就是在命令后面还加上了|| exit 1。这是因为，根据Docker 官方文档，如果test所指定的命令的结束代码为 0，则表示容器健康；若为 1，则表示容器异常；结束代码 2 则作为保留值，不应该使用它（吐槽一下：那么除了 0、1、2 以外的结束代码呢？）。在 Shell 脚本中，a || b表示仅当a的结束代码为 0 时才执行b。因此当pg_isready返回 0 的时候，pg_isready || exit 1的结束代码是 0；若pg_isready返回非 0 的值，则pg_isready || exit 1会一律返回 1。这样就符合了 Docker 的约定。

然后在web的depends_on属性里加入condition: service_healthy，就可以让web容器在db容器处于 healthy 状态后才启动。