Bake 中的变量
您可以在 Bake 文件中定义和使用变量来设置属性值、将其插入到其他值中以及执行算术运算。变量可以定义默认值，也可以使用环境变量覆盖。
将变量用作属性值
使用 variable 块定义变量。
variable "TAG" {
default = "docker.io/username/webapp:latest"
}以下示例展示了如何在目标中使用 TAG 变量。
target "webapp" {
context = "."
dockerfile = "Dockerfile"
tags = [ TAG ]
}将变量插入到值中
Bake 支持将变量字符串插值到值中。您可以使用 ${} 语法将变量插入到值中。以下示例定义了一个 TAG 变量，其值为 latest。
variable "TAG" {
default = "latest"
}要将 TAG 变量插入到属性的值中，请使用 ${TAG} 语法。
group "default" {
targets = [ "webapp" ]
}
variable "TAG" {
default = "latest"
}
target "webapp" {
context = "."
dockerfile = "Dockerfile"
tags = ["docker.io/username/webapp:${TAG}"]
}使用 --print 标志打印 Bake 文件会显示已解析构建配置中的插值值。
$ docker buildx bake --print
{
"group": {
"default": {
"targets": ["webapp"]
}
},
"target": {
"webapp": {
"context": ".",
"dockerfile": "Dockerfile",
"tags": ["docker.io/username/webapp:latest"]
}
}
}验证变量
要验证变量的值是否符合预期类型、值范围或其他条件，您可以使用 validation 块定义自定义验证规则。
在以下示例中，验证用于对变量值强制执行数字约束；PORT 变量必须大于或等于 1024。
# Define a variable `PORT` with a default value and a validation rule
variable "PORT" {
default = 3000 # Default value assigned to `PORT`
# Validation block to ensure `PORT` is a valid number within the acceptable range
validation {
condition = PORT >= 1024 # Ensure `PORT` is at least 1024
error_message = "The variable 'PORT' must be 1024 or greater." # Error message for invalid values
}
}如果 condition 表达式计算结果为 false，则变量值被视为无效，从而导致构建调用失败并发出 error_message。例如，如果 PORT=443，则条件计算结果为 false，并引发错误。
在设置验证之前，值会被强制转换为预期类型。这可确保使用环境变量设置的任何覆盖都按预期工作。
验证多个条件
要评估多个条件，请为变量定义多个 validation 块。所有条件都必须为 true。
这是一个示例
# Define a variable `VAR` with multiple validation rules
variable "VAR" {
# First validation block: Ensure the variable is not empty
validation {
condition = VAR != ""
error_message = "The variable 'VAR' must not be empty."
}
# Second validation block: Ensure the value contains only alphanumeric characters
validation {
# VAR and the regex match must be identical:
condition = VAR == regex("[a-zA-Z0-9]+", VAR)
error_message = "The variable 'VAR' can only contain letters and numbers."
}
}此示例强制执行
- 变量不能为空。
- 变量必须匹配特定的字符集。
对于 VAR="hello@world" 等无效输入，验证将失败。
验证变量依赖项
您可以在条件表达式中引用其他 Bake 变量，从而启用强制执行变量之间依赖关系的验证。这可确保在继续之前正确设置依赖变量。
这是一个示例
# Define a variable `FOO`
variable "FOO" {}
# Define a variable `BAR` with a validation rule that references `FOO`
variable "BAR" {
# Validation block to ensure `FOO` is set if `BAR` is used
validation {
condition = FOO != "" # Check if `FOO` is not an empty string
error_message = "The variable 'BAR' requires 'FOO' to be set."
}
}此配置确保仅当 FOO 已分配非空值时才能使用 BAR 变量。尝试在不设置 FOO 的情况下进行构建将触发验证错误。
转义变量插值
如果您想在解析 Bake 定义时绕过变量插值，请使用双美元符号 ($${VARIABLE})。
target "webapp" {
dockerfile-inline = <<EOF
FROM alpine
ARG TARGETARCH
RUN echo "Building for $${TARGETARCH/amd64/x64}"
EOF
platforms = ["linux/amd64", "linux/arm64"]
}$ docker buildx bake --progress=plain
...
#8 [linux/arm64 2/2] RUN echo "Building for arm64"
#8 0.036 Building for arm64
#8 DONE 0.0s
#9 [linux/amd64 2/2] RUN echo "Building for x64"
#9 0.046 Building for x64
#9 DONE 0.1s
...
跨文件使用变量中的变量
当指定多个文件时，一个文件可以使用另一个文件中定义的变量。在以下示例中，vars.hcl 文件定义了一个 BASE_IMAGE 变量，其默认值为 docker.io/library/alpine。
variable "BASE_IMAGE" {
default = "docker.io/library/alpine"
}以下 docker-bake.hcl 文件定义了一个引用 BASE_IMAGE 变量的 BASE_LATEST 变量。
variable "BASE_LATEST" {
default = "${BASE_IMAGE}:latest"
}
target "webapp" {
contexts = {
base = BASE_LATEST
}
}当您使用 -f 标志指定 vars.hcl 和 docker-bake.hcl 文件并打印已解析的构建配置时，您会看到 BASE_LATEST 变量已解析为 docker.io/library/alpine:latest。
$ docker buildx bake -f vars.hcl -f docker-bake.hcl --print app
{
"target": {
"webapp": {
"context": ".",
"contexts": {
"base": "docker.io/library/alpine:latest"
},
"dockerfile": "Dockerfile"
}
}
}其他资源
以下是一些其他资源，展示了如何在 Bake 中使用变量