community.docker.docker_image_build module – Build Docker images using Docker buildx
Note
This module is part of the community.docker collection (version 3.13.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.docker
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.docker.docker_image_build
.
New in community.docker 3.6.0
Synopsis
This module allows you to build Docker images using Docker’s buildx plugin (BuildKit).
Note that the module is not idempotent in the sense of classical Ansible modules. The only idempotence check is whether the built image already exists. This check can be disabled with the
rebuild
option.
Requirements
The below requirements are needed on the host that executes this module.
Docker CLI with Docker buildx plugin
Parameters
Parameter |
Comments |
---|---|
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by this collection and the docker daemon. If the value is not specified in the task, the value of environment variable Default: |
|
Provide a dictionary of Docker expects the value to be a string. For convenience any non-string values will be converted to strings. |
|
Use a CA certificate when performing server verification by providing the path to a CA certificate file. If the value is not specified in the task and the environment variable |
|
List of image names to consider as cache source. |
|
The Docker CLI context to use. Mutually exclusive with |
|
Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable |
|
Path to the client’s TLS key file. If the value is not specified in the task and the environment variable |
|
Path to the Docker CLI. If not provided, will search for Docker CLI on the |
|
The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, If the value is not specified in the task, the value of environment variable Mutually exclusive with |
|
Provide an alternate name for the Dockerfile to use when building an image. This can also include a relative path (relative to |
|
Extra hosts to add to Instead of an IP address, the special value |
|
Dictionary of key value pairs. |
|
Image name. Name format will be one of: Note that image IDs (hashes) and names with digest cannot be used. |
|
The network to use for |
|
Do not use cache when building an image. Choices:
|
|
Output destinations. You can provide a list of exporters to export the built image in various places. Note that not all exporters might be supported by the build driver used. Note that depending on how this option is used, no image with name Providing an empty list to this option is equivalent to not specifying it at all. The default behavior is a single entry with |
|
Name for the Docker context where to import the result. Optional for |
|
The destination path. Required for Optional for |
|
Name under which the image is stored under. If not provided, Optional for |
|
Whether to push the built image to a registry. Only used for Choices:
|
|
The type of exporter to use. Choices:
|
|
The path for the build environment. |
|
Platforms in the format Since community.docker 3.10.0 this can be a list of platforms, instead of just a single platform. |
|
When building an image downloads any updates to the FROM image in Dockerfile. Choices:
|
|
Secrets to expose to the build. |
|
Environment value of the secret. Only supported and required for |
|
The secret identifier. The secret will be made available as a file in the container under |
|
Source path of the secret. Only supported and required for |
|
Type of the secret. Choices:
|
|
Value of the secret. Note that the secret will be passed as an environment variable to Only supported and required for |
|
Size of Omitting the unit defaults to bytes. If you omit the size entirely, Docker daemon uses |
|
When building an image specifies an intermediate build stage by name as a final stage for the resulting image. |
|
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if If the value is not specified in the task, the value of environment variable Choices:
|
|
When verifying the authenticity of the Docker Host server, provide the expected name of the server. If the value is not specified in the task, the value of environment variable |
|
Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. If the value is not specified in the task, the value of environment variable Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Action groups: community.docker.docker, docker |
Use |
|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
DOCKER_HOST
,DOCKER_TLS_HOSTNAME
,DOCKER_API_VERSION
,DOCKER_CERT_PATH
,DOCKER_TLS
,DOCKER_TLS_VERIFY
andDOCKER_TIMEOUT
. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.
See Also
See also
- community.docker.docker_image_push
Push Docker images to registries.
- community.docker.docker_image_tag
Tag Docker images with new names and/or tags.
Examples
- name: Build Python 3.12 image
community.docker.docker_image_build:
name: localhost/python/3.12:latest
path: /home/user/images/python
dockerfile: Dockerfile-3.12
- name: Build multi-platform image
community.docker.docker_image_build:
name: multi-platform-image
tag: "1.5.2"
path: /home/user/images/multi-platform
platform:
- linux/amd64
- linux/arm64/v8
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Image inspection results for the affected image. Returned: success Sample: |