构建变量

目录

在 Docker Build 中，构建参数 (ARG) 和环境变量 (ENV) 都可以将信息传递到构建过程中。您可以使用它们来参数化构建，从而实现更灵活和可配置的构建。

警告

构建参数和环境变量不适合将密钥传递到您的构建中，因为它们会在最终镜像中公开。相反，请使用密钥挂载或 SSH 挂载，它们可以安全地将密钥公开给您的构建。

有关更多信息，请参阅 构建密钥。

异同

构建参数和环境变量非常相似。它们都在 Dockerfile 中声明，并且可以使用 `docker build` 命令的标志进行设置。两者都可以用来参数化构建。但是它们各自具有不同的用途。

构建参数

构建参数是 Dockerfile 本身的变量。使用它们来参数化 Dockerfile 指令的值。例如，您可以使用构建参数来指定要安装的依赖项的版本。

除非在指令中使用，否则构建参数对构建没有影响。除非从 Dockerfile 显式地传递到镜像文件系统或配置中，否则它们在从镜像实例化的容器中不可访问或不存在。它们可能会保留在镜像元数据中，作为来源证明和镜像历史记录，这就是为什么它们不适合保存密钥的原因。

它们使 Dockerfile 更灵活，更容易维护。

有关如何使用构建参数的示例，请参阅 ARG 使用示例。

环境变量

环境变量会传递到构建执行环境，并保留在从镜像实例化的容器中。

环境变量主要用于

  • 配置构建的执行环境
  • 为容器设置默认环境变量

如果设置了环境变量，则可以直接影响构建的执行以及应用程序的行为或配置。

您不能在构建时覆盖或设置环境变量。环境变量的值必须在 Dockerfile 中声明。您可以组合环境变量和构建参数，以允许在构建时配置环境变量。

有关如何使用环境变量配置构建的示例，请参阅 ENV 使用示例。

ARG 使用示例

构建参数通常用于指定构建中使用的组件版本，例如镜像变体或包版本。

将版本指定为构建参数允许使用不同版本进行构建，而无需手动更新 Dockerfile。它还可以简化 Dockerfile 的维护，因为它允许您在文件顶部声明版本。

构建参数也可以作为在多个位置重用值的一种方式。例如，如果您在构建中使用了多种 alpine 版本，您可以确保在任何地方都使用相同版本的 alpine

  • golang:1.22-alpine${ALPINE_VERSION}
  • python:3.12-alpine${ALPINE_VERSION}
  • nginx:1-alpine${ALPINE_VERSION}

以下示例使用构建参数定义了 `node` 和 `alpine` 的版本。

# syntax=docker/dockerfile:1

ARG NODE_VERSION="20"
ARG ALPINE_VERSION="3.20"

FROM node:${NODE_VERSION}-alpine${ALPINE_VERSION} AS base
WORKDIR /src

FROM base AS build
COPY package*.json ./
RUN npm ci
RUN npm run build

FROM base AS production
COPY package*.json ./
RUN npm ci --omit=dev && npm cache clean --force
COPY --from=build /src/dist/ .
CMD ["node", "app.js"]

在本例中，构建参数具有默认值。在调用构建时指定其值是可选的。要覆盖默认值，可以使用--build-arg CLI标志

$ docker build --build-arg NODE_VERSION=current .

有关如何使用构建参数的更多信息，请参阅

ENV 使用示例

使用ENV声明环境变量会使该变量可用于构建阶段中的所有后续指令。以下示例显示了一个在使用npm安装 JavaScript 依赖项之前将NODE_ENV设置为production的示例。设置此变量可使npm忽略仅在本地开发中所需的包。

# syntax=docker/dockerfile:1

FROM node:20
WORKDIR /app
COPY package*.json ./
ENV NODE_ENV=production
RUN npm ci && npm cache clean --force
COPY . .
CMD ["node", "app.js"]

默认情况下，环境变量在构建时不可配置。如果要在构建时更改ENV的值，可以组合环境变量和构建参数。

# syntax=docker/dockerfile:1

FROM node:20
ARG NODE_ENV=production
ENV NODE_ENV=$NODE_ENV
WORKDIR /app
COPY package*.json ./
RUN npm ci && npm cache clean --force
COPY . .
CMD ["node", "app.js"]

使用此 Dockerfile，您可以使用--build-arg覆盖ENV的默认值。

$ docker build --build-arg NODE_ENV=development .

