在 Docker Compose 中定义和管理网络

Table of contents

网络（Networks）让服务之间能够相互通信。默认情况下，Compose 会为您的应用设置一个单一网络。每个服务的容器都会加入默认网络，既可以通过该网络被其他容器访问，也可以通过服务名称被发现。顶层的 networks 元素允许您配置可在多个服务中重复使用的命名网络。

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

示例

基本示例

在以下示例中，在运行时，会创建网络 front-tier 和 back-tier，并且 frontend 服务会连接到 front-tier 和 back-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:18
    networks:
      - backend

networks:
  frontend:
    # 指定驱动选项
    driver: bridge
    driver_opts:
      com.docker.network.bridge.host_binding_ipv4: "127.0.0.1"
  backend:
    # 使用自定义驱动
    driver: custom-driver

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

默认网络

当 Compose 文件未声明显式网络时，Compose 会使用一个隐式的 default 网络。没有显式 networks 声明的服务会被 Compose 连接到此 default 网络：

services:
  some-service:
    image: foo

此示例实际上等同于：

services:
  some-service:
    image: foo
    networks:
      default: {}  
networks:
  default: {}

您可以通过显式声明来自定义 default 网络：

networks:
  default: 
    name: a_network # 使用自定义名称
    driver_opts:    # 将选项传递给驱动程序以创建网络
      com.docker.network.bridge.host_binding_ipv4: 127.0.0.1

有关选项，请参阅 Docker Engine 文档。

属性

`attachable`

如果 attachable 设置为 true，则独立容器除了服务之外，还应该能够连接到此网络。如果独立容器连接到该网络，它可以与同样连接到该网络的服务和其他独立容器进行通信。

networks:
  mynet1:
    driver: overlay
    attachable: true

`driver`

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"

请查阅网络驱动程序文档以获取更多信息。

`enable_ipv4`

Requires: Docker Compose 2.33.1 and later

enable_ipv4 可用于禁用 IPv4 地址分配。

  networks:
    ip6net:
      enable_ipv4: false
      enable_ipv6: true

`enable_ipv6`

enable_ipv6 启用 IPv6 地址分配。

  networks:
    ip6net:
      enable_ipv6: true

`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

`ipam`

ipam 指定自定义 IPAM 配置。这是一个具有多个属性的对象，每个属性都是可选的：

driver: 自定义 IPAM 驱动程序，而不是默认驱动程序。
config: 一个包含零个或多个配置元素的列表，每个元素包含：
- subnet: 以 CIDR 格式表示的网络段的子网
- ip_range: 用于分配容器 IP 的 IP 范围
- gateway: 主子网的 IPv4 或 IPv6 网关
- aux_addresses: 网络驱动程序使用的辅助 IPv4 或 IPv6 地址，作为从主机名到 IP 的映射
options: 驱动程序特定的选项，作为键值映射。

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"

`internal`

默认情况下，Compose 为网络提供外部连接性。当 internal 设置为 true 时，可让您创建外部隔离的网络。

`labels`

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

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

networks:
  mynet1:
    labels:
      com.example.description: "金融交易网络"
      com.example.department: "财务部"
      com.example.label-with-empty-value: ""

networks:
  mynet1:
    labels:
      - "com.example.description=金融交易网络"
      - "com.example.department=财务部"
      - "com.example.label-with-empty-value"

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

`name`

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

networks:
  network1:
    name: my-app-net

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

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

其他资源

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