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.
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 name and tag tag might be created, which can cause the basic idempotency this module offers to not work.
Providing an empty list to this option is equivalent to not specifying it at all. The default behavior is a single entry with outputs[].type=image.
Name for the Docker context where to import the result.
+Optional for outputs[].type=docker.
The destination path.
+Required for outputs[].type=local, outputs[].type=tar, outputs[].type=oci.
Optional for outputs[].type=docker.
Name under which the image is stored under.
+If not provided, name and tag will be used.
Optional for outputs[].type=image.
Whether to push the built image to a registry.
+Only used for outputs[].type=image.
Choices:
+false ← (default)
true
The type of exporter to use.
+Choices:
+"docker":
+This export type writes the single-platform result image as a Docker image specification tarball on the client. Tarballs created by this exporter are also OCI compatible.
The destination can be provided in outputs[].dest. If not specified, the tar will be loaded automatically to the local image store.
The Docker context where to import the result can be provided in outputs[].context.
"image":
+This exporter writes the build result as an image or a manifest list. When using this driver, the image will appear in docker images.
The image name can be provided in outputs[].name. If it is not provided, the
Optionally, image can be automatically pushed to a registry by setting outputs[].push=true.
"local":
+This export type writes all result files to a directory on the client. The new files will be owned by the current user. On multi-platform builds, all results will be put in subdirectories by their platform.
The destination has to be provided in outputs[].dest.
"oci":
+This export type writes the result image or manifest list as an OCI image layout tarball on the client.
The destination has to be provided in outputs[].dest.
"tar":
+This export type export type writes all result files as a single tarball on the client. On multi-platform builds, all results will be put in subdirectories by their platform.
The destination has to be provided in outputs[].dest.
Platform in the format os[/arch[/variant]].
Platforms in the format os[/arch[/variant]].
Since community.docker 3.10.0 this can be a list of platforms, instead of just a single platform.
Environment value of the secret.
+Only supported and required for secrets[].type=env.
The secret identifier.
+The secret will be made available as a file in the container under /run/secrets/<id>.
Source path of the secret.
+Only supported and required for secrets[].type=file.
Type of the secret.
+Choices:
+"env":
+Reads the secret from an environment variable on the target.
The environment variable must be named in secrets[].env.
Note that this requires the Buildkit plugin to have version 0.6.0 or newer.
+"file":
+Reads the secret from a file on the target.
The file must be specified in secrets[].src.
"value":
+Provides the secret from a given value secrets[].value.
Note that the secret will be passed as an environment variable to docker compose. Use another mean of transport if you consider this not safe enough.
Note that this requires the Buildkit plugin to have version 0.6.0 or newer.
+Value of the secret.
+Note that the secret will be passed as an environment variable to docker compose. Use another mean of transport if you consider this not safe enough.
Only supported and required for secrets[].type=value.