terraform-provider-docker/website/docs/r/volume.html.markdown
Manuel Vogel 434ca8c64b
feat: adds import for resources (#196)
Closes #99. Adds import for config service volume
2019-11-23 14:42:05 +01:00

1.3 KiB

layout page_title sidebar_current description
docker Docker: docker_volume docs-docker-resource-volume Creates and destroys docker volumes.

docker_volume

Creates and destroys a volume in Docker. This can be used alongside docker_container to prepare volumes that can be shared across containers.

Example Usage

# Creates a docker volume "shared_volume".
resource "docker_volume" "shared_volume" {
  name = "shared_volume"
}

# Reference the volume with ${docker_volume.shared_volume.name}

Argument Reference

The following arguments are supported:

  • name - (Optional, string) The name of the Docker volume (generated if not provided).
  • labels - (Optional, map of string/string key/value pairs) User-defined key/value metadata.
  • driver - (Optional, string) Driver type for the volume (defaults to local).
  • driver_opts - (Optional, map of strings) Options specific to the driver.

Attributes Reference

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

  • mountpoint (string) - The mountpoint of the volume.

Import

Docker volume can be imported using the long id, e.g. for a volume with the short id ecae276c5:

$ terraform import docker_volume.foo $(docker volume inspect -f {{.ID}} eca)