请注意，由于您设置的环境变量会保留在容器中，因此使用它们可能会导致应用程序运行时的意外副作用。

有关如何在构建中使用环境变量的更多信息，请参阅

范围

在 Dockerfile 的全局范围内声明的构建参数不会自动继承到构建阶段。它们仅在全局范围内可用。

# syntax=docker/dockerfile:1

# The following build argument is declared in the global scope:
ARG NAME="joe"

FROM alpine
# The following instruction doesn't have access to the $NAME build argument
# because the argument was defined in the global scope, not for this stage.
RUN echo "hello ${NAME}!"

此示例中的echo命令计算结果为hello !，因为NAME构建参数的值超出范围。要将全局构建参数继承到阶段中，必须使用它们。

# syntax=docker/dockerfile:1

# Declare the build argument in the global scope
ARG NAME="joe"

FROM alpine
# Consume the build argument in the build stage
ARG NAME
RUN echo $NAME

一旦在某个阶段声明或使用了构建参数，它就会自动被子阶段继承。

# syntax=docker/dockerfile:1
FROM alpine AS base
# Declare the build argument in the build stage
ARG NAME="joe"

# Create a new stage based on "base"
FROM base AS build
# The NAME build argument is available here
# since it's declared in a parent stage
RUN echo "hello $NAME!"

下图进一步说明了构建参数和环境变量继承如何在多阶段构建中工作。

预定义构建参数

本节描述默认情况下所有构建都可用的预定义构建参数。

多平台构建参数

多平台构建参数描述构建的构建和目标平台。

构建平台是运行构建器（BuildKit 守护程序）的主机系统的操作系统、体系结构和平台变体。

  • BUILDPLATFORM
  • BUILDOS
  • BUILDARCH
  • BUILDVARIANT

目标平台参数对构建的目标平台保持相同的值，使用docker build命令的--platform标志指定。

  • TARGETPLATFORM
  • TARGETOS
  • TARGETARCH
  • TARGETVARIANT

这些参数对于在多平台构建中进行交叉编译很有用。它们在 Dockerfile 的全局范围内可用，但不会自动被构建阶段继承。要在阶段内使用它们，必须声明它们。

# syntax=docker/dockerfile:1

# Pre-defined build arguments are available in the global scope
FROM --platform=$BUILDPLATFORM golang
# To inherit them to a stage, declare them with ARG
ARG TARGETOS
RUN GOOS=$TARGETOS go build -o ./exe .

有关多平台构建参数的更多信息，请参阅 多平台参数

代理参数

代理构建参数允许您指定要用于构建的代理。您不需要在 Dockerfile 中声明或引用这些参数。使用--build-arg指定代理足以使您的构建使用该代理。

默认情况下，代理参数会自动从构建缓存和docker history的输出中排除。如果您在 Dockerfile 中引用这些参数，则代理配置最终会进入构建缓存。

构建器会遵守以下代理构建参数。变量不区分大小写。

  • HTTP_PROXY
  • HTTPS_PROXY
  • FTP_PROXY
  • NO_PROXY
  • ALL_PROXY

配置构建的代理

$ docker build --build-arg HTTP_PROXY=https://my-proxy.example.com .

有关代理构建参数的更多信息，请参阅 代理参数。

构建工具配置变量

以下环境变量启用、禁用或更改 Buildx 和 BuildKit 的行为。请注意，这些变量不用于配置构建容器；它们在构建内部不可用，并且与ENV指令无关。它们用于配置 Buildx 客户端或 BuildKit 守护程序。

变量类型描述
BUILDKIT_COLORS字符串配置终端输出的文本颜色。
BUILDKIT_HOST字符串指定要用于远程构建器的主机。
BUILDKIT_PROGRESS字符串配置进度输出的类型。
BUILDKIT_TTY_LOG_LINES字符串日志行数（对于 TTY 模式下的活动步骤）。
BUILDX_BAKE_GIT_AUTH_HEADER字符串远程 Bake 文件的 HTTP 身份验证方案。
BUILDX_BAKE_GIT_AUTH_TOKEN字符串远程 Bake 文件的 HTTP 身份验证令牌。
BUILDX_BAKE_GIT_SSH字符串远程 Bake 文件的 SSH 身份验证。
BUILDX_BUILDER字符串指定要使用的构建器实例。
BUILDX_CONFIG字符串指定配置、状态和日志的位置。
BUILDX_CPU_PROFILE字符串在指定位置生成pprof CPU 配置文件。
BUILDX_EXPERIMENTAL布尔值启用实验性功能。
BUILDX_GIT_CHECK_DIRTY布尔值启用脏 Git 检出检测。
BUILDX_GIT_INFO布尔值删除来源证明中的 Git 信息。
BUILDX_GIT_LABELS字符串 | 布尔值向镜像添加 Git 来源标签。
BUILDX_MEM_PROFILE字符串在指定位置生成pprof内存配置文件。
BUILDX_NO_DEFAULT_ATTESTATIONS布尔值关闭默认来源证明。
BUILDX_NO_DEFAULT_LOAD布尔值默认情况下关闭将镜像加载到镜像存储。
EXPERIMENTAL_BUILDKIT_SOURCE_POLICY字符串指定 BuildKit 源策略文件。

BuildKit 还支持一些其他配置参数。请参阅 BuildKit 内置构建参数。

您可以通过不同的方式表达环境变量的布尔值。例如，true、1和T都计算为 true。评估使用 Go 标准库中的strconv.ParseBool函数进行。详情请见 参考文档。

BUILDKIT_COLORS

更改终端输出的颜色。将BUILDKIT_COLORS设置为以下格式的 CSV 字符串：

$ export BUILDKIT_COLORS="run=123,20,245:error=yellow:cancel=blue:warning=white"

颜色值可以是任何有效的 RGB 十六进制代码，或 BuildKit 预定义颜色之一。

将NO_COLOR设置为任何值都会关闭彩色输出，正如 no-color.org 建议的那样。

BUILDKIT_HOST

您可以使用BUILDKIT_HOST指定要用作远程构建器的 BuildKit 守护程序的地址。这与将地址指定为docker buildx create的位置参数相同。

用法

$ export BUILDKIT_HOST=tcp://localhost:1234
$ docker buildx create --name=remote --driver=remote

如果同时指定BUILDKIT_HOST环境变量和位置参数，则参数优先。

BUILDKIT_PROGRESS

设置 BuildKit 进度输出的类型。有效值为：

  • auto（默认）
  • plain
  • tty
  • rawjson

用法

$ export BUILDKIT_PROGRESS=plain

BUILDKIT_TTY_LOG_LINES

您可以通过将BUILDKIT_TTY_LOG_LINES设置为数字来更改在 TTY 模式下可见的活动步骤的日志行数（默认为6）。

$ export BUILDKIT_TTY_LOG_LINES=8

EXPERIMENTAL_BUILDKIT_SOURCE_POLICY

允许您指定用于创建具有固定依赖项的可重复构建的 BuildKit 源策略文件。

$ export EXPERIMENTAL_BUILDKIT_SOURCE_POLICY=./policy.json

示例

{
  "rules": [
    {
      "action": "CONVERT",
      "selector": {
        "identifier": "docker-image://docker.io/library/alpine:latest"
      },
      "updates": {
        "identifier": "docker-image://docker.io/library/alpine:latest@sha256:4edbd2beb5f78b1014028f4fbb99f3237d9561100b6881aabbf5acce2c4f9454"
      }
    },
    {
      "action": "CONVERT",
      "selector": {
        "identifier": "https://raw.githubusercontent.com/moby/buildkit/v0.10.1/README.md"
      },
      "updates": {
        "attrs": {"http.checksum": "sha256:6e4b94fc270e708e1068be28bd3551dc6917a4fc5a61293d51bb36e6b75c4b53"}
      }
    },
    {
      "action": "DENY",
      "selector": {
        "identifier": "docker-image://docker.io/library/golang*"
      }
    }
  ]
}

BUILDX_BAKE_GIT_AUTH_HEADER

在 Buildx 版本 0.14.0 中引入

在私有 Git 存储库中使用远程 Bake 定义时，设置 HTTP 身份验证方案。这等效于 GIT_AUTH_HEADER 密钥，但在加载远程 Bake 文件时，它有助于 Bake 中的预检身份验证。支持的值为bearer（默认）和basic。

用法

$ export BUILDX_BAKE_GIT_AUTH_HEADER=basic

BUILDX_BAKE_GIT_AUTH_TOKEN

在 Buildx 版本 0.14.0 中引入

在私有 Git 存储库中使用远程 Bake 定义时，设置 HTTP 身份验证令牌。这等效于 GIT_AUTH_TOKEN 密钥，但在加载远程 Bake 文件时，它有助于 Bake 中的预检身份验证。

