mirror of https://github.com/docker/cli.git
docs: dockerfile reference moved to buildkit repo
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
parent
b496125aa7
commit
f3ed630f8f
|
@ -70,11 +70,11 @@ Config provides the base accessible fields for working with V0 plugin format
|
||||||
|
|
||||||
- **`entrypoint`** *string array*
|
- **`entrypoint`** *string array*
|
||||||
|
|
||||||
entrypoint of the plugin, see [`ENTRYPOINT`](../reference/builder.md#entrypoint)
|
entrypoint of the plugin, see [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint)
|
||||||
|
|
||||||
- **`workdir`** *string*
|
- **`workdir`** *string*
|
||||||
|
|
||||||
workdir of the plugin, see [`WORKDIR`](../reference/builder.md#workdir)
|
workdir of the plugin, see [`WORKDIR`](https://docs.docker.com/engine/reference/builder/#workdir)
|
||||||
|
|
||||||
- **`network`** *PluginNetwork*
|
- **`network`** *PluginNetwork*
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -62,7 +62,7 @@ Options:
|
||||||
The `docker build` command builds Docker images from a Dockerfile and a
|
The `docker build` command builds Docker images from a Dockerfile and a
|
||||||
"context". A build's context is the set of files located in the specified
|
"context". A build's context is the set of files located in the specified
|
||||||
`PATH` or `URL`. The build process can refer to any of the files in the
|
`PATH` or `URL`. The build process can refer to any of the files in the
|
||||||
context. For example, your build can use a [*COPY*](../builder.md#copy)
|
context. For example, your build can use a [*COPY*](https://docs.docker.com/engine/reference/builder/#copy)
|
||||||
instruction to reference a file in the context.
|
instruction to reference a file in the context.
|
||||||
|
|
||||||
The `URL` parameter can refer to three kinds of resources: Git repositories,
|
The `URL` parameter can refer to three kinds of resources: Git repositories,
|
||||||
|
@ -155,7 +155,7 @@ In most cases, it's best to put each Dockerfile in an empty directory. Then,
|
||||||
add to that directory only the files needed for building the Dockerfile. To
|
add to that directory only the files needed for building the Dockerfile. To
|
||||||
increase the build's performance, you can exclude files and directories by
|
increase the build's performance, you can exclude files and directories by
|
||||||
adding a `.dockerignore` file to that directory as well. For information on
|
adding a `.dockerignore` file to that directory as well. For information on
|
||||||
creating one, see the [.dockerignore file](../builder.md#dockerignore-file).
|
creating one, see the [.dockerignore file](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
|
||||||
|
|
||||||
If the Docker client loses connection to the daemon, the build is canceled.
|
If the Docker client loses connection to the daemon, the build is canceled.
|
||||||
This happens if you interrupt the Docker client with `CTRL-c` or if the Docker
|
This happens if you interrupt the Docker client with `CTRL-c` or if the Docker
|
||||||
|
@ -186,7 +186,7 @@ $ echo $?
|
||||||
|
|
||||||
See also:
|
See also:
|
||||||
|
|
||||||
[*Dockerfile Reference*](../builder.md).
|
[*Dockerfile Reference*](https://docs.docker.com/engine/reference/builder/).
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
@ -227,7 +227,8 @@ where to find the files for the "context" of the build on the Docker daemon.
|
||||||
Remember that the daemon could be running on a remote machine and that no
|
Remember that the daemon could be running on a remote machine and that no
|
||||||
parsing of the Dockerfile happens at the client side (where you're running
|
parsing of the Dockerfile happens at the client side (where you're running
|
||||||
`docker build`). That means that *all* the files at `PATH` get sent, not just
|
`docker build`). That means that *all* the files at `PATH` get sent, not just
|
||||||
the ones listed to [*ADD*](../builder.md#add) in the Dockerfile.
|
the ones listed to [*ADD*](https://docs.docker.com/engine/reference/builder/#add)
|
||||||
|
in the Dockerfile.
|
||||||
|
|
||||||
The transfer of context from the local machine to the Docker daemon is what the
|
The transfer of context from the local machine to the Docker daemon is what the
|
||||||
`docker` client means when you see the "Sending build context" message.
|
`docker` client means when you see the "Sending build context" message.
|
||||||
|
@ -315,15 +316,15 @@ Successfully built 99cc1ad10469
|
||||||
This example shows the use of the `.dockerignore` file to exclude the `.git`
|
This example shows the use of the `.dockerignore` file to exclude the `.git`
|
||||||
directory from the context. Its effect can be seen in the changed size of the
|
directory from the context. Its effect can be seen in the changed size of the
|
||||||
uploaded context. The builder reference contains detailed information on
|
uploaded context. The builder reference contains detailed information on
|
||||||
[creating a .dockerignore file](../builder.md#dockerignore-file).
|
[creating a .dockerignore file](https://docs.docker.com/engine/reference/builder/#dockerignore-file).
|
||||||
|
|
||||||
When using the [BuildKit backend](../builder.md#buildkit), `docker build` searches
|
When using the [BuildKit backend](https://docs.docker.com/engine/reference/builder/#buildkit),
|
||||||
for a `.dockerignore` file relative to the Dockerfile name. For example, running
|
`docker build` searches for a `.dockerignore` file relative to the Dockerfile
|
||||||
`docker build -f myapp.Dockerfile .` will first look for an ignore file named
|
name. For example, running `docker build -f myapp.Dockerfile .` will first look
|
||||||
`myapp.Dockerfile.dockerignore`. If such a file is not found, the `.dockerignore`
|
for an ignore file named `myapp.Dockerfile.dockerignore`. If such a file is not
|
||||||
file is used if present. Using a Dockerfile based `.dockerignore` is useful if a
|
found, the `.dockerignore` file is used if present. Using a Dockerfile based
|
||||||
project contains multiple Dockerfiles that expect to ignore different sets of
|
`.dockerignore` is useful if a project contains multiple Dockerfiles that expect
|
||||||
files.
|
to ignore different sets of files.
|
||||||
|
|
||||||
|
|
||||||
### <a name=tag></a> Tag an image (-t, --tag)
|
### <a name=tag></a> Tag an image (-t, --tag)
|
||||||
|
@ -427,7 +428,7 @@ Using this flag will not alter the output you see when the `ARG` lines from the
|
||||||
Dockerfile are echoed during the build process.
|
Dockerfile are echoed during the build process.
|
||||||
|
|
||||||
For detailed information on using `ARG` and `ENV` instructions, see the
|
For detailed information on using `ARG` and `ENV` instructions, see the
|
||||||
[Dockerfile reference](../builder.md).
|
[Dockerfile reference](https://docs.docker.com/engine/reference/builder/).
|
||||||
|
|
||||||
You may also use the `--build-arg` flag without a value, in which case the value
|
You may also use the `--build-arg` flag without a value, in which case the value
|
||||||
from the local environment will be propagated into the Docker container being
|
from the local environment will be propagated into the Docker container being
|
||||||
|
@ -540,7 +541,7 @@ $ docker build -o - . > out.tar
|
||||||
|
|
||||||
The `--output` option exports all files from the target stage. A common pattern
|
The `--output` option exports all files from the target stage. A common pattern
|
||||||
for exporting only specific files is to do multi-stage builds and to copy the
|
for exporting only specific files is to do multi-stage builds and to copy the
|
||||||
desired files to a new scratch stage with [`COPY --from`](../builder.md#copy).
|
desired files to a new scratch stage with [`COPY --from`](https://docs.docker.com/engine/reference/builder/#copy).
|
||||||
|
|
||||||
The example `Dockerfile` below uses a separate stage to collect the
|
The example `Dockerfile` below uses a separate stage to collect the
|
||||||
build-artifacts for exporting:
|
build-artifacts for exporting:
|
||||||
|
@ -579,8 +580,9 @@ vndr
|
||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
> This feature requires the BuildKit backend. You can either
|
> This feature requires the BuildKit backend. You can either
|
||||||
> [enable BuildKit](../builder.md#buildkit) or use the [buildx](https://github.com/docker/buildx)
|
> [enable BuildKit](https://docs.docker.com/engine/reference/builder/#buildkit) or
|
||||||
> plugin which provides more output type options.
|
> use the [buildx](https://github.com/docker/buildx) plugin which provides more
|
||||||
|
> output type options.
|
||||||
|
|
||||||
### <a name=cache-from></a> Specifying external cache sources (--cache-from)
|
### <a name=cache-from></a> Specifying external cache sources (--cache-from)
|
||||||
|
|
||||||
|
@ -621,9 +623,9 @@ $ docker build --cache-from myname/myapp .
|
||||||
> **Note**
|
> **Note**
|
||||||
>
|
>
|
||||||
> This feature requires the BuildKit backend. You can either
|
> This feature requires the BuildKit backend. You can either
|
||||||
> [enable BuildKit](../builder.md#buildkit) or use the [buildx](https://github.com/docker/buildx)
|
> [enable BuildKit](https://docs.docker.com/engine/reference/builder/#buildkit) or
|
||||||
> plugin. The previous builder has limited support for reusing cache from
|
> use the [buildx](https://github.com/docker/buildx) plugin. The previous
|
||||||
> pre-pulled images.
|
> builder has limited support for reusing cache from pre-pulled images.
|
||||||
|
|
||||||
### <a name=squash></a> Squash an image's layers (--squash) (experimental)
|
### <a name=squash></a> Squash an image's layers (--squash) (experimental)
|
||||||
|
|
||||||
|
|
|
@ -77,7 +77,7 @@ line:
|
||||||
| `DOCKER_HIDE_LEGACY_COMMANDS` | When set, Docker hides "legacy" top-level commands (such as `docker rm`, and `docker pull`) in `docker help` output, and only `Management commands` per object-type (e.g., `docker container`) are printed. This may become the default in a future release, at which point this environment-variable is removed. |
|
| `DOCKER_HIDE_LEGACY_COMMANDS` | When set, Docker hides "legacy" top-level commands (such as `docker rm`, and `docker pull`) in `docker help` output, and only `Management commands` per object-type (e.g., `docker container`) are printed. This may become the default in a future release, at which point this environment-variable is removed. |
|
||||||
| `DOCKER_HOST` | Daemon socket to connect to. |
|
| `DOCKER_HOST` | Daemon socket to connect to. |
|
||||||
| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](dockerd.md) |
|
| `DOCKER_TLS_VERIFY` | When set Docker uses TLS and verifies the remote. This variable is used both by the `docker` CLI and the [`dockerd` daemon](dockerd.md) |
|
||||||
| `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`) when [building](build.md) with [BuildKit backend](../builder.md#buildkit). Use plain to show container output (default `auto`). |
|
| `BUILDKIT_PROGRESS` | Set type of progress output (`auto`, `plain`, `tty`) when [building](build.md) with [BuildKit backend](https://docs.docker.com/engine/reference/builder/#buildkit). Use plain to show container output (default `auto`). |
|
||||||
|
|
||||||
Because Docker is developed using Go, you can also use any environment
|
Because Docker is developed using Go, you can also use any environment
|
||||||
variables used by the Go runtime. In particular, you may find these useful:
|
variables used by the Go runtime. In particular, you may find these useful:
|
||||||
|
|
|
@ -14,7 +14,7 @@ keywords: "Engine"
|
||||||
|
|
||||||
# Engine reference
|
# Engine reference
|
||||||
|
|
||||||
* [Dockerfile reference](builder.md)
|
* [Dockerfile reference](https://docs.docker.com/engine/reference/builder/)
|
||||||
* [Docker run reference](run.md)
|
* [Docker run reference](run.md)
|
||||||
* [Command line reference](commandline/index.md)
|
* [Command line reference](commandline/index.md)
|
||||||
* [API Reference](https://docs.docker.com/engine/api/)
|
* [API Reference](https://docs.docker.com/engine/api/)
|
||||||
|
|
|
@ -1429,7 +1429,7 @@ logging drivers. For detailed information on working with logging drivers, see
|
||||||
|
|
||||||
## Overriding Dockerfile image defaults
|
## Overriding Dockerfile image defaults
|
||||||
|
|
||||||
When a developer builds an image from a [*Dockerfile*](builder.md)
|
When a developer builds an image from a [*Dockerfile*](https://docs.docker.com/engine/reference/builder/)
|
||||||
or when she commits it, the developer can set a number of default parameters
|
or when she commits it, the developer can set a number of default parameters
|
||||||
that take effect when the image starts up as a container.
|
that take effect when the image starts up as a container.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue