terraform-provider-docker/docs/resources/volume.md
Martin 7e569e1813
chore(ci): Update website-generation workflow (#386)
* chore(ci): Update website-generation workflow

* chore(docs): Apply new formatting.

* chore: Add update go.mod and go.sum files.
2022-06-17 12:09:59 +02:00

2 KiB

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

Resource (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

resource "docker_volume" "shared_volume" {
  name = "shared_volume"
}

Schema

Optional

  • driver (String) Driver type for the volume. Defaults to local.
  • driver_opts (Map of String) Options specific to the driver.
  • labels (Block Set) User-defined key/value metadata (see below for nested schema)
  • name (String) The name of the Docker volume (will be generated if not provided).

Read-Only

  • id (String) The ID of this resource.
  • mountpoint (String) The mountpoint of the volume.

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 by providing the id:

#!/bin/bash
terraform import docker_volume.foo id

Example

Assuming you created a volume as follows

#!/bin/bash
docker volume create
# prints the long ID
524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d

you provide the definition for the resource as follows

resource "docker_volume" "foo" {
  name = "524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d"
}

then the import command is as follows

#!/bin/bash
terraform import docker_volume.foo 524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d