Skip to content

Commit

Permalink
docs(README): add a hint about multi-arch builds
Browse files Browse the repository at this point in the history
Document probably the most common usage of
`DOCKER_METADATA_ANNOTATIONS_LEVELS`: multi-arch builds.

Signed-off-by: favonia <[email protected]>
  • Loading branch information
favonia committed Nov 30, 2023
1 parent f19c369 commit 91224bc
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -954,9 +954,17 @@ The same can be done with the [`bake-action`](https://github.com/docker/bake-act
targets: build
```

If you want to set specific level(s) for your annotations, you can use the
Note that annotations can be attached at many different levels within a manifest.
By default, the generated annotations will be attached to image manifests,
but different registries may expect annotations at different places;
a common practice is to read annotations at _image indexes_ if present,
which are often used by multi-arch builds to index platform-specific images.
If you want to specify level(s) for your annotations, you can use the
[`DOCKER_METADATA_ANNOTATIONS_LEVELS` environment variable](#environment-variables)
with a comma separated list of levels (defaults to `manifest`):
with a comma separated list of all levels the annotations should be attached to (defaults to `manifest`).
The following configuration demonstrates the ability to attach annotations to both image manifests and image indexes,
though your registry may only need annotations at the index level. (That is, `index` alone may be enough.)
Please consult the documentation of your registry.

```yaml
-
Expand Down

0 comments on commit 91224bc

Please sign in to comment.