networks 顶级元素

目录

网络（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
    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 可以与两者通信。

默认网络

当 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 # Use a custom name
    driver_opts:    # pass options to driver for network creation
      com.docker.network.bridge.host_binding_ipv4: 127.0.0.1

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

属性

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"

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

attachable

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

networks:
  mynet1:
    driver: overlay
    attachable: true

enable_ipv4

要求： Docker Compose 2.33.1 及更高版本

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 不会尝试创建这些网络，如果不存在则返回错误。
  • 除了 name 以外的所有其他属性都无关紧要。如果 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: "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.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 中的网络。

页面选项