使用配置文件与 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。

要解决此问题，您需要：

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

将debug配置文件添加到db服务

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

停止特定配置文件

或显式启动dev配置文件

$ docker compose --profile debug down

$ COMPOSE_PROFILES=debug docker compose down

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

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。

参考信息

配置文件