在 Docker Compose 中定义和管理卷

Table of contents

卷（Volume）是由容器引擎实现的持久化数据存储。Compose 为服务挂载卷提供了一种中立的方式，并提供配置参数以将它们分配给基础设施。顶层的 volumes 声明允许您配置命名卷，这些卷可以在多个服务之间重复使用。

要在多个服务之间使用卷，必须通过在 services 顶层元素中使用 volumes 属性来显式授予每个服务访问权限。volumes 属性具有额外的语法，可提供更精细的控制。

Tip

正在处理大型代码库或单体代码库，或者使用不再随代码库扩展的虚拟文件系统？ Compose 现在利用同步文件共享并自动为绑定挂载创建文件共享。确保您已使用付费订阅登录 Docker，并在 Docker Desktop 设置中启用了访问实验性功能和使用 Compose 管理同步文件共享。

示例

以下示例展示了一个双服务设置，其中数据库的数据目录作为名为 db-data 的卷与另一个服务共享，以便可以定期进行备份。

services:
  backend:
    image: example/database
    volumes:
      - db-data:/etc/data

  backup:
    image: backup-service
    volumes:
      - db-data:/var/lib/backup/data

volumes:
  db-data:

db-data 卷分别挂载到备份和后端的容器路径 /var/lib/backup/data 和 /etc/data。

运行 docker compose up 会创建该卷（如果它尚不存在）。否则，将使用现有卷，如果该卷在 Compose 之外被手动删除，则会重新创建。

属性

顶层 volumes 部分下的条目可以为空，在这种情况下，它使用容器引擎的默认配置来创建卷。或者，您可以使用以下键对其进行配置：

`driver`

指定应使用的卷驱动程序。如果驱动程序不可用，Compose 会返回错误并且不部署应用程序。

volumes:
  db-data:
    driver: foobar

`driver_opts`

driver_opts 指定一个选项列表（键值对），以传递给此卷的驱动程序。这些选项取决于驱动程序。

volumes:
  example:
    driver_opts:
      type: "nfs"
      o: "addr=10.40.0.199,nolock,soft,rw"
      device: ":/docker/example"

`external`

如果设置为 true：

external 指定此卷已存在于平台上，并且其生命周期在应用程序之外进行管理。然后 Compose 不会创建卷，如果卷不存在，则返回错误。
除 name 之外的所有其他属性都无关紧要。如果 Compose 检测到任何其他属性，则会拒绝该 Compose 文件，视其为无效。

在以下示例中，Compose 不会尝试创建名为 {project_name}_db-data 的卷，而是查找一个名为 db-data 的现有卷，并将其挂载到 backend 服务的容器中。

services:
  backend:
    image: example/database
    volumes:
      - db-data:/etc/data

volumes:
  db-data:
    external: true

`labels`

labels 用于向卷添加元数据。您可以使用数组或字典。

建议使用反向 DNS 表示法，以防止您的标签与其他软件使用的标签冲突。

volumes:
  db-data:
    labels:
      com.example.description: "Database volume"
      com.example.department: "IT/Ops"
      com.example.label-with-empty-value: ""

volumes:
  db-data:
    labels:
      - "com.example.description=Database volume"
      - "com.example.department=IT/Ops"
      - "com.example.label-with-empty-value"

Compose 会设置 com.docker.compose.project 和 com.docker.compose.volume 标签。

Note

此处定义的标签仅适用于命名卷。它们存储在卷资源上，并通过 docker volume inspect 可见。它们不适用于绑定挂载，也不会更改挂载语义。

`name`

name 为卷设置自定义名称。name 字段可用于引用包含特殊字符的卷。名称按原样使用，不包含在堆栈名称的作用域内。

volumes:
  db-data:
    name: "my-app-data"

这使得可以将此查找名称作为 Compose 文件的参数，这样卷的模型 ID 是硬编码的，但平台上实际的卷 ID 在部署期间在运行时设置。

例如，如果您的 .env 文件中有 DATABASE_VOLUME=my_volume_001：

volumes:
  db-data:
    name: ${DATABASE_VOLUME}

运行 docker compose up 会使用名为 my_volume_001 的卷。

它也可以与 external 属性结合使用。这意味着用于在平台上查找实际卷的名称与在 Compose 文件中引用卷的名称是分开设置的：

volumes:
  db-data:
    external: true
    name: actual-name-of-volume