From 5f2147a9d5491ecedb647008bcb563c1d4be37dd Mon Sep 17 00:00:00 2001 From: Colin Hebert Date: Fri, 15 Jan 2016 17:33:17 +0000 Subject: [PATCH] provider/docker: Add `docker_volume` resource --- r/volume.html.markdown | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 r/volume.html.markdown diff --git a/r/volume.html.markdown b/r/volume.html.markdown new file mode 100644 index 00000000..5b13efc0 --- /dev/null +++ b/r/volume.html.markdown @@ -0,0 +1,38 @@ +--- +layout: "docker" +page_title: "Docker: docker_volume" +sidebar_current: "docs-docker-resource-volume" +description: |- + Creates and destroys docker volumes. +--- + +# docker\_volume + +Creates and destroys a volume in Docker. This can be used alongside +[docker\_container](/docs/providers/docker/r/container.html) +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). +* `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.