在Compose中使用配置文件

目录

配置文件帮助您通过选择性激活服务来调整您的Compose应用程序以适应不同的环境或使用场景。服务可以被分配到一个或多个配置文件；未分配的服务默认启动，而分配的服务只有在它们的配置文件激活时才会启动。这种设置意味着特定的服务，如用于调试或开发的服务，可以包含在单个compose.yml文件中，并且仅在需要时激活。

将配置文件分配给服务

服务通过profiles 属性与配置文件关联，该属性接受一个配置文件名称的数组：

services:
  frontend:
    image: frontend
    profiles: [frontend]

  phpmyadmin:
    image: phpmyadmin
    depends_on: [db]
    profiles: [debug]

  backend:
    image: backend

  db:
    image: mysql

在这里，服务 frontend 和 phpmyadmin 分别被分配到配置文件 frontend 和 debug，因此只有在启用各自的配置文件时才会启动。

没有profiles属性的服务总是启用的。在这种情况下，运行docker compose up只会启动backend和db。

有效的配置文件名称遵循正则表达式格式 [a-zA-Z0-9][a-zA-Z0-9_.-]+。

提示

应用程序的核心服务不应分配profiles，因此它们始终启用并自动启动。

启动特定配置文件

要启动特定的配置文件，请提供--profile 命令行选项或使用 COMPOSE_PROFILES环境变量：

$ docker compose --profile debug up

$ COMPOSE_PROFILES=debug docker compose up

两个命令都启用了debug配置文件来启动服务。 在之前的compose.yml文件中，这会启动服务 db, backend 和 phpmyadmin。

启动多个配置文件

你也可以启用多个配置文件，例如使用docker compose --profile frontend --profile debug up命令，将会启用frontend和debug这两个配置文件。

可以通过传递多个--profile标志或为COMPOSE_PROFILES环境变量指定逗号分隔的列表来指定多个配置文件：

$ docker compose --profile frontend --profile debug up

$ COMPOSE_PROFILES=frontend,debug docker compose up

如果你想同时启用所有配置文件，可以运行docker compose --profile "*"。

自动启动配置文件和依赖解析

当在命令行中明确指定了一个分配了profiles的服务时，其配置文件会自动启动，因此您无需手动启动它们。这可以用于一次性服务和调试工具。例如，考虑以下配置：

services:
  backend:
    image: backend

  db:
    image: mysql

  db-migrations:
    image: backend
    command: myapp migrate
    depends_on:
      - db
    profiles:
      - tools
# Only start backend and db
$ docker compose up -d

# This runs db-migrations (and,if necessary, start db)
# by implicitly enabling the profiles `tools`
$ docker compose run db-migrations

但请记住，docker compose 只会自动启动命令行上服务的配置文件，而不会启动任何依赖项的配置文件。

这意味着目标服务depends_on所依赖的任何其他服务应该：

  • 共享一个共同的配置文件
  • 始终启动，通过省略profiles或显式启动匹配的配置文件
services:
  web:
    image: web

  mock-backend:
    image: backend
    profiles: ["dev"]
    depends_on:
      - db

  db:
    image: mysql
    profiles: ["dev"]

  phpmyadmin:
    image: phpmyadmin
    profiles: ["debug"]
    depends_on:
      - db
# Only start "web"
$ docker compose up -d

# Start mock-backend (and, if necessary, db)
# by implicitly enabling profiles `dev`
$ docker compose up -d mock-backend

# This fails because profiles "dev" is not enabled
$ docker compose up phpmyadmin

尽管针对phpmyadmin自动启动配置文件debug，但它不会自动启动db所需的配置文件，即dev。

要解决这个问题，您需要将debug配置文件添加到db服务中：

db:
  image: mysql
  profiles: ["debug", "dev"]

或者显式启动dev配置文件：

# Profiles "debug" is started automatically by targeting phpmyadmin
$ docker compose --profile dev up phpmyadmin
$ COMPOSE_PROFILES=dev docker compose up phpmyadmin

停止特定配置文件

与启动特定配置文件一样，您可以使用--profile 命令行选项或 使用 COMPOSE_PROFILES环境变量：

$ docker compose --profile debug down

$ COMPOSE_PROFILES=debug docker compose down

这两个命令都会停止并移除使用debug配置文件的服务。在下面的compose.yml文件中，这将停止db和phpmyadmin服务。

services:
  frontend:
    image: frontend
    profiles: [frontend]

  phpmyadmin:
    image: phpmyadmin
    depends_on: [db]
    profiles: [debug]

  backend:
    image: backend

  db:
    image: mysql

注意

运行 docker compose down 只会停止 backend 和 db。

参考信息

profiles