terraform-provider-docker/docs/resources/volume.md
2021-05-17 14:39:55 +02:00

1.5 KiB

page_title subcategory description
docker_volume Resource - terraform-provider-docker Creates and destroys a volume in Docker. This can be used alongside docker_container to prepare volumes that can be shared across containers.

docker_volume (Resource)

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}

Schema

Optional

  • driver (String)
  • driver_opts (Map of String)
  • id (String) The ID of this resource.
  • labels (Block Set) User-defined key/value metadata (see below for nested schema)
  • name (String)

Read-Only

  • mountpoint (String)

Nested Schema for labels

Required:

  • label (String) Name of the label
  • value (String) Value of the label

Import

Import is supported using the following syntax:

#!/bin/bash

# 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)"