mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2025-12-22 07:39:35 -05:00
6c796e15a5
* chore: add tfplugindocs tool
* feat: add tfplugin doc dependency and make target
* chore: apply documentation generation
* docs(contributing): update for documentation generation
* fix: adapt website-lint target to new do folder
* docs(network): update ds descriptions
* docs: add template for index.md
* docs: add network resource generation
* chore(ci): updates paths for website checks
* docs: add plugin data source generation
* docs: add import cmd for network resource
* docs: add plugin resource generation
* feat: outlines remaining resources with example and import cmd
* feat: add descriptions to docs
* chore: add DevSkim ignores and fix capitalized errors
* docs: complete ds registry image
* docs: add container resource generation
* docs: add lables description to missing resources
* docs: remove computed:true from network data
so the list is rendered in the description
* Revert "docs: remove computed:true from network data"
This reverts commit dce9b7a5a2.
* docs: add docker image descriptions to generate the docs
* docs: add docker registry image descriptions to generate the docs
* docs: add docker service descriptions to generate the docs
* docs: add docker volume descriptions to generate the docs
* docs(index): clarifies description
so more docker resources are mentioned
* docs(network): fixes required and read-only attributes
so the ds can only be read by-name
* docs(plugin): clarifies the ds docs attributes
* docs: fix typo registry image ds
* docs(config): clarifies attributes and enhances examples
Provide a long example and import command
* fix(config): make data non-sensitive
Because only secrets data is
* docs(containter): clarifies attributes
and enhances examples with import
* docs(config): fix typo
* docs(image): clarifies attributes and remove import
* docs(network): clarifies attributes and adapts import
* docs(plugin): clarifies attributes and import
* docs(registry_image): clarifies attributes and removes import
* chore(secret): remove typo
* docs(service): clarifies attributes and import
* docs(volume): clarifies attributes and import
* fix: correct md linter rules after doc gen
* docs(volume): regenerated
* docs: add config custom template
* docs: add templates for all resources
* docs(config): templates all sections and examples
for better redability and structure
* docs(config): fix md linter
* docs(container): templates all sections and examples
* docs(image): templates all sections and examples
* docs(image): fix import resource by renaming
* docs(network): templates all sections and examples
* docs(service): templates all sections and examples
* docs(volume): templates all sections and examples
* fix(lint): replace website with doc directory
* fix(ci): link check file extension check
* fix: markdown links
* chore: remove old website folder
* chore: fix website-lint terrafmr dir and pattern
* fix: lint fix target website folder
* fix: website links
* docs(provider): update examples
with templates on auth and certs
* docs(provider): add tf-plugin-docs line
* docs(contributing): split doc generation section
* docs: final brush up for readability and structure
* chore(ci): add website-generation job
to see if files changed and it should run locally again
* chore(ci): remove explicit docker setup
from website lint because it's installed by default
102 lines
No EOL
3.5 KiB
Markdown
102 lines
No EOL
3.5 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "docker_image Resource - terraform-provider-docker"
|
|
subcategory: ""
|
|
description: |-
|
|
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 dockerregistryimage registry_image.md data source to update the pull_triggers field.
|
|
---
|
|
<!-- Bug: Type and Name are switched -->
|
|
# docker_image (Resource)
|
|
|
|
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](registry_image.md) data source to update the `pull_triggers` field.
|
|
|
|
## Example Usage
|
|
|
|
### Basic
|
|
|
|
Finds and downloads the latest `ubuntu:precise` image but does not check
|
|
for further updates of the image
|
|
|
|
```terraform
|
|
resource "docker_image" "ubuntu" {
|
|
name = "ubuntu:precise"
|
|
}
|
|
```
|
|
|
|
### Dynamic updates
|
|
|
|
To be able to update an update dynamically when the `sha256` sum changes,
|
|
you need to use it in combination with `docker_registry_image` as follows:
|
|
|
|
```terraform
|
|
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]
|
|
}
|
|
```
|
|
|
|
### Build
|
|
|
|
You can also use the resource to build and image.
|
|
In thid case the image "zoo" and "zoo:develop" are built.
|
|
|
|
```terraform
|
|
resource "docker_image" "zoo" {
|
|
name = "zoo"
|
|
build {
|
|
path = "."
|
|
tag = ["zoo:develop"]
|
|
build_arg = {
|
|
foo : "zoo"
|
|
}
|
|
label = {
|
|
author : "zoo"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- **name** (String) The name of the Docker image, including any tags or SHA256 repo digests.
|
|
|
|
### Optional
|
|
|
|
- **build** (Block Set, Max: 1) Configuration to build an image. Please see [docker build command reference](https://docs.docker.com/engine/reference/commandline/build/#options) too. (see [below for nested schema](#nestedblock--build))
|
|
- **force_remove** (Boolean) If true, then the image is removed forcibly when the resource is destroyed.
|
|
- **id** (String) The ID of this resource.
|
|
- **keep_locally** (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** (String, Deprecated) A value which cause an image pull when changed
|
|
- **pull_triggers** (Set of String) 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-sources/registry_image.md).
|
|
|
|
### Read-Only
|
|
|
|
- **latest** (String) The ID of the image.
|
|
- **output** (String, Deprecated)
|
|
|
|
<a id="nestedblock--build"></a>
|
|
### Nested Schema for `build`
|
|
|
|
Required:
|
|
|
|
- **path** (String) Context path
|
|
|
|
Optional:
|
|
|
|
- **build_arg** (Map of String) Set build-time variables
|
|
- **dockerfile** (String) Name of the Dockerfile. Defaults to `Dockerfile`.
|
|
- **force_remove** (Boolean) Always remove intermediate containers
|
|
- **label** (Map of String) Set metadata for an image
|
|
- **no_cache** (Boolean) Do not use cache when building the image
|
|
- **remove** (Boolean) Remove intermediate containers after a successful build. Defaults to `true`.
|
|
- **tag** (List of String) Name and optionally a tag in the 'name:tag' format
|
|
- **target** (String) Set the target build stage to build |