卷顶级元素

卷是由容器引擎实现的持久化数据存储。Compose 为服务挂载卷提供了一种通用的方式，并提供了配置参数将其分配给基础设施。顶级 volumes 声明允许您配置可在多个服务中复用的命名卷。

要在多个服务间使用卷，必须在 services 顶级元素中使用卷属性显式授予每个服务访问权限。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 部分下的条目可以为空，在这种情况下，它使用容器引擎的默认配置来创建卷。或者，您可以使用以下键对其进行配置：

驱动程序

指定应使用哪个卷驱动程序。如果该驱动程序不可用，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

名称

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

卷顶级元素

示例

属性

驱动程序

driver_opts

external

标签

名称