docker.volume

Volume is responsible for managing Docker volumes. It assumes that there is already a Docker daemon running on the system.

Example

docker.volume "elasticsearch" {
  name = "elasticsearch"

  labels {
    environment = "test"
  }

  state = "present"
  force = true
}

Parameters

  • name (required string)

name of the volume

  • driver (string)

volume driver. default: local

  • labels (map of string to string)

labels to set on the volume

  • options (map of string to string)

driver specific options

  • state (State)

Valid values: present and absent

indicates whether the volume should exist.

  • force (bool)

indicates whether or not the volume will be recreated if the state is not what is expected. By default, the module will only check to see if the volume exists. Specified as a boolean value