Type Alias: ImageBuildData ​
ImageBuildData:
object
Type declaration ​
| Name | Type | Description |
|---|---|---|
headers? | object | - |
headers.Content-type? | "application/x-tar" | - |
headers.X-Registry-Config? | string | This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to. The key is a registry URL, and the value is an auth configuration object, as described in the authentication section. For example: { "docker.example.com": { "username": "janedoe", "password": "hunter2" }, "https://index.docker.io/v1/": { "username": "mobydock", "password": "conta1n3rize14" } } Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a https:// prefix and a /v1/ suffix even though Docker will prefer to use the v2 registry API. |
query? | object | - |
query.buildargs? | string | 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 Dockerfile 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. Read more about the buildargs instruction. |
query.cachefrom? | string | JSON array of images used for build cache resolution. |
query.cpuperiod? | number | The length of a CPU period in microseconds. |
query.cpuquota? | number | Microseconds of CPU time that the container can get in a CPU period. |
query.cpusetcpus? | string | CPUs in which to allow execution (e.g., 0-3, 0,1). |
query.cpushares? | number | CPU shares (relative weight). |
query.dockerfile? | string | Path within the build context to the Dockerfile. This is ignored if remote is specified and points to an external Dockerfile. |
query.extrahosts? | string | Extra hosts to add to /etc/hosts |
query.forcerm? | boolean | Always remove intermediate containers, even upon failure. |
query.labels? | string | Arbitrary key/value labels to set on the image, as a JSON map of string pairs. |
query.memory? | number | Set memory limit for build. |
query.memswap? | number | Total memory (memory + swap). Set as -1 to disable swap. |
query.networkmode? | string | Sets the networking mode for the run commands during build. Supported standard values are: bridge, host, none, and `container:<name |
query.nocache? | boolean | Do not use the cache when building the image. |
query.outputs? | string | BuildKit output configuration |
query.platform? | string | Platform in the format os[/arch[/variant]] |
query.pull? | string | Attempt to pull the image even if an older image exists locally. |
query.q? | boolean | Suppress verbose build output. |
query.remote? | string | 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. |
query.rm? | boolean | Remove intermediate containers after a successful build. |
query.shmsize? | number | Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB. |
query.squash? | boolean | Squash the resulting images layers into a single layer. (Experimental release only.) |
query.t? | string | A name and optional tag to apply to the image in the name:tag format. If you omit the tag the default latest value is assumed. You can provide several t parameters. |
query.target? | string | Target build stage |
query.version? | "1" | "2" | Version of the builder backend to use. - 1 is the first generation classic (deprecated) builder in the Docker daemon (default) - 2 is BuildKit |