跳至主要内容

接口: BuildImageOptions

属性

abortController?

optional abortController: AbortController

用于运行构建镜像操作的中止控制器

定义在

packages/extension-api/src/extension-api.d.ts:3461


buildargs?

optional buildargs: object

构建时变量的字符串对 JSON 映射。用户在构建时传递这些值。Docker 使用 buildargs 作为通过 Dockerfile RUN 指令运行的命令的环境上下文,或用于其他 Dockerfile 指令中的变量展开。这不是用于传递秘密值的。例如,构建参数 FOO=bar 将在 JSON 中变为 {"FOO":"bar"}。这将导致查询参数 buildargs={"FOO":"bar"}。请注意,{"FOO":"bar"} 应为 URI 组件编码。

索引签名

[key: string]: string

定义在

packages/extension-api/src/extension-api.d.ts:3545


cachefrom?

optional cachefrom: string

用于构建缓存解析的镜像 JSON 数组。

定义在

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


containerFile?

optional containerFile: string

指定包含构建镜像说明的 Containerfile

定义在

packages/extension-api/src/extension-api.d.ts:3441


cpuperiod?

optional cpuperiod: number

CPU 周期的长度(以微秒为单位)。

定义在

packages/extension-api/src/extension-api.d.ts:3531


cpuquota?

optional cpuquota: number

容器在一个 CPU 周期内可以获得的 CPU 时间(以微秒为单位)。

定义在

packages/extension-api/src/extension-api.d.ts:3536


cpusetcpus?

optional cpusetcpus: number

允许执行的 CPU(例如,0-3、0、1)。

定义在

packages/extension-api/src/extension-api.d.ts:3526


cpushares?

optional cpushares: number

CPU 份额(相对权重)。

定义在

packages/extension-api/src/extension-api.d.ts:3521


extrahosts?

optional extrahosts: string

要添加到 /etc/hosts 的额外主机

定义在

packages/extension-api/src/extension-api.d.ts:3466


forcerm?

optional forcerm: boolean

默认值:false

始终删除中间容器,即使在失败时也是如此。

定义在

packages/extension-api/src/extension-api.d.ts:3506


labels?

optional labels: object

作为字符串对的 JSON 映射,要设置在镜像上的任意键值标签。

索引签名

[key: string]: string

定义在

packages/extension-api/src/extension-api.d.ts:3560


memory?

optional memory: number

设置构建的内存限制。

定义在

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


memswap?

optional memswap: number

总内存(内存 + 交换)。设置为 -1 以禁用交换。

定义在

packages/extension-api/src/extension-api.d.ts:3516


networkmode?

optional networkmode: string

设置构建期间运行命令的网络模式。支持的标准值为:bridgehostnonecontainer:<name|id>。任何其他值都将被视为自定义网络的名称或 ID,此容器应连接到该网络。

定义于

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


nocache?

可选 nocache: 布尔值

默认值:false

构建镜像时不使用缓存。

定义于

packages/extension-api/src/extension-api.d.ts:3588


outputs?

可选 outputs: 字符串

默认值: ""

BuildKit 输出配置

定义于

packages/extension-api/src/extension-api.d.ts:3581


platform?

可选 platform: 字符串

将构建的镜像(以及使用基础镜像时其基础镜像)的 os/arch 设置为提供的值,而不是使用主机的当前操作系统和体系结构

定义于

packages/extension-api/src/extension-api.d.ts:3451


provider?

可选 provider: ContainerProviderConnection

设置要使用的提供程序,如果未设置,我们将尝试选择第一个可用的提供程序(按优先级排序,优先使用 Podman)

定义于

packages/extension-api/src/extension-api.d.ts:3456


pull?

可选 pull: 字符串

即使本地存在较旧的镜像,也尝试拉取镜像。

定义于

packages/extension-api/src/extension-api.d.ts:3492


q?

可选 q: 布尔值

默认值:false

抑制详细的构建输出。

定义于

packages/extension-api/src/extension-api.d.ts:3482


remote?

可选 remote: 字符串

Git 存储库 URI 或 HTTP/HTTPS 上下文 URI。如果 URI 指向单个文本文件,则将该文件的內容放置到名为 Dockerfile 的文件中,并从该文件构建镜像。如果 URI 指向 tarball,则守护进程会下载该文件,并将其中包含的內容用作构建的上下文。如果 URI 指向 tarball 并且也指定了 dockerfile 参数,则 tarball 中必须包含一个具有相应路径的文件。

定义于

packages/extension-api/src/extension-api.d.ts:3475


rm?

可选 rm: 布尔值

默认值: true

构建成功后删除中间容器。

定义于

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


shmsize?

可选 shmsize: 数字

/dev/shm 的大小(以字节为单位)。该大小必须大于 0。如果省略,系统将使用 64MB。

定义于

packages/extension-api/src/extension-api.d.ts:3550


squash?

可选 squash: 布尔值

将生成的镜像层压缩到单个层中。

定义于

packages/extension-api/src/extension-api.d.ts:3555


tag?

可选 tag: 字符串

指定构建过程成功完成后分配给生成的镜像的名称

定义于

packages/extension-api/src/extension-api.d.ts:3446


target?

可选 target: 字符串

默认值: ""

目标构建阶段

定义于

packages/extension-api/src/extension-api.d.ts:3574