Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/builder_build.md

51 lines
8.0 KiB
Markdown
Raw Normal View History

docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
# builder build
<!---MARKER_GEN_START-->
Build an image from a Dockerfile
### Aliases
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
`docker image build`, `docker build`, `docker builder build`
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
### Options
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
| Name | Type | Default | Description |
|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:----------|:------------------------------------------------------------------|
| [`--add-host`](https://docs.docker.com/reference/cli/docker/buildx/build/#add-host) | `list` | | Add a custom host-to-IP mapping (`host:ip`) |
| [`--build-arg`](https://docs.docker.com/reference/cli/docker/buildx/build/#build-arg) | `list` | | Set build-time variables |
| `--cache-from` | `stringSlice` | | Images to consider as cache sources |
| [`--cgroup-parent`](https://docs.docker.com/reference/cli/docker/buildx/build/#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `--compress` | `bool` | | Compress the build context using gzip |
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
| `--cpu-period` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit the CPU CFS (Completely Fair Scheduler) quota |
| `-c`, `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
| `--disable-content-trust` | `bool` | `true` | Skip image verification |
| [`-f`](https://docs.docker.com/reference/cli/docker/buildx/build/#file), [`--file`](https://docs.docker.com/reference/cli/docker/buildx/build/#file) | `string` | | Name of the Dockerfile (Default is `PATH/Dockerfile`) |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `--force-rm` | `bool` | | Always remove intermediate containers |
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
| `--iidfile` | `string` | | Write the image ID to the file |
| `--isolation` | `string` | | Container isolation technology |
| `--label` | `list` | | Set metadata for an image |
| `-m`, `--memory` | `bytes` | `0` | Memory limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap |
| [`--network`](https://docs.docker.com/reference/cli/docker/buildx/build/#network) | `string` | `default` | Set the networking mode for the RUN instructions during build |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `--no-cache` | `bool` | | Do not use cache when building the image |
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
| `--platform` | `string` | | Set platform if server is multi-platform capable |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `--pull` | `bool` | | Always attempt to pull a newer version of the image |
| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success |
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
| `--rm` | `bool` | `true` | Remove intermediate containers after a successful build |
| `--security-opt` | `stringSlice` | | Security options |
| `--shm-size` | `bytes` | `0` | Size of `/dev/shm` |
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `--squash` | `bool` | | Squash newly built layers into a single new layer |
docs: make buildx build the canonical reference doc Move common flag descriptions to the buildx build reference, and make that page the canonical page in docs. Also rewrite some content in image_build to make clear that this page is only for the legacy builder. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 06:10:10 -04:00
| [`-t`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag), [`--tag`](https://docs.docker.com/reference/cli/docker/buildx/build/#tag) | `list` | | Name and optionally a tag in the `name:tag` format |
| [`--target`](https://docs.docker.com/reference/cli/docker/buildx/build/#target) | `string` | | Set the target build stage to build. |
| `--ulimit` | `ulimit` | | Ulimit options |
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_END-->
## Description
docs: update url scheme for reference docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-13 07:40:53 -05:00
See [docker build](image_build.md) for more information.