image_build
Build a Docker image from a Dockerfile using the daemon's classic builder. Ideal for simple single-platform builds from a local build context.
Instructions
Build an image from a Dockerfile using the daemon's classic builder.
Use this for simple single-platform builds from a local context. For multi-platform
builds, BuildKit cache export/import, or advanced build features prefer buildx_build.
path must be a directory accessible on the host running this server (it is the build
context sent to the daemon). dockerfile is normally relative to path; omit to use the
default Dockerfile.
dockerfile is not confined to the context, despite the usual relative form: docker-py detects
an absolute path, or a relative one escaping via .., reads that file from the server host's
filesystem and injects its contents into the build. So it can read any file the server user can,
like the other host-filesystem parameters (dest_path, from_file), and unlike them it is easy
to mistake for a context-relative name. buildx_build's --file resolves differently again
(against the CLI's working directory) - see its docstring.
Args:
path: Build context directory path on the server host
tag: Name and optional tag in "name:tag" format to apply to the built image
quiet: Suppress verbose build output (final image id still returned)
nocache: Ignore the layer cache and rebuild all layers
rm: Remove intermediate containers on success
pull: Always pull a newer version of each FROM base image before building
forcerm: Remove intermediate containers even on build failure
dockerfile: Dockerfile filename relative to path (default: "Dockerfile"); an absolute path or one containing
".." reads that file from the server host instead of the context
buildargs: Build-time variables passed as --build-arg; dict of str to str
container_limits: Resource limits for the build container, e.g. {"memory": 134217728}
shmsize: Size of /dev/shm in bytes for build steps that need shared memory
labels: Labels to set on the resulting image (dict of str to str)
cache_from: List of image references to use as layer cache sources
target: Stop at this named build stage (multi-stage Dockerfiles)
network_mode: Network mode for RUN instructions during build (e.g. "host", "none")
squash: Squash all new layers into one (experimental; requires daemon flag)
extra_hosts: Additional /etc/hosts entries during build; dict of hostname to IP
platform: Target platform, e.g. "linux/amd64" (single platform only; use buildx for multi)
isolation: Isolation technology, passed to the daemon as given; platform-dependent, so not validated here
(Windows documents "default", "process", "hyperv")
use_config_proxy: Forward proxy env vars from Docker client config to build
Returns:
dict: The built image's full inspect payload (as docker inspect)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rm | No | ||
| tag | No | ||
| path | No | ||
| pull | No | ||
| quiet | No | ||
| labels | No | ||
| squash | No | ||
| target | No | ||
| forcerm | No | ||
| nocache | No | ||
| shmsize | No | ||
| platform | No | ||
| buildargs | No | ||
| isolation | No | ||
| cache_from | No | ||
| dockerfile | No | ||
| extra_hosts | No | ||
| network_mode | No | ||
| container_limits | No | ||
| use_config_proxy | No |