网络顶级元素

网络允许服务之间相互通信。默认情况下,Compose 为您的应用程序设置一个单一网络。服务的每个容器都会加入默认网络,并且该网络上的其他容器可以访问它,也可以通过服务名称发现它。顶层 networks 元素允许您配置可在多个服务中重复使用的命名网络。

要在多个服务间使用网络,您必须在 services 顶级元素中使用 网络 属性显式授予每个服务访问权限。networks 顶级元素具有额外的语法,可提供更精细的控制。

示例

基础示例

在下面的示例中,在运行时,创建了网络 front-tierback-tier,并且 frontend 服务连接到 front-tierback-tier 网络。

services:
  frontend:
    image: example/webapp
    networks:
      - front-tier
      - back-tier

networks:
  front-tier:
  back-tier:

高级示例

services:
  proxy:
    build: ./proxy
    networks:
      - frontend
  app:
    build: ./app
    networks:
      - frontend
      - backend
  db:
    image: postgres
    networks:
      - backend

networks:
  frontend:
    # Specify driver options
    driver: bridge
    driver_opts:
      com.docker.network.bridge.host_binding_ipv4: "127.0.0.1"
  backend:
    # Use a custom driver
    driver: custom-driver

高级示例展示了一个定义了两个自定义网络的 Compose 文件。proxy 服务与 db 服务隔离,因为它们没有共同的网络。只有 app 可以与两者通信。

属性

驱动程序

driver 指定此网络应使用的驱动程序。如果该驱动程序在平台上不可用,Compose 将返回错误。

networks:
  db-data:
    driver: bridge

有关驱动程序和可用选项的更多信息,请参阅 网络驱动程序

driver_opts

driver_opts 指定作为键值对列表传递给驱动程序的选项列表。这些选项依赖于驱动程序。

networks:
  frontend:
    driver: bridge
    driver_opts:
      com.docker.network.bridge.host_binding_ipv4: "127.0.0.1"

有关更多信息,请参阅 网络驱动程序文档

可附加

如果将 attachable 设置为 true,那么除了服务之外,独立容器也应该能够连接到此网络。如果独立容器连接到该网络,它就可以与同样连接到该网络的服务以及其他独立容器进行通信。

networks:
  mynet1:
    driver: overlay
    attachable: true

enable_ipv6

enable_ipv6 启用 IPv6 网络。有关示例,请参阅 创建 IPv6 网络

external

如果设置为 true

  • external 指定此网络的生命周期在应用程序的生命周期之外进行管理。 Compose 不会尝试创建这些网络,如果网络不存在,则会返回错误。
  • 除名称外的所有其他属性均无关。如果 Compose 检测到任何其他属性,它会将该 Compose 文件视为无效并拒绝。

在下面的示例中,proxy 是通往外部世界的网关。Compose 不会尝试创建网络,而是向平台查询一个名为 outside 的现有网络,并将 proxy 服务的容器连接到该网络。

services:
  proxy:
    image: example/proxy
    networks:
      - outside
      - default
  app:
    image: example/app
    networks:
      - default

networks:
  outside:
    external: true

IP地址管理

ipam 指定了自定义 IPAM 配置。这是一个包含多个属性的对象,每个属性都是可选的:

  • driver: 自定义 IPAM 驱动程序,代替默认驱动。
  • config: 包含零个或多个配置元素的列表,每个元素包含一个:
    • subnet: CIDR 格式的子网,表示一个网段
    • ip_range: 用于分配容器 IP 的 IP 范围
    • gateway: 主子网的 IPv4 或 IPv6 网关
    • aux_addresses: 网络驱动使用的辅助 IPv4 或 IPv6 地址,作为主机名到 IP 的映射
networks:
  mynet1:
    ipam:
      driver: default
      config:
        - subnet: 172.28.0.0/16
          ip_range: 172.28.5.0/24
          gateway: 172.28.5.254
          aux_addresses:
            host1: 172.28.1.5
            host2: 172.28.1.6
            host3: 172.28.1.7
      options:
        foo: bar
        baz: "0"

内部

默认情况下,Compose 为网络提供外部连接。internal 设置为 true 时,允许你创建一个外部隔离的网络。

标签

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

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

networks:
  mynet1:
    labels:
      com.example.description: "Financial transaction network"
      com.example.department: "Finance"
      com.example.label-with-empty-value: ""
networks:
  mynet1:
    labels:
      - "com.example.description=Financial transaction network"
      - "com.example.department=Finance"
      - "com.example.label-with-empty-value"

Compose 设置 com.docker.compose.projectcom.docker.compose.network 标签。

名称

name 设置网络的自定义名称。名称字段可用于引用包含特殊字符的网络。 该名称按原样使用,不会以项目名称作为作用域。

networks:
  network1:
    name: my-app-net

它也可以与 external 属性结合使用,以定义 Compose 应检索的平台网络,通常通过使用参数来实现,这样 Compose 文件就不需要硬编码运行时的特定值:

networks:
  network1:
    external: true
    name: "${NETWORK_ID}"

其他资源

更多示例,请参阅 Compose 中的网络