在 Compose 中使用生命周期钩子

在 Docker Compose 版本中引入 2.30.0

服务生命周期钩子

当 Docker Compose 运行容器时,它使用两个元素, ENTRYPOINT 和 COMMAND, 来管理容器启动和停止时发生的行为。

然而,有时使用生命周期钩子(即在容器启动后立即运行或在停止前刚好运行的命令)分别处理这些任务会更加容易。

生命周期钩子特别有用,因为它们可以拥有特殊权限(例如以 root 用户身份运行),即使容器本身出于安全考虑以较低权限运行。这意味着某些需要更高权限的任务可以在不损害容器整体安全性的前提下完成。

启动后钩子

启动后钩子是容器启动后运行的命令,但没有设定它们确切执行的时间。在容器执行 entrypoint 期间,钩子的执行时机无法保证。

在提供的示例中:

  • 该钩子用于将卷的所有权更改为非根用户(因为默认情况下卷是以根用户所有权创建的)。
  • 容器启动后,chown 命令会将 /data 目录的所有权更改为用户 1001
services:
  app:
    image: backend
    user: 1001
    volumes:
      - data:/data    
    post_start:
      - command: chown -R /data 1001:1001
        user: root

volumes:
  data: {} # a Docker volume is created with root ownership

预停止钩子

Pre-stop 钩子是在容器被特定命令停止之前运行的命令(例如 docker compose down 或使用 Ctrl+C 手动停止)。 如果容器自行停止或突然被终止,这些钩子将不会运行。

在以下示例中,容器停止之前,会运行 ./data_flush.sh 脚本来执行任何必要的清理工作。

services:
  app:
    image: backend
    pre_stop:
      - command: ./data_flush.sh

参考信息