docker_image

-> Note: The initial (current) version of this resource can only pull public images from the official Docker Hub Registry.

Pulls a Docker image to a given Docker host from a Docker Registry.

This resource will not pull new layers of the image automatically unless used in conjuction with docker_registry_image data source to update the pull_trigger field.

Example Usage

# Find the latest Ubuntu precise image.
resource "docker_image" "ubuntu" {
    name = "ubuntu:precise"
}

# Access it somewhere else with ${docker_image.ubuntu.latest}

Dynamic image

data "docker_registry_image" "ubuntu" {
    name = "ubuntu:precise"
}

resource "docker_image" "ubuntu" {
    name = "${data.docker_registry_image.ubuntu.name}"
    pull_trigger = "${data.docker_registry_image.ubuntu.sha256_digest}"
}

Argument Reference

The following arguments are supported:

  • name - (Required, string) The name of the Docker image, including any tags.
  • keep_locally - (Optional, boolean) If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.
  • pull_trigger - (Optional, string) Used to store the image digest from the registry and will cause an image pull when changed. Needed when using the docker_registry_image data source to trigger an update of the image.

Attributes Reference

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

  • latest (string) - The ID of the image.