terraform/website/source/docs/providers/docker/r/image.html.markdown

64 lines
1.9 KiB
Markdown
Raw Normal View History

2015-03-29 04:05:17 +02:00
---
layout: "docker"
page_title: "Docker: docker_image"
sidebar_current: "docs-docker-resource-image"
description: |-
Pulls a Docker image to a given Docker host.
2015-03-29 04:05:17 +02:00
---
# 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
2016-09-12 08:04:04 +02:00
conjunction with [`docker_registry_image`](/docs/providers/docker/d/registry_image.html)
data source to update the `pull_triggers` field.
2015-03-29 04:05:17 +02:00
## Example Usage
```hcl
2015-03-29 04:05:17 +02:00
# Find the latest Ubuntu precise image.
resource "docker_image" "ubuntu" {
name = "ubuntu:precise"
2015-03-29 04:05:17 +02:00
}
# Access it somewhere else with ${docker_image.ubuntu.latest}
2015-03-29 04:05:17 +02:00
```
### Dynamic image
```hcl
data "docker_registry_image" "ubuntu" {
name = "ubuntu:precise"
}
resource "docker_image" "ubuntu" {
name = "${data.docker_registry_image.ubuntu.name}"
pull_triggers = ["${data.docker_registry_image.ubuntu.sha256_digest}"]
}
```
2015-03-29 04:05:17 +02:00
## 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_triggers` - (Optional, list of strings) List of values which cause an
image pull when changed. This is used to store the image digest from the
registry when using the `docker_registry_image` [data source](/docs/providers/docker/d/registry_image.html)
to trigger an image update.
* `pull_trigger` - **Deprecated**, use `pull_triggers` instead.
2015-03-29 04:05:17 +02:00
## Attributes Reference
The following attributes are exported in addition to the above configuration:
* `latest` (string) - The ID of the image.