@@ -36,164 +36,164 @@ buildargs as the environment context for commands run via the
Dockerfile
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
+Index signature
[key: string]: string
-Source
-packages/extension-api/src/extension-api.d.ts:3033
+Source
+packages/extension-api/src/extension-api.d.ts:3033
-cachefrom?
+cachefrom?
optional cachefrom: string
JSON array of images used for build cache resolution.
-Source
-packages/extension-api/src/extension-api.d.ts:2975
+Source
+packages/extension-api/src/extension-api.d.ts:2975
-containerFile?
+containerFile?
optional containerFile: string
Specifies a Containerfile which contains instructions for building the image
-Source
-packages/extension-api/src/extension-api.d.ts:2929
+Source
+packages/extension-api/src/extension-api.d.ts:2929
-cpuperiod?
+cpuperiod?
optional cpuperiod: number
The length of a CPU period in microseconds.
-Source
-packages/extension-api/src/extension-api.d.ts:3019
+Source
+packages/extension-api/src/extension-api.d.ts:3019
-cpuquota?
+cpuquota?
optional cpuquota: number
Microseconds of CPU time that the container can get in a CPU period.
-Source
-packages/extension-api/src/extension-api.d.ts:3024
+Source
+packages/extension-api/src/extension-api.d.ts:3024
-cpusetcpus?
+cpusetcpus?
optional cpusetcpus: number
CPUs in which to allow execution (e.g., 0-3, 0,1).
-Source
-packages/extension-api/src/extension-api.d.ts:3014
+Source
+packages/extension-api/src/extension-api.d.ts:3014
-cpushares?
+cpushares?
optional cpushares: number
CPU shares (relative weight).
-Source
-packages/extension-api/src/extension-api.d.ts:3009
+Source
+packages/extension-api/src/extension-api.d.ts:3009
-
+
optional extrahosts: string
Extra hosts to add to /etc/hosts
-Source
-packages/extension-api/src/extension-api.d.ts:2954
+Source
+packages/extension-api/src/extension-api.d.ts:2954
-forcerm?
+forcerm?
optional forcerm: boolean
Default: false
Always remove intermediate containers, even upon failure.
-Source
-packages/extension-api/src/extension-api.d.ts:2994
+Source
+packages/extension-api/src/extension-api.d.ts:2994
-labels?
+labels?
optional labels: object
Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
-Index signature
+Index signature
[key: string]: string
-Source
-packages/extension-api/src/extension-api.d.ts:3048
+Source
+packages/extension-api/src/extension-api.d.ts:3048
-memory?
+memory?
optional memory: number
Set memory limit for build.
-Source
-packages/extension-api/src/extension-api.d.ts:2999
+Source
+packages/extension-api/src/extension-api.d.ts:2999
-memswap?
+memswap?
optional memswap: number
Total memory (memory + swap). Set as -1 to disable swap.
-Source
-packages/extension-api/src/extension-api.d.ts:3004
+Source
+packages/extension-api/src/extension-api.d.ts:3004
-networkmode?
+networkmode?
optional networkmode: string
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.
-Source
-packages/extension-api/src/extension-api.d.ts:3055
+Source
+packages/extension-api/src/extension-api.d.ts:3055
-nocache?
+nocache?
optional nocache: boolean
Default: false
Do not use the cache when building the image.
-Source
-packages/extension-api/src/extension-api.d.ts:3076
+Source
+packages/extension-api/src/extension-api.d.ts:3076
-outputs?
+outputs?
optional outputs: string
Default: ""
BuildKit output configuration
-Source
-packages/extension-api/src/extension-api.d.ts:3069
+Source
+packages/extension-api/src/extension-api.d.ts:3069
-
+
optional platform: string
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
-Source
-packages/extension-api/src/extension-api.d.ts:2939
+Source
+packages/extension-api/src/extension-api.d.ts:2939
-provider?
+provider?
optional provider: ContainerProviderConnection
Set the provider to use, if not we will try select the first one available (sorted in favor of Podman)
-Source
-packages/extension-api/src/extension-api.d.ts:2944
+Source
+packages/extension-api/src/extension-api.d.ts:2944
-pull?
+pull?
optional pull: string
Attempt to pull the image even if an older image exists locally.
-Source
-packages/extension-api/src/extension-api.d.ts:2980
+Source
+packages/extension-api/src/extension-api.d.ts:2980
-
+
optional q: boolean
Default: false
Suppress verbose build output.
-Source
-packages/extension-api/src/extension-api.d.ts:2970
+Source
+packages/extension-api/src/extension-api.d.ts:2970
-remote?
+remote?
optional remote: string
@@ -202,49 +202,49 @@ placed into a file called Dockerfile and the image is built from that file. If t
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.
-Source
-packages/extension-api/src/extension-api.d.ts:2963
+Source
+packages/extension-api/src/extension-api.d.ts:2963
-rm?
+rm?
optional rm: boolean
Default: true
Remove intermediate containers after a successful build.
-Source
-packages/extension-api/src/extension-api.d.ts:2987
+Source
+packages/extension-api/src/extension-api.d.ts:2987
-shmsize?
+shmsize?
optional shmsize: number
Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB.
-Source
-packages/extension-api/src/extension-api.d.ts:3038
+Source
+packages/extension-api/src/extension-api.d.ts:3038
-squash?
+squash?
optional squash: boolean
Squash the resulting images layers into a single layer.
-Source
-packages/extension-api/src/extension-api.d.ts:3043
+Source
+packages/extension-api/src/extension-api.d.ts:3043
-tag?
+tag?
optional tag: string
Specifies the name which is assigned to the resulting image if the build process completes successfully
-Source
-packages/extension-api/src/extension-api.d.ts:2934
+Source
+packages/extension-api/src/extension-api.d.ts:2934
-target?
+target?
optional target: string
Default: ""
Target build stage
-Source
-packages/extension-api/src/extension-api.d.ts:3062