mirror of https://github.com/docker/docs.git
build(bake): add matrices description
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
parent
e70449124f
commit
db9a563bfc
|
@ -0,0 +1,120 @@
|
|||
---
|
||||
title: Matrix targets
|
||||
description: Learn how to define and use matrix targets in Bake to fork a single target into multiple different variants
|
||||
keywords: build, buildx, bake, buildkit, matrix, hcl, json
|
||||
---
|
||||
|
||||
A matrix strategy lets you fork a single target into multiple different
|
||||
variants, based on parameters that you specify. This works in a similar way to
|
||||
[Matrix strategies for GitHub Actions](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs).
|
||||
You can use this to reduce duplication in your Bake definition.
|
||||
|
||||
The matrix attribute is a map of parameter names to lists of values. Bake
|
||||
builds each possible combination of values as a separate target.
|
||||
|
||||
Each generated target must have a unique name. To specify how target names
|
||||
should resolve, use the name attribute.
|
||||
|
||||
The following example resolves the app target to `app-foo` and `app-bar`. It
|
||||
also uses the matrix value to define the [target build stage](/build/bake/reference/#targettarget).
|
||||
|
||||
```hcl
|
||||
target "app" {
|
||||
name = "app-${tgt}"
|
||||
matrix = {
|
||||
tgt = ["foo", "bar"]
|
||||
}
|
||||
target = tgt
|
||||
}
|
||||
```
|
||||
|
||||
```console
|
||||
$ docker buildx bake --print app
|
||||
[+] Building 0.0s (0/0)
|
||||
{
|
||||
"group": {
|
||||
"app": {
|
||||
"targets": [
|
||||
"app-foo",
|
||||
"app-bar"
|
||||
]
|
||||
},
|
||||
"default": {
|
||||
"targets": [
|
||||
"app"
|
||||
]
|
||||
}
|
||||
},
|
||||
"target": {
|
||||
"app-bar": {
|
||||
"context": ".",
|
||||
"dockerfile": "Dockerfile",
|
||||
"target": "bar"
|
||||
},
|
||||
"app-foo": {
|
||||
"context": ".",
|
||||
"dockerfile": "Dockerfile",
|
||||
"target": "foo"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Multiple axes
|
||||
|
||||
You can specify multiple keys in your matrix to fork a target on multiple axes.
|
||||
When using multiple matrix keys, Bake builds every possible variant.
|
||||
|
||||
The following example builds four targets:
|
||||
|
||||
- `app-foo-1-0`
|
||||
- `app-foo-2-0`
|
||||
- `app-bar-1-0`
|
||||
- `app-bar-2-0`
|
||||
|
||||
```hcl
|
||||
target "app" {
|
||||
name = "app-${tgt}-${replace(version, ".", "-")}"
|
||||
matrix = {
|
||||
tgt = ["foo", "bar"]
|
||||
version = ["1.0", "2.0"]
|
||||
}
|
||||
target = tgt
|
||||
args = {
|
||||
VERSION = version
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Multiple values per matrix target
|
||||
|
||||
If you want to differentiate the matrix on more than just a single value, you
|
||||
can use maps as matrix values. Bake creates a target for each map, and you can
|
||||
access the nested values using dot notation.
|
||||
|
||||
The following example builds two targets:
|
||||
|
||||
- `app-foo-1-0`
|
||||
- `app-bar-2-0`
|
||||
|
||||
```hcl
|
||||
target "app" {
|
||||
name = "app-${item.tgt}-${replace(item.version, ".", "-")}"
|
||||
matrix = {
|
||||
item = [
|
||||
{
|
||||
tgt = "foo"
|
||||
version = "1.0"
|
||||
},
|
||||
{
|
||||
tgt = "bar"
|
||||
version = "2.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
target = item.tgt
|
||||
args = {
|
||||
VERSION = item.version
|
||||
}
|
||||
}
|
||||
```
|
|
@ -1963,6 +1963,8 @@ Manuals:
|
|||
title: Expressions
|
||||
- path: /build/bake/funcs/
|
||||
title: Functions
|
||||
- path: /build/bake/matrices/
|
||||
title: Matrices
|
||||
- path: /build/bake/overrides/
|
||||
title: Overriding configuration
|
||||
- path: /build/bake/reference/
|
||||
|
|
Loading…
Reference in New Issue