mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2026-01-20 21:52:57 -05:00
3f9193463f
* docs: add an example to build a Docker image with docker_image * docs: add description of the docker_image.build block
100 lines
3.1 KiB
Markdown
100 lines
3.1 KiB
Markdown
---
|
|
layout: "docker"
|
|
page_title: "Docker: docker_image"
|
|
sidebar_current: "docs-docker-resource-image"
|
|
description: |-
|
|
Pulls a Docker image to a given Docker host.
|
|
---
|
|
|
|
# docker\_image
|
|
|
|
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
|
|
conjunction with [`docker_registry_image`](/docs/providers/docker/d/registry_image.html)
|
|
data source to update the `pull_triggers` field.
|
|
|
|
## Example Usage
|
|
|
|
```hcl
|
|
# Find the latest Ubuntu precise image.
|
|
resource "docker_image" "ubuntu" {
|
|
name = "ubuntu:precise"
|
|
}
|
|
|
|
# Access it somewhere else with ${docker_image.ubuntu.latest}
|
|
|
|
```
|
|
|
|
Building a Docker image
|
|
|
|
```hcl
|
|
# image "zoo" and "zoo:develop" are built
|
|
resource "docker_image" "zoo" {
|
|
name = "zoo"
|
|
build {
|
|
path = "."
|
|
tag = ["zoo:develop"]
|
|
build_arg = {
|
|
foo : "zoo"
|
|
}
|
|
label = {
|
|
author : "zoo"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### 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]
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
The following arguments are supported:
|
|
|
|
* `name` - (Required, string) The name of the Docker image, including any tags or SHA256 repo digests.
|
|
* `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.
|
|
* `force_remove` - (Optional, boolean) If true, then the image is removed forcibly when the resource is destroyed.
|
|
* `build` - (Optional, block) See [Build](#build-1) below for details.
|
|
|
|
<a id="build-1"></a>
|
|
### Build
|
|
|
|
Build image.
|
|
|
|
Please see [docker build command reference](https://docs.docker.com/engine/reference/commandline/build/#options) too.
|
|
|
|
The `build` block supports:
|
|
|
|
* `path` - (Required, string) Context path
|
|
* `dockerfile` - (Optional, string, default `Dockerfile`) Path to the Dockerfile
|
|
* `tag` - (Optional, list of strings) Built Docker image name and optionally a tag in the `name:tag` format
|
|
* `force_remove` - (Optional, boolean) Always remove intermediate containers
|
|
* `remove` - (Optional, boolean, default `true`) Remove intermediate containers after a successful build
|
|
* `no_cache` - (Optional, boolean) Do not use cache when building the image
|
|
* `target` - (Optional, string) Set the target build stage to build
|
|
* `build_arg` - (Optional, map of strings) Set build-time variables
|
|
* `label` - (Optional, map of strings) Set metadata for an image
|
|
|
|
## Attributes Reference
|
|
|
|
The following attributes are exported in addition to the above configuration:
|
|
|
|
* `latest` (string) - The ID of the image.
|