mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2026-01-06 14:59:37 -05:00
30f2238e0b
* build: adds local check for website links * build(make): adds website lint and setup target * docs: fix spellings and hcl blocks * fix(make): phony cmd for missing targets * chore: renames website link check workflow * fix: missing workflow path * build(make): adds golangci-lint target and tool * ci: adds website lint workflow * docs(contributing): adds linter runs * chore: improves naming of workflow jobs * ci: moves website lint job * chore: switches markdown checker imagee to ghcr.io/tcort/markdown-link-check:stable
88 lines
2.6 KiB
Markdown
88 lines
2.6 KiB
Markdown
---
|
|
layout: "docker"
|
|
page_title: "Docker: docker_network"
|
|
sidebar_current: "docs-docker-resource-network"
|
|
description: |-
|
|
Manages a Docker Network.
|
|
---
|
|
|
|
# docker\_network
|
|
|
|
Manages a Docker Network. This can be used alongside
|
|
[docker\_container](/docs/providers/docker/r/container.html)
|
|
to create virtual networks within the docker environment.
|
|
|
|
## Example Usage
|
|
|
|
```hcl
|
|
# 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](#labels-1) 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](#ipam_config-1) below for
|
|
details.
|
|
|
|
<a id="labels-1"></a>
|
|
#### 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](https://github.com/terraform-providers/terraform-provider-docker/issues/214#issuecomment-550128950) for Details.
|
|
|
|
<a id="ipam_config-1"></a>
|
|
### IPAM config
|
|
Configuration of the custom IP scheme of the network.
|
|
|
|
The `ipam_config` block supports:
|
|
|
|
* `subnet` - (Optional, string)
|
|
* `ip_range` - (Optional, string)
|
|
* `gateway` - (Optional, string)
|
|
* `aux_address` - (Optional, map of string)
|
|
|
|
## Attributes Reference
|
|
|
|
The following attributes are exported in addition to the above configuration:
|
|
|
|
* `id` (string)
|
|
* `scope` (string)
|
|
|
|
## Import
|
|
|
|
Docker networks can be imported using the long id, e.g. for a network with the short id `p73jelnrme5f`:
|
|
|
|
```sh
|
|
$ terraform import docker_network.foo $(docker network inspect -f {{.ID}} p73)
|
|
```
|