将生命周期钩子与 Compose 一起使用

要求: Docker Compose 2.30.0 及更高版本

服务生命周期钩子

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

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

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

启动后钩子

启动后钩子是在容器启动后运行的命令,但没有确切的执行时间。在容器的 entrypoint 执行期间,钩子的执行时机并不确定。

在提供的示例中

  • 该钩子用于将卷的所有权更改为非 root 用户(因为卷默认是以 root 身份创建的)。
  • 容器启动后,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

停止前钩子

停止前钩子是在容器通过特定命令(例如 docker compose down 或手动按 Ctrl+C 停止)停止之前运行的命令。如果容器自行停止或突然被杀死,这些钩子将不会运行。

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

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

参考信息

页面选项