用法

$ export BUILDX_BAKE_GIT_AUTH_TOKEN=$(cat git-token.txt)

BUILDX_BAKE_GIT_SSH

在 Buildx 版本 0.14.0 中引入

允许您指定要转发到 Bake 的 SSH 代理套接字文件路径列表，以便在私有存储库中使用远程 Bake 定义时对 Git 服务器进行身份验证。这类似于构建的 SSH 挂载，但在解析构建定义时，它有助于 Bake 中的预检身份验证。

通常不需要设置此环境，因为 Bake 默认会使用SSH_AUTH_SOCK代理套接字。只有当您想要使用具有不同文件路径的套接字时，才需要指定此变量。此变量可以使用逗号分隔的字符串来获取多个路径。

用法

$ export BUILDX_BAKE_GIT_SSH=/run/foo/listener.sock,~/.creds/ssh.sock

BUILDX_BUILDER

覆盖已配置的构建器实例。与docker buildx --builder CLI 标志相同。

用法

$ export BUILDX_BUILDER=my-builder

BUILDX_CONFIG

您可以使用BUILDX_CONFIG指定要用于构建配置、状态和日志的目录。此目录的查找顺序如下：

  • $BUILDX_CONFIG
  • $DOCKER_CONFIG/buildx
  • ~/.docker/buildx（默认）

用法

$ export BUILDX_CONFIG=/usr/local/etc

BUILDX_CPU_PROFILE

在 Buildx 版本 0.18.0 中引入

如果指定，Buildx 会在指定位置生成pprof CPU 配置文件。

注意

此属性仅在开发 Buildx 时才有用。配置文件数据与分析构建的性能无关。

用法

$ export BUILDX_CPU_PROFILE=buildx_cpu.prof

BUILDX_EXPERIMENTAL

启用实验性构建功能。

用法

$ export BUILDX_EXPERIMENTAL=1

BUILDX_GIT_CHECK_DIRTY

在 Buildx 版本 0.10.4 中引入

设置为 true 时，会检查 来源证明中源代码控制信息的脏状态。

用法

$ export BUILDX_GIT_CHECK_DIRTY=1

BUILDX_GIT_INFO

Buildx 版本 0.10.0 中引入

设置为 false 时，会从来源证明中移除源代码控制信息。

用法

$ export BUILDX_GIT_INFO=0

BUILDX_GIT_LABELS

Buildx 版本 0.10.0 中引入

根据 Git 信息，为构建的镜像添加来源证明标签。这些标签包括：

  • com.docker.image.source.entrypoint：Dockerfile 相对于项目根目录的位置
  • org.opencontainers.image.revision：Git 提交版本
  • org.opencontainers.image.source：仓库的 SSH 或 HTTPS 地址

示例

  "Labels": {
    "com.docker.image.source.entrypoint": "Dockerfile",
    "org.opencontainers.image.revision": "5734329c6af43c2ae295010778cd308866b95d9b",
    "org.opencontainers.image.source": "git@github.com:foo/bar.git"
  }

用法

  • 设置 BUILDX_GIT_LABELS=1 以包含 entrypoint 和 revision 标签。
  • 设置 BUILDX_GIT_LABELS=full 以包含所有标签。

如果仓库处于脏状态，则 revision 会添加 -dirty 后缀。

BUILDX_MEM_PROFILE

在 Buildx 版本 0.18.0 中引入

如果指定，Buildx 会在指定位置生成 pprof 内存配置文件。

注意

此属性仅在开发 Buildx 时才有用。配置文件数据与分析构建的性能无关。

用法

$ export BUILDX_MEM_PROFILE=buildx_mem.prof

BUILDX_NO_DEFAULT_ATTESTATIONS

在 Buildx 版本 0.10.4 中引入

默认情况下，BuildKit v0.11 及更高版本会为构建的镜像添加来源证明。设置 BUILDX_NO_DEFAULT_ATTESTATIONS=1 可禁用默认的来源证明。

用法

$ export BUILDX_NO_DEFAULT_ATTESTATIONS=1

BUILDX_NO_DEFAULT_LOAD

使用 docker 驱动程序构建镜像时，构建完成后会自动将镜像加载到镜像存储区。设置 BUILDX_NO_DEFAULT_LOAD 可禁用将镜像自动加载到本地容器存储区。

用法

$ export BUILDX_NO_DEFAULT_LOAD=1