Bake 中的变量

目录

您可以在 Bake 文件中定义和使用变量来设置属性值，将它们插入其他值中，并执行算术运算。变量可以定义默认值，并且可以使用环境变量覆盖。

使用变量作为属性值

使用variable块定义变量。

variable "TAG" {
  default = "docker.io/username/webapp:latest"
}

以下示例演示如何在目标中使用TAG变量。

target "default" {
  context = "."
  dockerfile = "Dockerfile"
  tags = [ TAG ]
}

将变量插入值中

Bake 支持将变量的字符串插值到值中。您可以使用${}语法将变量插入值中。以下示例定义了一个值为latest的TAG变量。

variable "TAG" {
  default = "latest"
}

要将TAG变量插入属性的值中，请使用${TAG}语法。

target "default" {
  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 higher."  # 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 "default" {
  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文件定义了一个值为docker.io/library/alpine的BASE_IMAGE变量。

vars.hcl
variable "BASE_IMAGE" {
  default = "docker.io/library/alpine"
}

以下docker-bake.hcl文件定义了一个引用BASE_IMAGE变量的BASE_LATEST变量。

docker-bake.hcl
variable "BASE_LATEST" {
  default = "${BASE_IMAGE}:latest"
}

target "default" {
  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": {
    "default": {
      "context": ".",
      "contexts": {
        "base": "docker.io/library/alpine:latest"
      },
      "dockerfile": "Dockerfile"
    }
  }
}

其他资源

以下是一些其他资源，展示了如何在 Bake 中使用变量

  • 您可以使用环境变量覆盖variable值。有关更多信息，请参见覆盖配置
  • 您可以在函数中引用和使用全局变量。请参见HCL 函数
  • 在评估表达式时，您可以使用变量值。请参阅表达式评估