覆盖配置

目录

Bake 支持从文件加载构建定义，但有时您需要更大的灵活性来配置这些定义。例如，在特定环境中构建时，或者针对特定目标构建时，您可能想要覆盖某个属性。

以下属性列表可以被覆盖：

  • args
  • attest
  • cache-from
  • cache-to
  • context
  • contexts
  • dockerfile
  • entitlements
  • labels
  • network
  • no-cache
  • output
  • platform
  • pull
  • secrets
  • ssh
  • tags
  • target

要覆盖这些属性，您可以使用以下方法：

文件覆盖

您可以加载定义构建配置的多个 Bake 文件。这对于将配置分离到不同文件以便更好地组织，或者根据加载的文件有条件地覆盖配置非常有用。

默认文件查找

您可以使用 --file 或 -f 标志来指定要加载的文件。如果您未指定任何文件，Bake 将按照以下查找顺序查找：

  1. compose.yaml
  2. compose.yml
  3. docker-compose.yml
  4. docker-compose.yaml
  5. docker-bake.json
  6. docker-bake.hcl
  7. docker-bake.override.json
  8. docker-bake.override.hcl

如果找到多个 Bake 文件，所有文件将被加载并合并到一个定义中。文件按照查找顺序进行合并。

$ docker buildx bake --print
[+] Building 0.0s (1/1) FINISHED                                                                                                                                                                                            
 => [internal] load local bake definitions                                                                                                                                                                             0.0s
 => => reading compose.yaml 45B / 45B                                                                                                                                                                                  0.0s
 => => reading docker-bake.hcl 113B / 113B                                                                                                                                                                             0.0s
 => => reading docker-bake.override.hcl 65B / 65B

如果合并的文件包含重复的属性定义，这些定义将根据属性进行合并或被最后出现的定义覆盖。

Bake 将尝试按照找到的顺序加载所有文件。如果多个文件定义了同一个目标，属性将被合并或覆盖。在覆盖的情况下，最后加载的文件具有优先权。

例如，给定以下文件：

docker-bake.hcl
variable "TAG" {
  default = "foo"
}

target "default" {
  tags = ["username/my-app:${TAG}"]
}
docker-bake.override.hcl
variable "TAG" {
  default = "bar"
}

由于 docker-bake.override.hcl 在默认查找顺序中是最后加载的，因此 TAG 变量被值 bar 覆盖。

$ docker buildx bake --print
{
  "target": {
    "default": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "tags": ["username/my-app:bar"]
    }
  }
}

手动文件覆盖

您可以使用 --file 标志来显式指定要加载的文件，并以此作为有条件地应用覆盖文件的方式。

例如，您可以创建一个文件来定义针对特定环境的一组配置，并且仅在该环境进行构建时加载它。以下示例展示了如何加载一个 override.hcl 文件，该文件将 TAG 变量设置为 bar。然后，TAG 变量将在 default 目标中使用。

docker-bake.hcl
variable "TAG" {
  default = "foo"
}

target "default" {
  tags = ["username/my-app:${TAG}"]
}
overrides.hcl
variable "TAG" {
  default = "bar"
}

在不使用 --file 标志的情况下打印构建配置会显示 TAG 变量设置为默认值 foo。

$ docker buildx bake --print
{
  "target": {
    "default": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "tags": [
        "username/my-app:foo"
      ]
    }
  }
}

使用 --file 标志加载 overrides.hcl 文件会用值 bar 覆盖 TAG 变量。

$ docker buildx bake -f docker-bake.hcl -f overrides.hcl --print
{
  "target": {
    "default": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "tags": [
        "username/my-app:bar"
      ]
    }
  }
}

命令行

您还可以使用 --set 标志从命令行覆盖目标配置

# docker-bake.hcl
target "app" {
  args = {
    mybuildarg = "foo"
  }
}
$ docker buildx bake --set app.args.mybuildarg=bar --set app.platform=linux/arm64 app --print

{
  "group": {
    "default": {
      "targets": ["app"]
    }
  },
  "target": {
    "app": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "args": {
        "mybuildarg": "bar"
      },
      "platforms": ["linux/arm64"]
    }
  }
}

https://golang.ac.cn/pkg/path/#Match 中定义的模式匹配语法也受支持

$ docker buildx bake --set foo*.args.mybuildarg=value  # overrides build arg for all targets starting with "foo"
$ docker buildx bake --set *.platform=linux/arm64      # overrides platform for all targets
$ docker buildx bake --set foo*.no-cache               # bypass caching only for targets starting with "foo"

可以使用 --set 覆盖的属性完整列表如下：

  • args
  • attest
  • cache-from
  • cache-to
  • context
  • contexts
  • dockerfile
  • entitlements
  • labels
  • network
  • no-cache
  • output
  • platform
  • pull
  • secrets
  • ssh
  • tags
  • target

环境变量

您还可以使用环境变量来覆盖配置。

Bake 允许您使用环境变量覆盖 variable 块的值。只有 variable 块可以使用环境变量覆盖。这意味着您需要在 Bake 文件中定义变量，然后设置同名的环境变量来覆盖它。

以下示例展示了如何在 Bake 文件中定义一个带有默认值的 TAG 变量，并使用环境变量覆盖它。

variable "TAG" {
  default = "latest"
}

target "default" {
  context = "."
  dockerfile = "Dockerfile"
  tags = ["docker.io/username/webapp:${TAG}"]
}
$ export TAG=$(git rev-parse --short HEAD)
$ docker buildx bake --print webapp

TAG 变量被环境变量的值覆盖，该值是 git rev-parse --short HEAD 生成的简短提交哈希。

{
  "group": {
    "default": {
      "targets": ["webapp"]
    }
  },
  "target": {
    "webapp": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "tags": ["docker.io/username/webapp:985e9e9"]
    }
  }
}

类型强制转换

支持使用环境变量覆盖非字符串变量。作为环境变量传递的值首先被强制转换为适当的类型。

以下示例定义了一个 PORT 变量。backend 目标直接使用 PORT 变量，而 frontend 目标使用 PORT 的值加一后的结果。

variable "PORT" {
  default = 3000
}

group "default" {
  targets = ["backend", "frontend"]
}

target "backend" {
  args = {
    PORT = PORT
  }
}

target "frontend" {
  args = {
    PORT = add(PORT, 1)
  }
}

使用环境变量覆盖 PORT 时，在 frontend 目标中的表达式运行之前，该值将首先被强制转换为预期的类型（整数）。

$ PORT=7070 docker buildx bake --print

{
  "group": {
    "default": {
      "targets": [
        "backend",
        "frontend"
      ]
    }
  },
  "target": {
    "backend": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "args": {
        "PORT": "7070"
      }
    },
    "frontend": {
      "context": ".",
      "dockerfile": "Dockerfile",
      "args": {
        "PORT": "7071"
      }
    }
  }
}
页面选项