» docker_network

Manages a Docker Network. This can be used alongside docker_container to create virtual networks within the docker environment.

» Example Usage

# Create a new docker network
resource "docker_network" "private_network" {
  name = "my_network"

# Access it somewhere else with ${docker_network.private_network.name}

» Argument Reference

The following arguments are supported:

  • name - (Required, string) The name of the Docker network.
  • labels - (Optional, block) See Labels below for details.
  • check_duplicate - (Optional, boolean) Requests daemon to check for networks with same name.
  • driver - (Optional, string) Name of the network driver to use. Defaults to bridge driver.
  • options - (Optional, map of strings) Network specific options to be used by the drivers.
  • internal - (Optional, boolean) Restrict external access to the network. Defaults to false.
  • attachable - (Optional, boolean) Enable manual container attachment to the network. Defaults to false.
  • ingress - (Optional, boolean) Create swarm routing-mesh network. Defaults to false.
  • ipv6 - (Optional, boolean) Enable IPv6 networking. Defaults to false.
  • ipam_driver - (Optional, string) Driver used by the custom IP scheme of the network.
  • ipam_config - (Optional, block) See IPAM config below for details.

» Labels

labels is a block within the configuration that can be repeated to specify additional label name and value data to the container. Each labels block supports the following:

  • label - (Required, string) Name of the label
  • value (Required, string) Value of the label

See 214 for Details.

» IPAM config

Configuration of the custom IP scheme of the network.

The ipam_config block supports:

» Attributes Reference

The following attributes are exported in addition to the above configuration:

» Import

Docker networks can be imported using the long id, e.g. for a network with the short id p73jelnrme5f:

$ terraform import docker_network.foo $(docker network inspect -f {{.ID}} p73)