Skip to main content

Interface: BuildImageOptions

Defined in: packages/extension-api/src/extension-api.d.ts:3449

Properties​

abortController?​

optional abortController: AbortController

Defined in: packages/extension-api/src/extension-api.d.ts:3473

The abort controller for running the build image operation

buildargs?​

optional buildargs: object

Defined in: packages/extension-api/src/extension-api.d.ts:3557

JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the Dockerfile RUN instruction, or for variable expansion in other Dockerfilev instructions. This is not meant for passing secret values. For example, the build arg FOO=bar would become {"FOO":"bar"} in JSON. This would result in the query parameter buildargs={"FOO":"bar"}. Note that {"FOO":"bar"} should be URI component encoded.

Index Signature​

[key: string]: string

cachefrom?​

optional cachefrom: string

Defined in: packages/extension-api/src/extension-api.d.ts:3499

JSON array of images used for build cache resolution.

containerFile?​

optional containerFile: string

Defined in: packages/extension-api/src/extension-api.d.ts:3453

Specifies a Containerfile which contains instructions for building the image

cpuperiod?​

optional cpuperiod: number

Defined in: packages/extension-api/src/extension-api.d.ts:3543

The length of a CPU period in microseconds.

cpuquota?​

optional cpuquota: number

Defined in: packages/extension-api/src/extension-api.d.ts:3548

Microseconds of CPU time that the container can get in a CPU period.

cpusetcpus?​

optional cpusetcpus: number

Defined in: packages/extension-api/src/extension-api.d.ts:3538

CPUs in which to allow execution (e.g., 0-3, 0,1).

cpushares?​

optional cpushares: number

Defined in: packages/extension-api/src/extension-api.d.ts:3533

CPU shares (relative weight).

extrahosts?​

optional extrahosts: string

Defined in: packages/extension-api/src/extension-api.d.ts:3478

Extra hosts to add to /etc/hosts

forcerm?​

optional forcerm: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:3518

Default: false

Always remove intermediate containers, even upon failure.

labels?​

optional labels: object

Defined in: packages/extension-api/src/extension-api.d.ts:3572

Arbitrary key/value labels to set on the image, as a JSON map of string pairs.

Index Signature​

[key: string]: string

memory?​

optional memory: number

Defined in: packages/extension-api/src/extension-api.d.ts:3523

Set memory limit for build.

memswap?​

optional memswap: number

Defined in: packages/extension-api/src/extension-api.d.ts:3528

Total memory (memory + swap). Set as -1 to disable swap.

networkmode?​

optional networkmode: string

Defined in: packages/extension-api/src/extension-api.d.ts:3579

Sets the networking mode for the run commands during build. Supported standard values are: bridge, host, none, and container:<name|id>. Any other value is taken as a custom network's name or ID to which this container should connect to.

nocache?​

optional nocache: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:3600

Default: false

Do not use the cache when building the image.

outputs?​

optional outputs: string

Defined in: packages/extension-api/src/extension-api.d.ts:3593

Default: ""

BuildKit output configuration

platform?​

optional platform: string

Defined in: packages/extension-api/src/extension-api.d.ts:3463

Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host

provider?​

optional provider: ContainerProviderConnection

Defined in: packages/extension-api/src/extension-api.d.ts:3468

Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)

pull?​

optional pull: string

Defined in: packages/extension-api/src/extension-api.d.ts:3504

Attempt to pull the image even if an older image exists locally.

q?​

optional q: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:3494

Default: false

Suppress verbose build output.

remote?​

optional remote: string

Defined in: packages/extension-api/src/extension-api.d.ts:3487

A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball.

rm?​

optional rm: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:3511

Default: true

Remove intermediate containers after a successful build.

shmsize?​

optional shmsize: number

Defined in: packages/extension-api/src/extension-api.d.ts:3562

Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB.

squash?​

optional squash: boolean

Defined in: packages/extension-api/src/extension-api.d.ts:3567

Squash the resulting images layers into a single layer.

tag?​

optional tag: string

Defined in: packages/extension-api/src/extension-api.d.ts:3458

Specifies the name which is assigned to the resulting image if the build process completes successfully

target?​

optional target: string

Defined in: packages/extension-api/src/extension-api.d.ts:3586

Default: ""

Target build stage