Skip to content

Commit 0df0faa

Browse files
crazy-maxcrazy-max
authored
Merge pull request #3614 from crazy-max/v0.11_deprecate-buildinfo
[0.11] buildinfo: mark as deprecated
2 parents 2590f95 + 837b4b2 commit 0df0faa

15 files changed

Lines changed: 251 additions & 178 deletions

File tree

‎.golangci.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,6 @@ issues:
6767
- linters:
6868
- revive
6969
text: "stutters"
70+
- linters:
71+
- staticcheck
72+
text: "SA1019: .*Build information is deprecated: https://github.com/moby/buildkit/blob/master/docs/deprecated.md"

‎README.md‎

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,8 @@ Keys supported by image output:
257257
* `compression=<uncompressed|gzip|estargz|zstd>`: choose compression type for layers newly created and cached, gzip is default value. estargz should be used with `oci-mediatypes=true`.
258258
* `compression-level=<value>`: compression level for gzip, estargz (0-9) and zstd (0-22)
259259
* `force-compression=true`: forcefully apply `compression` option to all layers (including already existing layers)
260-
* `buildinfo=true`: attach inline build info in [image config](docs/build-repro.md#image-config) (default `true`)
261-
* `buildinfo-attrs=true`: attach inline build info attributes in [image config](docs/build-repro.md#image-config) (default `false`)
260+
* `buildinfo=true`: attach inline build info in [image config](docs/buildinfo.md#image-config) (default `true`)
261+
* `buildinfo-attrs=true`: attach inline build info attributes in [image config](docs/buildinfo.md#image-config) (default `false`)
262262
* `store=true`: store the result images to the worker's (e.g. containerd) image store as well as ensures that the image has all blobs in the content store (default `true`). Ignored if the worker doesn't have image store (e.g. OCI worker).
263263
* `annotation.<key>=<value>`: attach an annotation with the respective `key` and `value` to the built image
264264
* Using the extended syntaxes, `annotation-<type>.<key>=<value>`, `annotation[<platform>].<key>=<value>` and both combined with `annotation-<type>[<platform>].<key>=<value>`, allows configuring exactly where to attach the annotation.
@@ -269,6 +269,12 @@ Keys supported by image output:
269269
If credentials are required, `buildctl` will attempt to read Docker configuration file `$DOCKER_CONFIG/config.json`.
270270
`$DOCKER_CONFIG` defaults to `~/.docker`.
271271

272+
> **Warning**
273+
>
274+
> Build information along `buildinfo` and `buildinfo-attrs` attributes are
275+
> deprecated and will be removed in the next release. See the [Deprecated features page](./docs/deprecated.md)
276+
> for status and alternative recommendation about this feature.
277+
272278
#### Local directory
273279

274280
The local client will copy the files directly to the client. This is useful if BuildKit is being used for building something else than container images.
@@ -575,26 +581,6 @@ jq '.' metadata.json
575581
```
576582
```json
577583
{
578-
"containerimage.buildinfo": {
579-
"frontend": "dockerfile.v0",
580-
"attrs": {
581-
"context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
582-
"filename": "Dockerfile",
583-
"source": "docker/dockerfile:master"
584-
},
585-
"sources": [
586-
{
587-
"type": "docker-image",
588-
"ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
589-
"pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
590-
},
591-
{
592-
"type": "docker-image",
593-
"ref": "docker.io/library/alpine:3.13",
594-
"pin": "sha256:026f721af4cf2843e07bba648e158fb35ecc876d822130633cc49f707f0fc88c"
595-
}
596-
]
597-
},
598584
"containerimage.config.digest": "sha256:2937f66a9722f7f4a2df583de2f8cb97fc9196059a410e7f00072fc918930e66",
599585
"containerimage.descriptor": {
600586
"annotations": {

‎control/control.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,15 @@ func (c *Controller) Solve(ctx context.Context, req *controlapi.SolveRequest) (*
337337
}
338338
}
339339

340+
if v, ok := req.FrontendAttrs["build-arg:BUILDKIT_BUILDINFO"]; ok && v != "" {
341+
if _, ok := req.ExporterAttrs["buildinfo"]; !ok {
342+
if req.ExporterAttrs == nil {
343+
req.ExporterAttrs = make(map[string]string)
344+
}
345+
req.ExporterAttrs["buildinfo"] = v
346+
}
347+
}
348+
340349
if req.Exporter != "" {
341350
exp, err := w.Exporter(req.Exporter, c.opt.SessionManager)
342351
if err != nil {

‎docs/build-repro.md‎

Lines changed: 1 addition & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,6 @@
11
# Build reproducibility
22

3-
## Build dependencies
4-
5-
Build dependencies are generated when your image has been built. These
6-
dependencies include versions of used images, git repositories and HTTP URLs
7-
used by LLB `Source` operation as well as build request attributes.
8-
9-
The structure is base64 encoded and has the following format when decoded:
10-
11-
```json
12-
{
13-
"frontend": "dockerfile.v0",
14-
"attrs": {
15-
"build-arg:foo": "bar",
16-
"context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
17-
"filename": "Dockerfile",
18-
"platform": "linux/amd64,linux/arm64",
19-
"source": "crazymax/dockerfile:master"
20-
},
21-
"sources": [
22-
{
23-
"type": "docker-image",
24-
"ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
25-
"pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
26-
},
27-
{
28-
"type": "docker-image",
29-
"ref": "docker.io/library/alpine:3.13",
30-
"pin": "sha256:1d30d1ba3cb90962067e9b29491fbd56997979d54376f23f01448b5c5cd8b462"
31-
},
32-
{
33-
"type": "git",
34-
"ref": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
35-
"pin": "259a5aa5aa5bb3562d12cc631fe399f4788642c1"
36-
},
37-
{
38-
"type": "http",
39-
"ref": "https://raw.githubusercontent.com/moby/moby/v20.10.21/README.md",
40-
"pin": "sha256:419455202b0ef97e480d7f8199b26a721a417818bc0e2d106975f74323f25e6c"
41-
}
42-
]
43-
}
44-
```
45-
46-
* `frontend` defines the frontend used to build.
47-
* `attrs` defines build request attributes.
48-
* `sources` defines build sources.
49-
* `type` defines the source type (`docker-image`, `git` or `http`).
50-
* `ref` is the reference of the source.
51-
* `pin` is the source digest.
52-
* `deps` defines build dependencies of input contexts.
53-
54-
### Image config
55-
56-
A new field similar to the one for inline cache has been added to the image
57-
configuration to embed build dependencies:
58-
59-
```json
60-
{
61-
"moby.buildkit.buildinfo.v0": "<base64>"
62-
}
63-
```
64-
65-
By default, the build dependencies are inlined in the image configuration. You
66-
can disable this behavior with the [`buildinfo` attribute](../README.md#imageregistry).
67-
68-
### Exporter response (metadata)
69-
70-
The solver response (`ExporterResponse`) also contains a new key
71-
`containerimage.buildinfo` with the same structure as image config encoded in
72-
base64:
73-
74-
```json
75-
{
76-
"ExporterResponse": {
77-
"containerimage.buildinfo": "<base64>",
78-
"containerimage.digest": "sha256:..."
79-
}
80-
}
81-
```
82-
83-
If multi-platforms are specified, they will be suffixed with the corresponding
84-
platform:
85-
86-
```json
87-
{
88-
"ExporterResponse": {
89-
"containerimage.buildinfo/linux/amd64": "<base64>",
90-
"containerimage.buildinfo/linux/arm64": "<base64>",
91-
"containerimage.digest": "sha256:..."
92-
}
93-
}
94-
```
95-
96-
### Metadata JSON output
97-
98-
If you're using the `--metadata-file` flag with [`buildctl`](../README.md#metadata),
99-
[`buildx build`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md)
100-
or [`buildx bake`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md):
101-
102-
```shell
103-
jq '.' metadata.json
104-
```
105-
```json
106-
{
107-
"containerimage.buildinfo": {
108-
"frontend": "dockerfile.v0",
109-
"attrs": {
110-
"context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
111-
"filename": "Dockerfile",
112-
"source": "docker/dockerfile:master"
113-
},
114-
"sources": [
115-
{
116-
"type": "docker-image",
117-
"ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
118-
"pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
119-
},
120-
{
121-
"type": "docker-image",
122-
"ref": "docker.io/library/alpine:3.13",
123-
"pin": "sha256:026f721af4cf2843e07bba648e158fb35ecc876d822130633cc49f707f0fc88c"
124-
}
125-
]
126-
},
127-
"containerimage.digest": "sha256:..."
128-
}
129-
```
130-
131-
### Reproducing the pinned dependencies
3+
## Reproducing the pinned dependencies
1324

1335
Reproducing the pinned dependencies is supported since BuildKit v0.11.
1346

‎docs/buildinfo.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Build information
2+
3+
> **Warning**
4+
>
5+
> Build information is deprecated and will be removed in the next release. See
6+
> the [Deprecated features page](https://github.com/moby/buildkit/blob/master/docs/deprecated.md)
7+
> for status and alternative recommendation about this feature.
8+
9+
Build information structures are generated with build metadata that allows you
10+
to see all the sources (images, git repositories) that were used by the build
11+
with their exact versions and also the configuration that was passed to the
12+
build. This information is also embedded into the image configuration if one
13+
is generated.
14+
15+
## Build dependencies
16+
17+
Build dependencies are generated when your image has been built. These
18+
dependencies include versions of used images, git repositories and HTTP URLs
19+
used by LLB `Source` operation as well as build request attributes.
20+
21+
The structure is base64 encoded and has the following format when decoded:
22+
23+
```json
24+
{
25+
"frontend": "dockerfile.v0",
26+
"attrs": {
27+
"build-arg:foo": "bar",
28+
"context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
29+
"filename": "Dockerfile",
30+
"platform": "linux/amd64,linux/arm64",
31+
"source": "crazymax/dockerfile:master"
32+
},
33+
"sources": [
34+
{
35+
"type": "docker-image",
36+
"ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
37+
"pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
38+
},
39+
{
40+
"type": "docker-image",
41+
"ref": "docker.io/library/alpine:3.13",
42+
"pin": "sha256:1d30d1ba3cb90962067e9b29491fbd56997979d54376f23f01448b5c5cd8b462"
43+
},
44+
{
45+
"type": "git",
46+
"ref": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
47+
"pin": "259a5aa5aa5bb3562d12cc631fe399f4788642c1"
48+
},
49+
{
50+
"type": "http",
51+
"ref": "https://raw.githubusercontent.com/moby/moby/v20.10.21/README.md",
52+
"pin": "sha256:419455202b0ef97e480d7f8199b26a721a417818bc0e2d106975f74323f25e6c"
53+
}
54+
]
55+
}
56+
```
57+
58+
* `frontend` defines the frontend used to build.
59+
* `attrs` defines build request attributes.
60+
* `sources` defines build sources.
61+
* `type` defines the source type (`docker-image`, `git` or `http`).
62+
* `ref` is the reference of the source.
63+
* `pin` is the source digest.
64+
* `deps` defines build dependencies of input contexts.
65+
66+
### Image config
67+
68+
A new field similar to the one for inline cache has been added to the image
69+
configuration to embed build dependencies:
70+
71+
```json
72+
{
73+
"moby.buildkit.buildinfo.v0": "<base64>"
74+
}
75+
```
76+
77+
By default, the build dependencies are inlined in the image configuration. You
78+
can disable this behavior with the [`buildinfo` attribute](../README.md#imageregistry).
79+
80+
### Exporter response (metadata)
81+
82+
The solver response (`ExporterResponse`) also contains a new key
83+
`containerimage.buildinfo` with the same structure as image config encoded in
84+
base64:
85+
86+
```json
87+
{
88+
"ExporterResponse": {
89+
"containerimage.buildinfo": "<base64>",
90+
"containerimage.digest": "sha256:..."
91+
}
92+
}
93+
```
94+
95+
If multi-platforms are specified, they will be suffixed with the corresponding
96+
platform:
97+
98+
```json
99+
{
100+
"ExporterResponse": {
101+
"containerimage.buildinfo/linux/amd64": "<base64>",
102+
"containerimage.buildinfo/linux/arm64": "<base64>",
103+
"containerimage.digest": "sha256:..."
104+
}
105+
}
106+
```
107+
108+
### Metadata JSON output
109+
110+
If you're using the `--metadata-file` flag with [`buildctl`](../README.md#metadata),
111+
[`buildx build`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md)
112+
or [`buildx bake`](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md):
113+
114+
```shell
115+
jq '.' metadata.json
116+
```
117+
```json
118+
{
119+
"containerimage.buildinfo": {
120+
"frontend": "dockerfile.v0",
121+
"attrs": {
122+
"context": "https://github.com/crazy-max/buildkit-buildsources-test.git#master",
123+
"filename": "Dockerfile",
124+
"source": "docker/dockerfile:master"
125+
},
126+
"sources": [
127+
{
128+
"type": "docker-image",
129+
"ref": "docker.io/docker/buildx-bin:0.6.1@sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0",
130+
"pin": "sha256:a652ced4a4141977c7daaed0a074dcd9844a78d7d2615465b12f433ae6dd29f0"
131+
},
132+
{
133+
"type": "docker-image",
134+
"ref": "docker.io/library/alpine:3.13",
135+
"pin": "sha256:026f721af4cf2843e07bba648e158fb35ecc876d822130633cc49f707f0fc88c"
136+
}
137+
]
138+
},
139+
"containerimage.digest": "sha256:..."
140+
}
141+
```

0 commit comments

Comments
 (0)