卷顶级元素

要在多个服务之间使用卷，您必须使用 services 顶级元素内的 volumes 属性显式地授予每个服务访问权限。volumes 属性具有其他语法，可提供更细粒度的控制。

提示

处理大型存储库或单体存储库，或者使用不再随代码库一起扩展的虚拟文件系统？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 标签。

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